Class JSR

This is documentation for using JSR API.

For installation, usage, and more information see: https://github.com/soanvig/mm-jsr

Index

Constructors

Methods

destroy disable enable getRatioValue getRealValue isEnabled onValueChange setRatioValue setRealValue

Constructors

constructor

new JSR(ctor: JsrConstructor): JSR
Parameters
- ctor: JsrConstructor
Returns JSR
- Defined in JSR.ts:19

Methods

destroy

destroy(): void
Destroy JSR instance, removing all HTML elements (besides container) and event listeners.

Returns void
NOTE
this function does not remove the instance of JSR itself, therefore it does not remove handler already added to JSR, but one can simple forget about this instance, and let garbage-collector to collect it.

It does not removes original container element.
- Defined in JSR.ts:114

disable

disable(): void
Disable JSR by disallowing value changes, and adding .is-disabled class to the container.

Returns void
- Defined in JSR.ts:94

enable

enable(): void
Enable JSR by allowing value changes, and removing .is-disabled class from the container.

Returns void
- Defined in JSR.ts:87

getRatioValue

getRatioValue(index: number): number
Get index value (ratio).
Parameters
- index: number
  index of value to get
Returns number
- ratio value
- Defined in JSR.ts:70

getRealValue

getRealValue(index: number): number
Get index value (real).
Parameters
- index: number
  index of value to get
Returns number
- real value
- Defined in JSR.ts:60

isEnabled

isEnabled(): boolean
Return whether JSR is enabled or disabled.

Returns boolean
- Defined in JSR.ts:101

onValueChange

onValueChange(handler: ValueChangeHandler): VoidFunction
Add handler listening of any value change.
Parameters
- handler: ValueChangeHandler
  handler listening for value change
Returns VoidFunction
- returns function that allows to remove handler
- Defined in JSR.ts:80

setRatioValue

setRatioValue(index: number, value: number): void
Set index value (ratio).
Parameters
- index: number
  index of value to set
- value: number
  ratio value to set
Returns void
- Defined in JSR.ts:50

setRealValue

setRealValue(index: number, value: number): void
Set index value (real).
Parameters
- index: number
  index of value to set
- value: number
  real value to set
Returns void
- Defined in JSR.ts:40