NumberField

import { NumberField } from 'pixi-silk/ui/inspector';

A number you drag or type. Drag sideways to scrub: Shift is ten times faster, Alt ten times finer. Click without dragging to type a value. Mixed values scrub together, each from its own start.

Extends#

Field

Constructors#

Constructor#

new NumberField(ctx: FieldContext, options: NumberFieldOptions): NumberField;

Parameters#

Parameter	Type
`ctx`	`FieldContext`
`options`	`NumberFieldOptions`

Returns#

NumberField

Overrides#

Field.constructor

Accessors#

fieldWidth#

Get Signature#

get fieldWidth(): number;

Width of the field box. Default 120 until Field.resize.

Returns

number

Inherited from#

Field.fieldWidth

mixed#

Get Signature#

get mixed(): boolean;

True while the values differ.

Returns

boolean

values#

Get Signature#

get values(): readonly number[];

The values shown, one per edited object.

Returns

readonly number[]

Methods#

beginScrub()#

beginScrub(): void;

Starts a scrub, as a press does.

Returns#

void

commitText()#

commitText(text: string): boolean;

Sets every value from typed text, as one undo step. A trailing unit and a decimal comma are accepted. Returns false and changes nothing for text that is not a number.

Parameters#

Parameter	Type
`text`	`string`

Returns#

boolean

destroy()#

destroy(options?: DestroyOptions): void;

Stops the animation. Destroys children unless options says otherwise.

Parameters#

Parameter	Type
`options?`	`DestroyOptions`

Returns#

void

Inherited from#

Field.destroy

endScrub()#

endScrub(): void;

Ends a scrub: one undo step.

Returns#

void

resize()#

resize(width: number, height: number): void;

Sets the size of the field box and redraws.

Parameters#

Parameter	Type
`width`	`number`
`height`	`number`

Returns#

void

Inherited from#

Field.resize

scrubTo()#

scrubTo(dx: number, speed?: number): void;

Scrubs to dx pixels from the start. speed multiplies the change, as Shift and Alt do. No-op outside a scrub.

Parameters#

Parameter	Type	Default value
`dx`	`number`	`undefined`
`speed`	`number`	`1`

Returns#

void

setEnabled()#

setEnabled(on: boolean): void;

False dims the field and ignores input, while nothing is edited.

Parameters#

Parameter	Type
`on`	`boolean`

Returns#

void

Inherited from#

Field.setEnabled

show()#

show(values: readonly unknown[]): void;

Shows the values of the edited objects, one per object. Differing values show as mixed. An empty list disables the field.

Parameters#

Parameter	Type
`values`	readonly `unknown`[]

Returns#

void

Overrides#

Field.show

tick()#

tick(dt: number): boolean;

Advances the motion by dt seconds (only needed with ticker: null). Returns true while moving.

Parameters#

Parameter	Type
`dt`	`number`

Returns#

boolean

Inherited from#

Field.tick