Interface: ItemListApi

ItemListApi.ItemListApi

Description

Contains APIs to allow item list manipulation and notification of various points in the item list's lifecycle

Properties

Properties

getSelectedKeys

getSelectedKeys: () => (string | number)[]

Type declaration

▸ (): (string | number)[]

Description

Allows the retrieval of the keys of the selected items in the item list

Returns

(string | number)[]

The keys for the selected items in item list, usually artifact ID (number)


onBrowserChange

onBrowserChange: (handler: EventHandlerFunction) => void

Type declaration

▸ (handler): void

Description

Allows the developer to register a callback triggered when the document browser panel's tab is changed

Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void


onDashboardChange

onDashboardChange: (handler: EventHandlerFunction) => void

Type declaration

▸ (handler): void

Description

Allows the developer to register a callback triggered when the dashboard is changed

Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void


onHighlightedRowChange

onHighlightedRowChange: (handler: EventHandlerFunction) => void

Type declaration

▸ (handler): void

Description

Allows the developer to register a callback triggered when the highlighted row of the item list changes

Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void


onItemListPopulated

onItemListPopulated: (handler: EventHandlerFunction) => void

Type declaration

▸ (handler): void

Description

Allows the developer to register a callback triggered when the item list has populated with data

Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void


onSelectedCountChange

onSelectedCountChange: (handler: EventHandlerFunction) => void

Type declaration

▸ (handler): void

Description

Allows the developer to register a callback triggered when the number of selected items changes

Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void


onTotalCountChange

onTotalCountChange: (handler: EventHandlerFunction) => void

Type declaration

▸ (handler): void

Description

Allows the developer to register a callback triggered when the number items in the list changes

Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void


onViewChange

onViewChange: (handler: EventHandlerFunction) => void

Type declaration

▸ (handler): void

Description

Allows the developer to register a callback triggered when the view is changed

Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void


requestItemListDataReload

requestItemListDataReload: () => void

Type declaration

▸ (): void

Description

Allows the developer to trigger and reload and data update of the item list

Returns

void