Interface VanillaInspectorOptions

Options for the VanillaInspector, an instance of Inspector that uses the Toolkit's default templating mechanism to render elements.

interface VanillaInspectorOptions {
    afterUpdate?: (() => any);
    autoCommit?: boolean;
    cacheTemplates?: boolean;
    container: HTMLElement;
    cssClass?: string;
    emptyTemplate?: string;
    multipleSelections?: boolean;
    surface: Surface;
    templateResolver: ((obj) => string);
}

Hierarchy

  • Omit<InspectorOptions, "renderEmptyContainer" | "refresh">
    • VanillaInspectorOptions

Properties

afterUpdate? autoCommit? cacheTemplates? container cssClass? emptyTemplate? multipleSelections? surface templateResolver

Properties

Optional afterUpdate

afterUpdate?: (() => any)

Optional callback to invoke after an update has occurred.

Type declaration

    • (): any

    • Returns any

Optional autoCommit

autoCommit?: boolean

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

Optional cacheTemplates

cacheTemplates?: boolean

By default the inspector will cache found templates, keyed by the type of the object and its category (there is a separate cache for nodes, groups, edges and ports, and in each cache the key is the object's type). In some situations you may not want to cache the template, for instance if your template has dynamic data that depends on the object that is being inspected. If that's the case you can set this to false.

container

container: HTMLElement

The element in which the inspector is drawn.

Optional cssClass

cssClass?: string

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

Optional emptyTemplate

emptyTemplate?: string

Template to use in the inspector when there is nothing selected. By default an empty div element is used.

Optional multipleSelections

multipleSelections?: boolean

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

surface

surface: Surface

The surface to attach to.

templateResolver

templateResolver: ((obj) => string)

Resolves templates for a given object.

Type declaration

    • (obj): string

    • Parameters

      • obj: Base

      Returns string

Settings

Member Visibility

Theme

On This Page

afterUpdateautoCommitcacheTemplatescontainercssClassemptyTemplatemultipleSelectionssurfacetemplateResolver