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

    Interface IPropertyPane

    Property pane present dynamic content. It can be associated with an object and presented with different kind of controls.

    export interface IPropertyPane extends IPane {
        readonly collapsed: boolean;
        onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
        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<minecraftserver.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;
        addListPane(options: IListPanePropertyItemOptions): IListPanePropertyItem;
        addMenu(
            defaultEntries: {
                params: IMenuCreationParams;
                action?: RegisteredAction<NoArgsAction>;
            }[],
            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;
        addToggleGroup(value: IObservableProp<number>, options?: IToggleGroupPropertyItemOptions): IToggleGroupPropertyItem;
        addVector2(
            value: IObservableProp<minecraftserver.Vector2>,
            options?: IVector2PropertyItemOptions,
        ): IVector2PropertyItem;
        addVector3(
            value: IObservableProp<minecraftserver.Vector3>,
            options?: IVector3PropertyItemOptions,
        ): IVector3PropertyItem;
        addVector3Timeline(
            value: IObservableProp<number>,
            options?: IVector3TimelinePropertyItemOptions,
        ): IVector3TimelinePropertyItem;
        collapse(): void;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        expand(): void;
        getTitle(): LocalizedString | undefined;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setTitle(newTitle: LocalizedString | undefined): void;
        toggleSubPaneVisibility(subPaneId: string | undefined): void;
    }
    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;
        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(): IPropertyItemBase;
        addDropdown(
            value: IObservableProp<number>,
            options?: IDropdownPropertyItemOptions,
        ): IDropdownPropertyItem;
        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;
        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;
        collapse(): void;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        expand(): void;
        getTitle(): LocalizedString | undefined;
        hide(): void;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setTitle(newTitle: LocalizedString | undefined): void;
        show(): void;
        toggleSubPaneVisibility(subPaneId: string | undefined): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapsed id onPropertyPaneVisibilityUpdated visible

    Methods

    addBlockList addBlockTable addBool addButton addButtonPane addCollectionTree addColorPicker addColorTimeline addComboBox addDataTable addDivider addDropdown addImage addLink addListPane addMenu addMinimap addNumber addNumberTimeline addProgressIndicator addProxyPane addString addTagContainer addText addToggleGroup addVector2 addVector3 addVector3Timeline collapse createSubPane 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

    • Parameters

      • paneId: string

      Returns void

      Adds a proxy view of another supported pane

    • Returns void

      Collapse the pane.

    • Returns void

      Expand the pane.

    • Returns void

      Hide the pane.

    • Parameters

      Returns boolean

      Removes an existing sub pane.

    • Parameters

      Returns void

      Updates title of pane.

    • Returns void

      Show the pane and all of its items.

    • 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