Module: DataSourceApi

Enumerations

Interfaces

Type Aliases

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

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


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

Description

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

Parameters
Name Type
workspaceID number
artifactTypeID number
Returns

ItemListDataSource