Skip to content
pixi-silk
GitHub repository
Interface

InspectorOptions

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

Options of Inspector.

Properties#

PropertyTypeDescriptionDefined in
atlas?SdfAtlasGlyph atlas of the labels. Default the shared one.ui/panels/Inspector.ts:168
binding?InspectorBinding | readonly object[] | nullWhat the rows edit. Default nothing: the rows show dimmed until Inspector.bind.ui/panels/Inspector.ts:152
colorPicker?ColorPickerFactoryBuilds the colour picker of colour fields. Default a 176 pixel HueSquarePicker.ui/panels/Inspector.ts:160
element?HTMLElementThe element the scene is drawn on, usually app.canvas. Text fields position their hidden input against it.ui/panels/Inspector.ts:164
history?HistoryLikeWhere edits go for undo. Every drag, toggle or commit is one step.ui/panels/Inspector.ts:154
labelWidth?numberWidth of the label column. Default 72.ui/panels/Inspector.ts:156
popoverLayer?Container<ContainerChild>Where colour pickers open. Default the top container of the scene at the time.ui/panels/Inspector.ts:162
rowHeight?numberRow height in local units. Default 30.ui/panels/Inspector.ts:158
schemareadonly InspectorField[]The rows, top to bottom.ui/panels/Inspector.ts:150
theme?Partial<PanelTheme>Colours, radius and font. Default the dark theme.ui/panels/Inspector.ts:166
ticker?Ticker | nullTicker driving the motion. Default Ticker.shared. With null, call tick on each field yourself.ui/panels/Inspector.ts:170