Script API - v1.20.30
    Preparing search index...

    Interface IPropertyPaneBeta

    Property pane present dynamic content. It can be associated with an object and presented with different kind of controls.

    interface IPropertyPane {
        collapsed: boolean;
        id: string;
        onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
        parentPaneId?: string;
        titleAltText: string;
        titleStringId: string;
        width?: number;
        addBlockPicker<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsBlocks,
        ): IPropertyItem<T, Prop>;
        addBool<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptions,
        ): IPropertyItem<T, Prop>;
        addButton(
            action: RegisteredAction<NoArgsAction>,
            options?: IPropertyItemOptionsButton,
        ): IActionPropertyItem<{ EMPTY: undefined }, "EMPTY">;
        addDivider(): IPropertyItem<PropertyBag, string>;
        addDropdown<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsDropdown,
        ): IPropertyItem<T, Prop>;
        addNumber<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsNumber,
        ): IPropertyItem<T, Prop>;
        addString<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptions,
        ): IPropertyItem<T, Prop>;
        addVector3<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsVector3,
        ): IPropertyItem<T, Prop>;
        collapse(): void;
        createPropertyPane(options: IPropertyPaneOptions): IPropertyPane;
        expand(): void;
        hide(): void;
        removePropertyPane(paneToRemove: IPropertyPane): boolean;
        show(): void;
    }
    Index

    Properties

    collapsed id onPropertyPaneVisibilityUpdated parentPaneId? titleAltText titleStringId width?

    Methods

    addBlockPicker addBool addButton addDivider addDropdown addNumber addString addVector3 collapse createPropertyPane expand hide removePropertyPane show

    Properties

    collapsed: boolean

    Pane state for being expanded or collapsed.

    id: string

    Unique ID for the property pane.

    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

    Provides visibility change events

    parentPaneId?: string

    In case of sub pane this is the id of the parent pane.

    titleAltText: string

    Fallback display text if no loc ID

    titleStringId: string

    Loc ID (resolved on client)

    width?: number

    Width of the panel in rem.

    Methods

    • Beta

      Returns void

      Collapse the pane.

    • Beta

      Returns void

      Expand the pane.

    • Beta

      Returns void

      Hide the pane.

    • Beta

      Parameters

      Returns boolean

      Removes a child property pane from the parent pane.

    • Beta

      Returns void

      Show the pane and all of its property items.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods