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

    Interface IListPanePropertyItemOptions

    Optional properties for List Pane property item

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

    Hierarchy (View Summary)

    Index

    Properties

    defaultSlots? enable? height? layout onSlotClicked? onSlotSelectionChange? title? viewFilter? viewSortType? visible?

    Properties

    defaultSlots?: ListPaneSlotCreationProps[]

    This will be the height of the list withing the pane

    enable?: boolean

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

    height?: number

    This will be the height of the list withing the pane

    layout: ListPaneSlotLayout

    Layout for the list will need to be predefined, and using wrong layout shape while creating slots will throw

    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

    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