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

    Interface IListPanePropertyItem

    A property item which supports Sub Pane properties

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

    Hierarchy (View Summary)

    Index

    Properties

    enable id paneId slotCount typeName viewControlPane viewSortType visible

    Methods

    addSlot buildViewControl getSlotById getSlotByIndex getViewFilter hide removeSlot selectSlot setViewFilter setViewSortType show updateSlots

    Properties

    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 | undefined

    View control pane for the list

    viewSortType: ListPaneViewSortType

    Current sorting type for the pane slots

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Parameters

      • id: string

        Unique identifier of the slot.

      Returns IListPaneSlot | undefined

      Finds the slot with the identifier.

    • Parameters

      • index: number

        Index of the slot in the component list.

      Returns IListPaneSlot | undefined

      Finds the slot with the index.

    • Returns void

      Hide the pane.

    • 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

      • filter: ListPaneViewFilter | undefined

        Slots that don't match filter properties won't be included.

      Returns void

      Filters displaying slots to match the define properties

    • Parameters

      Returns void

      Updates how slots will be sorted in the view

    • Returns void

      Show the pane and all of its items.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods