Interface InspectorOptions

Options for an inspector.

interface InspectorOptions {
    afterUpdate?: (() => any);
    autoCommit?: boolean;
    container: HTMLElement;
    cssClass?: string;
    doNotWriteBlankNewValues?: boolean;
    filter?: ((b: Base) => boolean);
    multipleSelections?: boolean;
    refresh: ((obj: Base, cb: (() => any)) => void);
    showCloseButton?: boolean;
    surface: Surface;
}

Properties

afterUpdate?: (() => any)

Optional callback to invoke after an update has occurred.

autoCommit?: boolean

Whether or not to auto commit changes on blur/change events. Defaults to true.

container: HTMLElement

The element in which the inspector is drawn.

cssClass?: string

Optional css class(es) to set on the inspector - a space separated list.

doNotWriteBlankNewValues?: boolean

Defaults 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) => boolean)

Optional filter you can use to instruct the inspector to ignore certain items.

Type declaration

    • (b): boolean
    • Parameters

      • b: Base

        The object to test

      Returns boolean

multipleSelections?: boolean

Whether or not to support multiple selections. Defaults to true.

refresh: ((obj: Base, cb: (() => any)) => void)

Callback invoked when a new object has started to be edited.

showCloseButton?: boolean

Defaults 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.

surface: Surface

The surface to attach to.

Version :