Interface: DigitScrollerProps
Defined in: src/sdk/components/common/DigitScroller.tsx:13
Component props for DigitScroller.
Extends
Properties
base
base:
number
Defined in: src/sdk/components/common/DigitScroller.tsx:18
The number base used by the scroller. Must be an integer greater than or equal to 3
.
children?
optional
children:DisplayChildren
[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
class?
optional
class:string
|SubscribableSet
<string
>
Defined in: src/sdk/components/common/DigitScroller.tsx:42
CSS class(es) to apply to the root of the digit scroller.
factor
factor:
number
Defined in: src/sdk/components/common/DigitScroller.tsx:24
The factor represented by the scroller's digit. The factor relates the digit to its nominal value as
value = digit * factor
. Cannot be 0
.
nanString?
optional
nanString:string
Defined in: src/sdk/components/common/DigitScroller.tsx:39
The string to render when the scroller's value is NaN
. Defaults to –
.
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
renderDigit()?
optional
renderDigit: (digit
) =>string
Defined in: src/sdk/components/common/DigitScroller.tsx:36
A function which renders each digit of the scroller to a text string. If not defined, each digit will be rendered
using the Number.toString()
method.
Parameters
Parameter | Type |
---|---|
digit | number |
Returns
string
scrollThreshold?
optional
scrollThreshold:number
Defined in: src/sdk/components/common/DigitScroller.tsx:30
The amount the scroller's value must deviate from the current displayed digit's nominal value before the digit
begins to scroll. Defaults to 0
.
value
value:
Subscribable
<number
>
Defined in: src/sdk/components/common/DigitScroller.tsx:15
The value to which the scroller is bound.