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

    Interface IRootPropertyPane

    A root pane that can store property items.

    interface IRootPropertyPane {
        collapsed: boolean;
        id: string;
        onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
        visible: boolean;
        addBlockList(
            value: IObservableProp<string[]>,
            options?: IBlockListPropertyItemOptions,
        ): IBlockListPropertyItem;
        addBlockTable(
            options?: IBlockTablePropertyItemOptions,
        ): IBlockTablePropertyItem;
        addBool(
            value: IObservableProp<boolean>,
            options?: IBoolPropertyItemOptions,
        ): IBoolPropertyItem;
        addButton(
            action: ButtonPropertyItemSupportedActionTypes,
            options?: IButtonPropertyItemOptions,
        ): IButtonPropertyItem;
        addButtonPane(
            options?: IButtonPanePropertyItemOptions,
        ): IButtonPanePropertyItem;
        addColorPicker(
            value: IObservableProp<RGBA>,
            options?: IColorPickerPropertyItemOptions,
        ): IColorPickerPropertyItem;
        addComboBox(
            value: IObservableProp<string>,
            options?: IComboBoxPropertyItemOptions,
        ): IComboBoxPropertyItem;
        addDataTable(
            options?: IDataTablePropertyItemOptions,
        ): IDataTablePropertyItem;
        addDivider(): IPropertyItemBase;
        addDropdown(
            value: IObservableProp<number>,
            options?: IDropdownPropertyItemOptions,
        ): IDropdownPropertyItem;
        addImage(
            value: IObservableProp<string | ImageResourceData>,
            options?: IImagePropertyItemOptions,
        ): IImagePropertyItem;
        addLink(
            value: IObservableProp<string>,
            options?: ILinkPropertyItemOptions,
        ): ILinkPropertyItem;
        addNumber(
            value: IObservableProp<number>,
            options?: INumberPropertyItemOptions,
        ): INumberPropertyItem;
        addProgressIndicator(
            options?: IProgressIndicatorPropertyItemOptions,
        ): IProgressIndicatorPropertyItem;
        addString(
            value: IObservableProp<string>,
            options?: IStringPropertyItemOptions,
        ): IStringPropertyItem;
        addText(
            value: IObservableProp<LocalizedString>,
            options?: ITextPropertyItemOptions,
        ): ITextPropertyItem;
        addToggleGroup(
            value: IObservableProp<number>,
            options?: IToggleGroupPropertyItemOptions,
        ): IToggleGroupPropertyItem;
        addVector3(
            value: IObservableProp<Vector3>,
            options?: IVector3PropertyItemOptions,
        ): IVector3PropertyItem;
        collapse(): void;
        createModalOverlayPane(
            options?: IModalOverlayPaneOptions,
        ): IModalOverlayPane;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        getActiveModalOverlayId(): string;
        getTitle(): LocalizedString;
        hide(): void;
        isHeaderActionVisible(): boolean;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setActiveModalOverlay(id: string): void;
        setHeaderActionVisibility(visible: boolean): void;
        setTitle(newTitle: LocalizedString): void;
        show(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapsed id onPropertyPaneVisibilityUpdated visible

    Methods

    addBlockList addBlockTable addBool addButton addButtonPane addColorPicker addComboBox addDataTable addDivider addDropdown addImage addLink addNumber addProgressIndicator addString addText addToggleGroup addVector3 collapse createModalOverlayPane createSubPane getActiveModalOverlayId getTitle hide isHeaderActionVisible removeSubPane setActiveModalOverlay setHeaderActionVisibility setTitle show

    Properties

    collapsed: boolean

    Pane state for being expanded or collapsed.

    id: string

    Unique identifier for the pane.

    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

    Provides visibility change events

    visible: boolean

    Check visibility of the pane

    Methods

    • Returns string

      Unique identifier of the active modal overlay

    • Returns boolean

      Current visibility state of header action

    • Parameters

      • id: string

        Unique id for modal overlay pane.

      Returns void

      Sets registered modal overlay as active, if not found it will hide the current.

    • Parameters

      • visible: boolean

        New visibility state of the action button.

      Returns void

      If a header action exists, updates visibility of the button.

    • Returns void

      Show the pane and all of its items.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods