@minecraft/server-editor
    Preparing search index...

    Interface ISubPanePropertyItemBeta

    A property item which supports Sub Pane properties

    interface ISubPanePropertyItem {
        collapsed: boolean;
        enable: boolean;
        header: ISubPaneHeader | undefined;
        id: string;
        onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
        paneId: string;
        subPaneViewSortType: SubPaneViewSortType;
        typeName: PropertyItemType;
        viewControlPane: IListViewControlPane | undefined;
        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;
        addCollectionTree(
            options: ICollectionTreePropertyItemOptions,
        ): ICollectionTreePropertyItem;
        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(options?: IDividerPropertyItemOptions): IPropertyItemBase;
        addDropdown(
            value: IObservableProp<number>,
            options?: IDropdownPropertyItemOptions,
        ): IDropdownPropertyItem;
        addHeader(options?: ISubPaneHeaderOptions): ISubPaneHeader;
        addImage(
            value: IObservableProp<string | ImageResourceData>,
            options?: IImagePropertyItemOptions,
        ): IImagePropertyItem;
        addLink(
            value: IObservableProp<string>,
            options?: ILinkPropertyItemOptions,
        ): ILinkPropertyItem;
        addListPane(options: IListPanePropertyItemOptions): IListPanePropertyItem;
        addMenu(
            defaultEntries: {
                action?: RegisteredAction<NoArgsAction>;
                params: IMenuCreationParams;
            }[],
            options?: IMenuPropertyItemOptions,
        ): IMenuPropertyItem;
        addMinimap(
            mapId: string,
            options?: IMinimapPropertyItemOptions,
        ): IMinimapPropertyItem;
        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;
        addTagContainer(
            options?: ITagContainerPropertyItemOptions,
        ): ITagContainerPropertyItem;
        addText(
            value: IObservableProp<LocalizedString>,
            options?: ITextPropertyItemOptions,
        ): ITextPropertyItem;
        addTimelinePlayer(options?: ITimelinePlayerOptions): ITimelinePlayer;
        addToggleGroup(
            value: IObservableProp<number>,
            options?: IToggleGroupPropertyItemOptions,
        ): IToggleGroupPropertyItem;
        addVector2(
            value: IObservableProp<Vector2>,
            options?: IVector2PropertyItemOptions,
        ): IVector2PropertyItem;
        addVector3(
            value: IObservableProp<Vector3>,
            options?: IVector3PropertyItemOptions,
        ): IVector3PropertyItem;
        addVector3Timeline(
            value: IObservableProp<number>,
            options?: IVector3TimelinePropertyItemOptions,
        ): IVector3TimelinePropertyItem;
        buildSubPaneViewControl(
            options: ISubPaneViewControlOptions,
        ): IListViewControlPane;
        collapse(): void;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        expand(): void;
        getTitle(): LocalizedString | undefined;
        hide(): void;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setAlignment(alignment: LayoutAlignment): void;
        setDirection(layout: PaneLayoutType): void;
        setTags(tags: string[] | undefined): void;
        setTitle(newTitle: LocalizedString | undefined): void;
        show(): void;
        toggleSubPaneVisibility(subPaneId: string | undefined): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapsed enable header id onPropertyPaneVisibilityUpdated paneId subPaneViewSortType typeName viewControlPane visible

    Methods

    addBlockList addBlockTable addBool addButton addButtonPane addCollectionTree addColorPicker addColorTimeline addComboBox addDataTable addDivider addDropdown addHeader addImage addLink addListPane addMenu addMinimap addNumber addNumberTimeline addProgressIndicator addProxyPane addString addTagContainer addText addTimelinePlayer addToggleGroup addVector2 addVector3 addVector3Timeline buildSubPaneViewControl collapse createSubPane expand getTitle hide removeSubPane setAlignment setDirection setTags setTitle show toggleSubPaneVisibility

    Properties

    collapsed: boolean

    Pane state for being expanded or collapsed.

    enable: boolean

    If the item is enabled in the UI.

    header: ISubPaneHeader | undefined

    Fixed-layout header of the sub pane, or undefined if addHeader() was not called.

    id: string

    Unique ID for the property item.

    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

    Provides visibility change events

    paneId: string

    The parent pane id.

    subPaneViewSortType: SubPaneViewSortType

    Current sorting type for the direct child sub panes.

    typeName: PropertyItemType

    The type name of the target property.

    viewControlPane: IListViewControlPane | undefined

    View control pane for the direct child sub panes, or undefined if not built.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Beta

      Parameters

      • paneId: string

      Returns void

      Adds a proxy view of another supported pane

    • Beta

      Returns void

      Collapse the pane.

    • Beta

      Returns void

      Expand the pane.

    • Beta

      Returns void

      Hide the pane.

    • Beta

      Parameters

      Returns void

      Updates layout alignment of the sub pane.

    • Beta

      Parameters

      Returns void

      Updates layout direction of the sub pane.

    • Beta

      Parameters

      • tags: string[] | undefined

        New tags.

      Returns void

      Updates the tags associated with the sub pane, used by a parent sub pane view control's tag filter.

    • Beta

      Returns void

      Show the pane and all of its items.

    • Beta

      Parameters

      • subPaneId: string | undefined

        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