Options for an inspector.

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

Hierarchy (view full)

Properties

afterUpdate?: (() => any)

Optional callback to invoke after an update has occurred.

Type declaration

    • (): any
    • Returns any

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.

multipleSelections?: boolean

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

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

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

Type declaration

    • (obj, cb): void
    • Parameters

      • obj: Base
      • cb: (() => any)
          • (): any
          • Returns any

      Returns void

renderEmptyContainer: (() => void)

Callback invoked when the inspector is cleared.

Type declaration

    • (): void
    • Returns void

surface: Surface

The surface to attach to.