Interface: DataSourceApi

DataSourceApi.DataSourceApi

Description

Contains APIs to allow the registration of a different data source for the current list

Properties

Properties

dataSourceExists

• dataSourceExists: (componentId: string) => boolean

Type declaration

▸ (componentId): boolean

Description

Checks if an override datasource exists for the given component

Parameters
Name Type Description
componentId string The unique identifier for the component or panel (e.g. "ItemListWidget")
Returns

boolean

Whether an override datasource exists

getFieldCollection

• getFieldCollection: () => ItemListFieldCollection

Type declaration

▸ (): ItemListFieldCollection

Description

Returns the field collection for the current object type

Returns

ItemListFieldCollection

The collection of all fields for the current object type

registerColumnFormatter

• registerColumnFormatter: (field: FieldRef, formatter: CustomFormatterOptions) => void

Type declaration

▸ (field, formatter): void

Description

Registers a custom formatter for the given field

Parameters
Name Type Description
field FieldRef The unique identifier for the field (name or artifactID)
formatter CustomFormatterOptions -
Returns

void

registerDataSource

• registerDataSource: (componentId: string, data: any) => void

Type declaration

▸ (componentId, data): void

Description

Registers a data source to override for the given component ID

Parameters
Name Type Description
componentId string The unique identifier for the component or panel (e.g. "ItemListWidget")
data any The override data source for the given component
Returns

void

registerOverrideOperators

• registerOverrideOperators: (fieldName: string, operators: Operator[]) => void

Type declaration

▸ (fieldName, operators): void

Description

Registers override operators for the given field name

Parameters
Name Type Description
fieldName string The name of the field to use operators on
operators Operator[] The override operators for the given field
Returns

void

retrieveDataSource

• retrieveDataSource: (componentId: string) => any

Type declaration

▸ (componentId): any

Description

Retrieves a data source for the given component ID

Parameters
Name Type Description
componentId string The unique identifier for the component or panel (e.g. "ItemListWidget")
Returns

any

The override data source for the given component