@minecraft
    Preparing search index...

    Interface IListPanePropertyItem

    A property item which supports Sub Pane properties

    interface IListPanePropertyItem {
        enable: boolean;
        id: string;
        paneId: string;
        slotCount: number;
        typeName: PropertyItemType;
        viewControlPane: IListViewControlPane;
        viewSortType: string;
        visible: boolean;
        addSlot(params: ListPaneSlotCreationProps): IListPaneSlot;
        buildViewControl(
            options: IListPaneViewControlPaneOptions,
        ): IListViewControlPane;
        getSlotById(id: string): IListPaneSlot;
        getSlotByIndex(index: number): IListPaneSlot;
        getViewFilter(): ListPaneViewFilter;
        hide(): void;
        removeSlot(id: string): void;
        selectSlot(id: string, deselectOtherSlots?: boolean): void;
        setViewFilter(filter: ListPaneViewFilter): void;
        setViewSortType(sortType: string): void;
        show(): void;
        updateSlots(newSlots: ListPaneSlotCreationProps[]): void;
    }

    Hierarchy (View Summary)

    Index
    enable id paneId slotCount typeName viewControlPane viewSortType visible
    addSlot buildViewControl getSlotById getSlotByIndex getViewFilter hide removeSlot selectSlot setViewFilter setViewSortType show updateSlots
    enable: boolean

    If the item is enabled in the UI.

    id: string

    Unique ID for the property item.

    paneId: string

    The parent pane id.

    slotCount: number

    Count of the slots managed by the list.

    typeName: PropertyItemType

    The type name of the target property.

    viewControlPane: IListViewControlPane

    View control pane for the list

    viewSortType: string

    Current built-in sort type or custom sort category ID.

    visible: boolean

    If the item should be visible in the UI.

    • Parameters

      • id: string

        Unique identifier of the slot.

      Returns void

      Removes the slot from the list.

    • Parameters

      • id: string

        Unique identifier of the slot.

      • OptionaldeselectOtherSlots: boolean

        Deselects already selected slots if defined.

      Returns void

      Selects slot by id.

    • Parameters

      • sortType: string

        New built-in sort type or custom sort category ID. If undefined, the default will be used.

      Returns void

      Updates how slots will be sorted in the view.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods