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

    Interface ISubPanePropertyItem

    A property item which supports Sub Pane properties

    interface ISubPanePropertyItem {
        collapsed: boolean;
        enable: boolean;
        id: string;
        onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
        paneId: string;
        typeName: PropertyItemType;
        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;
        addColorTimeline(
            value: IObservableProp<number>,
            options?: IColorTimelinePropertyItemOptions,
        ): IColorTimelinePropertyItem;
        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;
        addNumberTimeline(
            value: IObservableProp<number>,
            options?: INumberTimelinePropertyItemOptions,
        ): INumberTimelinePropertyItem;
        addProgressIndicator(
            options?: IProgressIndicatorPropertyItemOptions,
        ): IProgressIndicatorPropertyItem;
        addProxyPane(paneId: string): void;
        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;
        beginConstruct(): void;
        collapse(): void;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        endConstruct(): void;
        getTitle(): LocalizedString;
        hide(): void;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setAlignment(alignment: LayoutAlignment): void;
        setDirection(direction: LayoutDirection): void;
        setTitle(newTitle: LocalizedString): void;
        show(): void;
        toggleSubPaneVisibility(subPaneId: string): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapsed enable id onPropertyPaneVisibilityUpdated paneId typeName visible

    Methods

    addBlockList addBlockTable addBool addButton addButtonPane addColorPicker addColorTimeline addComboBox addDataTable addDivider addDropdown addImage addLink addNumber addNumberTimeline addProgressIndicator addProxyPane addString addText addToggleGroup addVector3 beginConstruct collapse createSubPane endConstruct getTitle hide removeSubPane setAlignment setDirection setTitle show toggleSubPaneVisibility

    Properties

    collapsed: boolean

    Pane state for being expanded or collapsed.

    enable: boolean

    If the item is enabled in the UI.

    id: string

    Unique ID for the property item.

    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

    Provides visibility change events

    paneId: string

    The parent pane id.

    typeName: PropertyItemType

    The type name of the target property.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Parameters

      • paneId: string

      Returns void

      Adds a proxy view of another supported pane

    • Returns void

      Begins pane construction for batching property item additions

    • Returns void

      Finalizes pane construction and synchronizes item data

    • Parameters

      Returns void

      Updates layout alignment of the sub pane.

    • Parameters

      Returns void

      Updates layout direction of the sub pane.

    • Returns void

      Show the pane and all of its items.

    • Parameters

      • subPaneId: string

        Identifier of the sub pane to display.

      Returns void

      Shows only the specified sub-pane, hiding all others

    Settings

    Member Visibility

    On This Page

    Properties
    Methods