Feedback
Last date modified: 2025-Apr-29
Interface: ItemListApi
ItemListApi.ItemListApi
Description
Contains APIs to allow item list manipulation and notification of various points in the item list's lifecycle
Properties
- getSelectedKeys
- onBrowserChange
- onDashboardChange
- onHighlightedRowChange
- onItemListPopulated
- onSelectedCountChange
- onTotalCountChange
- onViewChange
- requestItemListDataReload
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
- onBrowserChange: (
handler:EventHandlerFunction) =>void
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
- onDashboardChange: (
handler:EventHandlerFunction) =>void
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
- onHighlightedRowChange: (
handler:EventHandlerFunction) =>void
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
- onItemListPopulated: (
handler:EventHandlerFunction) =>void
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
- onSelectedCountChange: (
handler:EventHandlerFunction) =>void
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
- onTotalCountChange: (
handler:EventHandlerFunction) =>void
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
- onViewChange: (
handler:EventHandlerFunction) =>void
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
