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

    Interface IListPanePropertyItemOptions

    Optional properties for List Pane property item

    interface IListPanePropertyItemOptions {
        defaultSlots?: ListPaneSlotCreationProps[];
        enable?: boolean;
        fixedHeight?: boolean;
        height?: number;
        onSlotClicked?: (slot: IListPaneSlot) => void;
        onSlotSelectionChange?: (slot: IListPaneSlot, state: boolean) => void;
        slotConfig: ListPaneSlotConfiguration;
        style?: PaneItemStyle;
        title?: LocalizedString;
        viewFilter?: ListPaneViewFilter;
        viewSortType?: ListPaneViewSortType;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    defaultSlots? enable? fixedHeight? height? onSlotClicked? onSlotSelectionChange? slotConfig style? title? viewFilter? viewSortType? visible?

    Properties

    defaultSlots?: ListPaneSlotCreationProps[]

    Default slots to initialize the list with. If undefined, the list will be empty.

    enable?: boolean

    Initial enabled state of property item. If undefined, it will default to true.

    fixedHeight?: boolean

    If true, pane height will not change based on slot count. If undefined, it will default to false

    height?: number

    This will be the height of the list within the pane

    onSlotClicked?: (slot: IListPaneSlot) => void

    This callback is fired whenever a clickable slot is pressed

    onSlotSelectionChange?: (slot: IListPaneSlot, state: boolean) => void

    This callback is fired whenever selected state of a slot is changed

    slotConfig: ListPaneSlotConfiguration

    Slot configuration for the list. The slot entry layout must be predefined, and using an incorrect layout while creating slots will throw an error.

    style?: PaneItemStyle

    Optional styling overrides for the item.

    title?: LocalizedString

    Localized title of the property item.

    viewFilter?: ListPaneViewFilter

    Filter properties for viewing subset of slots.

    viewSortType?: ListPaneViewSortType

    Sort type for the slots in the view. If undefined, default list order will be used.

    visible?: boolean

    Initial visibility state of property item. If undefined, it will default to true.

    Settings

    Member Visibility

    On This Page

    Properties