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

    Interface IListPaneViewControlPaneOptions

    interface IListPaneViewControlPaneOptions {
        actions?: ListViewControlAction[];
        filterFlags?: ListViewControlFilterFlags;
        onActionClicked?: (id: string) => void;
        onFilterChanged?: (visibleSlotIds: string[]) => void;
        onShowOptionChanged?: (optionIndex: number) => void;
        renderInline?: boolean;
        showOptions?: { label: LocalizedString; value: number }[];
        sortOptions?: ListPaneViewSortType[];
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actions? filterFlags? onActionClicked? onFilterChanged? onShowOptionChanged? renderInline? showOptions? sortOptions? visible?

    Properties

    actions?: ListViewControlAction[]

    Default actions

    filterFlags?: ListViewControlFilterFlags

    Flags to determine visible filters. If undefined it will be All.

    onActionClicked?: (id: string) => void

    This function will be called whenever user clicks an action

    onFilterChanged?: (visibleSlotIds: string[]) => void

    This function will be called whenever the filter is changed by the user

    onShowOptionChanged?: (optionIndex: number) => void

    Called when the user selects an entry in the "Show" dropdown. Receives the zero-based option index from the provided showOptions.

    renderInline?: boolean

    When true, the view control renders inline at the bottom of the list element instead of in a footer.

    showOptions?: { label: LocalizedString; value: number }[]

    Labels for the "Show" dropdown. When provided, a dropdown is shown and onShowOptionChanged is called with the selected index whenever the user changes the selection.

    sortOptions?: ListPaneViewSortType[]

    Custom sort options. If undefined, list pane sort options will be used.

    visible?: boolean

    Initial visibility state. It undefined, it will be false.

    Settings

    Member Visibility

    On This Page

    Properties