@minecraft/server-editor
    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>;
        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;
        addMenu(
            defaultEntries: {
                action?: RegisteredAction<NoArgsAction>;
                params: IMenuCreationParams;
            }[],
            options?: IMenuPropertyItemOptions,
        ): IMenuPropertyItem;
        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;
        addVector2(
            value: IObservableProp<Vector2>,
            options?: IVector2PropertyItemOptions,
        ): IVector2PropertyItem;
        addVector3(
            value: IObservableProp<Vector3>,
            options?: IVector3PropertyItemOptions,
        ): IVector3PropertyItem;
        beginConstruct(): void;
        collapse(): void;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        endConstruct(): void;
        expand(): void;
        getTitle(): undefined | LocalizedString;
        hide(): void;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setTitle(newTitle: undefined | LocalizedString): void;
        show(): void;
        toggleSubPaneVisibility(subPaneId: undefined | string): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapsed id onPropertyPaneVisibilityUpdated visible

    Methods

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

    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

    • Beta

      Parameters

      • paneId: string

      Returns void

      Adds a proxy view of another supported pane

    • Beta

      Returns void

      Begins pane construction for batching property item additions

    • Beta

      Returns void

      Collapse the pane.

    • Beta

      Returns void

      Finalizes pane construction and synchronizes item data

    • Beta

      Returns void

      Expand the pane.

    • Beta

      Returns void

      Hide the pane.

    • Beta

      Parameters

      Returns boolean

      Removes an existing sub pane.

    • Beta

      Parameters

      Returns void

      Updates title of pane.

    • Beta

      Returns void

      Show the pane and all of its items.

    • Beta

      Parameters

      • subPaneId: undefined | 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