@samatawy/diagrams
    Preparing search index...

    Interface InspectorPropertyDefinition

    Defines how a single inspector row is rendered and edited.

    interface InspectorPropertyDefinition {
        key: string;
        label?: string;
        type: "string" | "number" | "boolean" | "object" | "select";
        editor?: InspectorAdapterClassName;
        editorOptions?: object;
        readonly: boolean;
        disabled?: boolean;
        volatile?: boolean;
        isVisible?: () => boolean;
    }
    Index

    Properties

    key label? type editor? editorOptions? readonly disabled? volatile? isVisible?

    Properties

    key: string

    Unique key/path used to read and write the property.

    label?: string

    Optional display label shown in the inspector row.

    type: "string" | "number" | "boolean" | "object" | "select"

    Primitive value category used for adapter resolution.

    editor?: InspectorAdapterClassName

    Optional explicit adapter/editor name overriding type-based resolution.

    editorOptions?: object

    Optional editor-specific configuration object passed to the adapter.

    readonly: boolean

    Marks the row as read-only.

    disabled?: boolean

    Marks the row as disabled.

    volatile?: boolean

    Marks the row as volatile so it can be rebuilt for selection-specific structures.

    isVisible?: () => boolean

    Optional callback evaluated on every refresh. When it returns false the row is hidden. If omitted the row is always visible.

    Settings

    Member Visibility

    On This Page

    Properties