Module: DataSourceApi

Enumerations

• DataSourceID

Interfaces

• DataSourceApi
• Field
• ItemListData
• ItemListDataSource
• ItemListDataSourceCallbacks
• ObjectManagerData
• ObjectManagerObject
• ObjectType

Type Aliases

• ArtifactIdentifier
• CustomFormatterOptions
• DataSource
• FieldValue
• FormatterDataItem
• ItemListDataSourceFactoryFunction
• SetListFilterDataFunction

Type Aliases

ArtifactIdentifier

Ƭ ArtifactIdentifier: Object

Description

Workspace level object identification

Type declaration

Name	Type
artifactID	number
workspaceID	number

CustomFormatterOptions

Ƭ CustomFormatterOptions: Object

Description

Formatting override options for a given component

Type declaration

Name	Type
format	(_content: any, dataItem: FormatterDataItem) => unknown
formatCsv	(_content: any, dataItem: FormatterDataItem) => string

DataSource

Ƭ DataSource: any | ItemListDataSourceFactoryFunction | SetListFilterDataFunction

Description

Data source structure is to be defined by the consuming component; May be factory function, object, script etc. For overriding the item list data source, use the ItemListDataSourceFactoryFunction For overriding the list filter data, use a SetListFilterDataFunction

FieldValue

Ƭ FieldValue: string | number | boolean

Description

Value contained in a certain Field object

FormatterDataItem

Ƭ FormatterDataItem: ArtifactIdentifier & Partial<Record<string, FieldValue>>

Description

todo:

ItemListDataSourceFactoryFunction

Ƭ ItemListDataSourceFactoryFunction: (workspaceID: number, artifactTypeID: number) => ItemListDataSource

Type declaration

• (workspaceID, artifactTypeID): ItemListDataSource

Parameters

Name	Type
workspaceID	number
artifactTypeID	number

Returns

ItemListDataSource

Description

Factory function to use when overriding the item list's data source

SetListFilterDataFunction

Ƭ SetListFilterDataFunction: (workspaceID: number, artifactTypeID: number, activeColumn: dataManagement.itemList.ItemListColumn, fieldCollection: ItemListFieldCollection, listPickerDataSourceFactory: ListPickerDataSourceFactory) => Promise<void>

Type declaration

• (workspaceID, artifactTypeID, activeColumn, fieldCollection, listPickerDataSourceFactory): Promise<void>

Parameters

Name	Type	Description
workspaceID	number	The active Workspace ID.
artifactTypeID	number	The active Artifact Type ID.
activeColumn	dataManagement.itemList.ItemListColumn	The active item list column.
fieldCollection	ItemListFieldCollection	The collection of fields for the current Artifact Type.
listPickerDataSourceFactory	ListPickerDataSourceFactory	The factory for obtaining a list picker data source.

Returns

Promise<void>

Description

Sets the list filter data for the given column