Interface: DigitScrollerProps
Component props for DigitScroller.
Hierarchy
↳
DigitScrollerProps
Properties
base
• base: number
The number base used by the scroller. Must be an integer greater than or equal to 3.
Defined in
src/sdk/components/common/DigitScroller.tsx:18
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | SubscribableSet<string>
CSS class(es) to apply to the root of the digit scroller.
Defined in
src/sdk/components/common/DigitScroller.tsx:42
factor
• factor: number
The factor represented by the scroller's digit. The factor relates the digit to its nominal value as
value = digit * factor. Cannot be 0.
Defined in
src/sdk/components/common/DigitScroller.tsx:24
nanString
• Optional nanString: string
The string to render when the scroller's value is NaN. Defaults to –.
Defined in
src/sdk/components/common/DigitScroller.tsx:39
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
renderDigit
• Optional renderDigit: (digit: number) => string
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.
Type declaration
▸ (digit): string
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
| Name | Type |
|---|---|
digit | number |
Returns
string
Defined in
src/sdk/components/common/DigitScroller.tsx:36
scrollThreshold
• Optional scrollThreshold: number
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.
Defined in
src/sdk/components/common/DigitScroller.tsx:30
value
• value: Subscribable<number>
The value to which the scroller is bound.
Defined in
src/sdk/components/common/DigitScroller.tsx:15