Skip to content
pixi-silk
GitHub repository
Interface

VectorFieldSpec

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

Two numbers in one row, such as X and Y, or W and H with an aspect lock.

Properties#

PropertyTypeDescriptionDefined in
keysreadonly [string, string]Dot paths of the two values.ui/panels/Inspector.ts:101
label?stringRow label. Also names the undo step. Default none: the step uses the first key.ui/panels/Inspector.ts:103
labels?readonly [string, string]Short names inside the two fields. Default X and Y.ui/panels/Inspector.ts:105
lockAspect?booleanShows a link button that keeps the ratio of the two values. Default false.ui/panels/Inspector.ts:119
max?numberHighest value of both axes. Default no limit.ui/panels/Inspector.ts:109
min?numberLowest value of both axes. Default no limit.ui/panels/Inspector.ts:107
perPixel?numberChange per pixel of a scrub. Default step.ui/panels/Inspector.ts:113
precision?numberDecimals shown. Default from the step.ui/panels/Inspector.ts:117
step?numberSnap step of both axes. Default 1.ui/panels/Inspector.ts:111
type"vector"Field kind.ui/panels/Inspector.ts:99
unit?stringShown after both values, such as px.ui/panels/Inspector.ts:115