Interface: ItemListDataSource

DataSourceApi.ItemListDataSource

Description

Contains the item list data source APIs that can be overwritten

Methods

Methods

getData

▸ getData(activeArtifactID, start, pageLength, filters, sorts, fieldIDs, fieldCollection?, activeView?, sampleState?, browserState?, relationalFieldId?, activeSavedSearchID?, queryHint?, cancellable?): Promise<void | ObjectManagerData>

Parameters

Name Type Description
activeArtifactID undefined | number The artifactID of the highlighted item.
start number Start number of the page to retrieve.
pageLength number The length of the page to retrieve.
filters Filter The current filter state.
sorts Sort[] The current item list sorts.
fieldIDs number[] The ids of the fields on the Item List.
fieldCollection? ItemListFieldCollection A collection of fields that could be in the item list.
activeView? View The current active view on the item list page.
sampleState? SampleState The current sample state.
browserState? BrowserPanelState The current browser panel state
relationalFieldId? number The ID of the new relational field
activeSavedSearchID? number The current active saved search artifactID.
queryHint? string The query hint to use for the data retrieval
cancellable? boolean Whether the data retrieval can be cancelled.

Returns

Promise<void | ObjectManagerData>

The returned data from the data source call.

Description

Used to retrieve data from the data source.

transformInbound

▸ transformInbound(data, columns, workspaceID, callbacks): ItemListData

Description

Transforms raw data into item list data

Parameters

Name Type Description
data any The raw data.
columns any[] Item list columns in use.
workspaceID number The workspace ID of the workspace.
callbacks ItemListDataSourceCallbacks Function used to manipulate item list data

Returns

ItemListData

The transformed data for use with the item list.

transformMultiReflectedFields

▸ transformMultiReflectedFields(fields, fieldCollection): void

Description

Transform any multi-reflected fields present in the given data set.

Parameters

Name Type Description
fields Data[] -
fieldCollection ItemListFieldCollection The Item List Field Collection containing field metadata.

Returns

void