Script API - v1.21.50
    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(
            options?: IPropertyItemOptionsBlockList,
        ): IBlockListPropertyItem<{ EMPTY: undefined }, "EMPTY">;
        addBool(
            value: IObservableProp<boolean>,
            options?: IBoolPropertyItemOptions,
        ): IBoolPropertyItem;
        addBool_deprecated<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsBool,
        ): IPropertyItem<T, Prop>;
        addButton(
            action: RegisteredAction<NoArgsAction> | (() => void),
            options?: IButtonPropertyItemOptions,
        ): IButtonPropertyItem;
        addColorPicker(
            value: IObservableProp<RGBA>,
            options?: IColorPickerPropertyItemOptions,
        ): IColorPickerPropertyItem;
        addColorPicker_deprecated<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsColorPicker_deprecated,
        ): IPropertyItem<T, Prop>;
        addComboBox(
            value: IObservableProp<string>,
            options?: IComboBoxPropertyItemOptions,
        ): IComboBoxPropertyItem;
        addDivider(): IPropertyItemBase;
        addDropdown(
            value: IObservableProp<number>,
            options?: IDropdownPropertyItemOptions,
        ): IDropdownPropertyItem;
        addDropdown_deprecated<
            T extends Omit<PropertyBag, Prop> & { [key in string]: number },
            Prop extends string,
        >(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsDropdown,
        ): IDropdownPropertyItem_deprecated<T, Prop>;
        addImage(
            value: IObservableProp<string | ImageResourceData>,
            options?: IImagePropertyItemOptions,
        ): IImagePropertyItem;
        addNumber(
            value: IObservableProp<number>,
            options?: INumberPropertyItemOptions,
        ): INumberPropertyItem;
        addNumber_deprecated<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsNumber,
        ): IPropertyItem<T, Prop>;
        addString(
            value: IObservableProp<string>,
            options?: IStringPropertyItemOptions,
        ): IStringPropertyItem;
        addString_deprecated<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptions,
        ): IPropertyItem<T, Prop>;
        addTable(
            options?: IPropertyItemOptionsTable,
        ): ITablePropertyItem<{ EMPTY: undefined }, "EMPTY">;
        addText(
            value: IObservableProp<LocalizedString>,
            options?: ITextPropertyItemOptions,
        ): ITextPropertyItem;
        addToggleGroup(
            value: IObservableProp<number>,
            options?: IToggleGroupPropertyItemOptions,
        ): IToggleGroupPropertyItem;
        addVector3(
            value: IObservableProp<Vector3>,
            options?: IVector3PropertyItemOptions,
        ): IVector3PropertyItem;
        addVector3_deprecated<T extends PropertyBag, Prop extends string>(
            obj: T,
            property: Prop,
            options?: IPropertyItemOptionsVector3,
        ): IVector3PropertyItem_deprecated<T, Prop>;
        collapse(): void;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        expand(): void;
        getTitle(): LocalizedString | undefined;
        hide(): void;
        isHeaderActionVisible(): boolean;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setHeaderActionVisibility(visible: boolean): void;
        setTitle(newTitle: LocalizedString | undefined): void;
        show(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapsed id onPropertyPaneVisibilityUpdated visible

    Methods

    addBlockList addBool addBool_deprecated addButton addColorPicker addColorPicker_deprecated addComboBox addDivider addDropdown addDropdown_deprecated addImage addNumber addNumber_deprecated addString addString_deprecated addTable addText addToggleGroup addVector3 addVector3_deprecated collapse createSubPane expand getTitle hide isHeaderActionVisible removeSubPane setHeaderActionVisibility setTitle 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

    visible: boolean

    Check visibility of the pane

    Methods

    • Returns boolean

      Current visibility state of header action

    • 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 property items.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods