@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;
        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;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        getTitle(): undefined | LocalizedString;
        hide(): void;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setTitle(newTitle: undefined | 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 createSubPane getTitle hide removeSubPane 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

    • Beta

      Returns void

      Collapse 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.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods