JogDialOptions
import type { JogDialOptions } from 'pixi-silk/ui/dial';Options of JogDial.
Properties#
| Property | Type | Description | Defined in |
|---|---|---|---|
fine? | number | How fast precision grows with distance. Past the ring the speed is (radius / distance) ** fine, so the pointer far out moves the value slowly. 0 turns it off. Default 1. | ui/dial.ts:73 |
format? | (value: number) => string | Formats the readout. Default: the value with the step’s decimals. | ui/dial.ts:83 |
friction? | number | How quickly a flick slows down, about 1 / seconds. Default 3.5. | ui/dial.ts:79 |
inertia? | boolean | Keep spinning after a flick. Default true. | ui/dial.ts:77 |
max? | number | Upper limit. Default Infinity (no limit). | ui/dial.ts:64 |
min? | number | Lower limit. Default -Infinity (no limit). | ui/dial.ts:62 |
onChange? | (value: number) => void | Called on every change of the snapped value, also while dragging. | ui/dial.ts:93 |
onCommit? | (value: number) => void | The value once the dial comes to rest after a drag or a flick. | ui/dial.ts:95 |
profiles? | Partial<Record<InputKind, Partial<InputProfile>>> | Per pointer kind overrides of slop, the movement a tap may have. | ui/dial.ts:89 |
radius? | number | Radius of the ring, at its centre line. Default 64. | ui/dial.ts:56 |
readout? | boolean | Shows the value in the middle. Default true. | ui/dial.ts:81 |
rubber? | number | How far the value can stretch past a limit, as a fraction of one turn. Default 0.12. | ui/dial.ts:75 |
step? | number | Snap step. 0 turns snapping off. Default 0. | ui/dial.ts:66 |
textStyle? | TextStyleOptions | Style of the readout text. | ui/dial.ts:85 |
theme? | Partial<DialTheme> | Colours that replace parts of DIAL_THEME. | ui/dial.ts:87 |
thickness? | number | Thickness of the ring. Default 14. | ui/dial.ts:58 |
ticker? | Ticker | null | Ticker driving the animation. Default Ticker.shared. null for manual JogDial.tick. | ui/dial.ts:91 |
turn? | number | Value change for one full turn near the ring. Default: the range between min and max, else 1. | ui/dial.ts:68 |
value? | number | Start value, clamped and snapped. Default 0. | ui/dial.ts:60 |