#Interface: ISubPaneViewControlOptions experimental

Beta

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

#Extends

• IListViewControlPaneOptions

#Properties

#actions?

optional actions?: ListViewControlAction[]

Beta

#Remarks

Default actions

#Inherited from

IListViewControlPaneOptions.actions

---

#filterFlags?

optional filterFlags?: ListViewControlFilterFlags

Beta

#Remarks

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

---

#getSortValue?

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

Beta

#Parameters

#childPaneId

string

#Returns

string | number

#Remarks

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?

optional onActionClicked?: (id) => void

Beta

#Parameters

#id

string

#Returns

void

#Remarks

This function will be called whenever user clicks an action

#Inherited from

IListViewControlPaneOptions.onActionClicked

---

#onFilterChanged?

optional onFilterChanged?: (visibleChildPaneIds) => void

Beta

#Parameters

#visibleChildPaneIds

string[]

#Returns

void

#Remarks

Called whenever the filter is changed by the user.

---

#onShowOptionChanged?

optional onShowOptionChanged?: (optionIndex) => void

Beta

#Parameters

#optionIndex

number

#Returns

void

#Remarks

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

---

#onSortChanged?

optional onSortChanged?: (sort) => void

Beta

#Parameters

#sort

SubPaneViewSortType

#Returns

void

#Remarks

Called when the user changes the sort.

---

#renderInline?

optional renderInline?: boolean

Beta

#Remarks

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

---

#showOptions?

optional showOptions?: object[]

Beta

#label

label: LocalizedString

#value

value: number

#Remarks

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?

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

Beta

#Remarks

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

---

#sortOptions?

optional sortOptions?: SubPaneViewSortType[]

Beta

#Remarks

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

---

#visible?

optional visible?: boolean

Beta

#Remarks

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

#Inherited from

IListViewControlPaneOptions.visible