Skip to main content
InspectorOptions
Options for an inspector.
NameTypeDescription
afterUpdate?() => anyOptional callback to invoke after an update has occurred.
autoCommit?booleanWhether or not to auto commit changes on blur/change events. Defaults to true.
containerHTMLElementThe element into which the inspector is drawn.
context?Record<string,any>Optional context to also provide to the templates when rendering. This can be accessed via the $context prefix, for
instance
{{$context.myValue}}
cssClass?stringOptional css class(es) to set on the inspector - a space separated list.
doNotWriteBlankNewValues?booleanDefaults to true. With this setting, if an update is made that has one or more blank strings, the strings will only be written to objects that already had some value for the corresponding key. If some object has, say, no value stored against the key foo, then the inspector will not write a value of "" for that key into the vertex. The reasoning for this flag is that you cannot get a null value from a text field, so if some text field has no value written in it and then gets a blur event, the UI reports a value of "", ie an empty string. But this is likely not the user's intention, if the field was blank to begin with.
filter?(b:Base) => booleanOptional filter you can use to instruct the inspector to ignore certain items.
getDefaultValue?(d:ObjectData, key:string) => anyOptional callback used to retrieve a value for a specific property when it's not present in the object's data.
multipleSelections?booleanWhether or not to support multiple selections. Defaults to true.
refresh(obj:Base, cb:() => any) => voidCallback invoked when a new object has started to be edited.
showCloseButton?booleanDefaults to false. When true, the inspector will have a close button in the top right corner, which, when pressed, will
clear the Toolkit's selection.
uiBrowserUIThe UI to attach to.