ScrubberOptions
import type { ScrubberOptions } from 'pixi-silk/ui/dial';Options of Scrubber.
Properties#
| Property | Type | Description | Defined in |
|---|---|---|---|
fineFactor? | number | Speed with Shift held. Default 0.1. | ui/dial.ts:481 |
format? | (value: number) => string | Formats the value. Default: the value with the step’s decimals. | ui/dial.ts:485 |
height? | number | Field height. Default 30. | ui/dial.ts:469 |
label? | string | Name shown on the left. | ui/dial.ts:483 |
max? | number | Upper limit. Default Infinity. | ui/dial.ts:475 |
min? | number | Lower limit. Default -Infinity. With both limits finite, the field fills like a slider. | ui/dial.ts:473 |
onChange? | (value: number) => void | Called on every value change, also while dragging. | ui/dial.ts:497 |
onCommit? | (value: number) => void | Called with the value when a drag ends or a tap steps it. | ui/dial.ts:499 |
perPixel? | number | Value change per pixel of drag. Default step / 4. | ui/dial.ts:479 |
profiles? | Partial<Record<InputKind, Partial<InputProfile>>> | Per pointer kind overrides of slop, the movement a tap may have. | ui/dial.ts:493 |
readout? | boolean | Shows text (label, value, pill). Default true. | ui/dial.ts:487 |
step? | number | Tap step, and the snap step with Ctrl / Cmd. Default 1. | ui/dial.ts:477 |
textStyle? | TextStyleOptions | Style of the label and value text. | ui/dial.ts:489 |
theme? | Partial<DialTheme> | Colours that replace parts of DIAL_THEME. | ui/dial.ts:491 |
ticker? | Ticker | null | Ticker driving the animation. Default Ticker.shared. null for manual Scrubber.tick. | ui/dial.ts:495 |
value? | number | Start value, clamped to the limits. Default 0. | ui/dial.ts:471 |
width? | number | Field width. Default 150. | ui/dial.ts:467 |