Script API - v26.50.24
    Preparing search index...

    Interface ISubPaneViewControlOptions

    Options to enable sorting and a fixed footer over a sub pane's direct child sub panes.

    interface ISubPaneViewControlOptions {
        actions?: ListViewControlAction[];
        filterFlags?: ListViewControlFilterFlags;
        getSortValue?: (childPaneId: string) => string | number;
        onActionClicked?: (id: string) => void;
        onFilterChanged?: (visibleChildPaneIds: string[]) => void;
        onShowOptionChanged?: (optionIndex: number) => void;
        onSortChanged?: (sort: SubPaneViewSortType) => void;
        renderInline?: boolean;
        showOptions?: { label: LocalizedString; value: number }[];
        sortLabels?: Partial<Record<SubPaneViewSortType, LocalizedString>>;
        sortOptions?: SubPaneViewSortType[];
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actions? filterFlags? getSortValue? onActionClicked? onFilterChanged? onShowOptionChanged? onSortChanged? renderInline? showOptions? sortLabels? sortOptions? visible?

    Properties

    Default actions

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

    getSortValue?: (childPaneId: string) => string | number

    Resolves each child's comparable value for the Custom sort. Only called for the Custom sort; the built-in Default / AtoZ / ZtoA never use it.

    onActionClicked?: (id: string) => void

    This function will be called whenever user clicks an action

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

    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.

    onSortChanged?: (sort: SubPaneViewSortType) => void

    Called when the user changes the sort.

    renderInline?: boolean

    When true, the view control renders inline at the bottom of the sub pane 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.

    sortLabels?: Partial<Record<SubPaneViewSortType, LocalizedString>>

    Optional label override per sort. Built-ins fall back to framework labels.

    sortOptions?: SubPaneViewSortType[]

    Sorts shown in the footer dropdown. If undefined, only Default is used.

    visible?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties