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)[]
Returns

(string | number)[]

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

Description

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

onBrowserChange

Type declaration

  • (handler): void
Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void

Description

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

onDashboardChange

Type declaration

  • (handler): void
Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void

Description

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

onHighlightedRowChange

Type declaration

  • (handler): void
Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void

Description

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

onItemListPopulated

Type declaration

  • (handler): void
Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void

Description

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

onSelectedCountChange

Type declaration

  • (handler): void
Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void

Description

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

onTotalCountChange

Type declaration

  • (handler): void
Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void

Description

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

onViewChange

Type declaration

  • (handler): void
Parameters
Name Type Description
handler EventHandlerFunction The callback function to be triggered
Returns

void

Description

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

requestItemListDataReload

  • requestItemListDataReload: () => void

Type declaration

  • (): void
Returns

void

Description

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