Docs

Allows you to use in-memory array as Data Source.

# Extends

  • DataProvider

# Implements

# Accessors

# aggregation

get aggregation(): IAggregation

Dataset aggregations.

# Returns

IAggregation

Dataset aggregations.

# Implementation of

IMemoryProvider.aggregation

# Inherited from

DataProvider.aggregation

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:410

# grouping

get grouping(): IGrouping

Dataset grouping.

# Returns

IGrouping

Dataset grouping.

# Implementation of

IMemoryProvider.grouping

# Inherited from

DataProvider.grouping

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:442

# Methods

# clearChanges()

clearChanges(): void

Clears all unsaved changes in the data provider.

# Returns

void

# Implementation of

IMemoryProvider.clearChanges

# Inherited from

DataProvider.clearChanges

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:743

# clearSelectedRecordIds()

clearSelectedRecordIds(): void

Clears the currently selected record IDs. been used to create the child data provider.

# Returns

void

# Implementation of

IMemoryProvider.clearSelectedRecordIds

# Inherited from

DataProvider.clearSelectedRecordIds

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:707

# createGroupedRecordDataProvider()

createGroupedRecordDataProvider(group): IDataProvider

Returns a child data provider that can be used to retrieve grouped records. If a provider for this group already exists, it will be returned instead.

# Parameters

• group: IRecord

The record representing the group for which to retrieve child records.

# Returns

IDataProvider

# Implementation of

IMemoryProvider.createGroupedRecordDataProvider

# Inherited from

DataProvider.createGroupedRecordDataProvider

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:542

# createNewDataProvider()

createNewDataProvider(eventBubbleOptions?): IDataProvider

Creates new Data Provider with the same settings as current one. eventBubbleOptions - Options to control which events should bubble up from the new data provider to the parent.

# Parameters

• eventBubbleOptions?: IEventBubbleOptions

# Returns

IDataProvider

# Implementation of

IMemoryProvider.createNewDataProvider

# Inherited from

DataProvider.createNewDataProvider

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:505

# getColumns()

getColumns(): IColumn[]

Returns current columns

# Returns

IColumn[]

# Implementation of

IMemoryProvider.getColumns

# Inherited from

DataProvider.getColumns

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:262

# getColumnsMap()

getColumnsMap(): object

Returns a map of all columns that have been defined for the provider. Also includes columns that have been deleted via setColumns.

# Returns

object

# Implementation of

IMemoryProvider.getColumnsMap

# Inherited from

DataProvider.getColumnsMap

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:763

# getCurrencies()

getCurrencies(): ICurrency[]

Gets the currencies the provider is able to work with.

# Returns

ICurrency[]

# Implementation of

IMemoryProvider.getCurrencies

# Inherited from

DataProvider.getCurrencies

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:302

# getCustomProperty()

getCustomProperty(name): any

Gets a custom property from the data provider.

# Parameters

• name: string

# Returns

any

# Implementation of

IMemoryProvider.getCustomProperty

# Inherited from

DataProvider.getCustomProperty

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:191

# getDataSource()

getDataSource(): any

Gets the current Data Source.

# Returns

any

# Implementation of

IMemoryProvider.getDataSource

# Inherited from

DataProvider.getDataSource

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:127

# getDirtyRecordIds()

getDirtyRecordIds(): string[]

Returns the IDs of records that have unsaved changes.

# Returns

string[]

# Implementation of

IMemoryProvider.getDirtyRecordIds

# Inherited from

DataProvider.getDirtyRecordIds

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:352

# getEntityName()

getEntityName(): string

Returns the name of the associated entity.

# Returns

string

The entity name.

# Implementation of

IMemoryProvider.getEntityName

# Inherited from

DataProvider.getEntityName

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:156

# getErrorMessage()

getErrorMessage(): string

Returns the error message from the last data retrieval attempt, if any.

# Returns

string

# Implementation of

IMemoryProvider.getErrorMessage

# Inherited from

DataProvider.getErrorMessage

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:139

# getFiltering()

getFiltering(): null | FilterExpression

Gets the current filtering.

# Returns

null | FilterExpression

# Implementation of

IMemoryProvider.getFiltering

# Inherited from

DataProvider.getFiltering

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:280

# getGroupedRecordDataProvider()

getGroupedRecordDataProvider(groupedRecordId): null | IDataProvider

Returns a child data provider for a specific parent record ID.

# Parameters

• groupedRecordId: string

# Returns

null | IDataProvider

# Implementation of

IMemoryProvider.getGroupedRecordDataProvider

# Inherited from

DataProvider.getGroupedRecordDataProvider

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:538

# getGroupedRecordDataProviders()

getGroupedRecordDataProviders(allLevels?): IDataProvider[]

Returns all direct grouped records data providers.

# Parameters

• allLevels?: boolean

If true, returns grouped record providers at all levels. If false, returns only direct children.

# Returns

IDataProvider[]

# Implementation of

IMemoryProvider.getGroupedRecordDataProviders

# Inherited from

DataProvider.getGroupedRecordDataProviders

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:494

# getInvalidRecordIds()

getInvalidRecordIds(): string[]

Returns the IDs of records that have invalid values.

# Returns

string[]

# Implementation of

IMemoryProvider.getInvalidRecordIds

# Inherited from

DataProvider.getInvalidRecordIds

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:739

# getLinking()

getLinking(): LinkEntityExposedExpression[]

Retrieves the link entity expressions used to join related entities.

# Returns

LinkEntityExposedExpression[]

# Implementation of

IMemoryProvider.getLinking

# Inherited from

DataProvider.getLinking

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:292

# getMetadata()

getMetadata(): any

Gets the associated entity metadata.

# Returns

any

# Implementation of

IMemoryProvider.getMetadata

# Inherited from

DataProvider.getMetadata

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:133

# getNestingLevel()

getNestingLevel(): number

Returns how deep the data provider is nested.

# Returns

number

# Implementation of

IMemoryProvider.getNestingLevel

# Inherited from

DataProvider.getNestingLevel

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:731

# getPaging()

getPaging(): object

Returns paging information (like page number, total pages, etc.).

# Returns

object

The paging information.

# firstPageNumber

firstPageNumber: number

# hasNextPage

hasNextPage: boolean

# hasPreviousPage

hasPreviousPage: boolean

# lastPageNumber

lastPageNumber: number

# loadExactPage()

loadExactPage: (pageNumber) => Promise<IRecord[]>

# Parameters

• pageNumber: number

# Returns

Promise<IRecord[]>

# loadNextPage()

loadNextPage: () => Promise<IRecord[]>

# Returns

Promise<IRecord[]>

# loadPreviousPage()

loadPreviousPage: () => Promise<IRecord[]>

# Returns

Promise<IRecord[]>

# pageNumber

pageNumber: number

# pageSize

pageSize: number

# reset()

reset: () => void

# Returns

void

# setPageNumber()

setPageNumber: (pageNumber) => void

# Parameters

• pageNumber: number

# Returns

void

# setPageSize()

setPageSize: (pageSize) => void

# Parameters

• pageSize: number

# Returns

void

# totalResultCount

totalResultCount: number

# Implementation of

IMemoryProvider.getPaging

# Inherited from

DataProvider.getPaging

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:231

# getParentDataProvider()

getParentDataProvider(): null | IDataProvider

Gets the provider that has been used to create this data provider.

# Returns

null | IDataProvider

# Implementation of

IMemoryProvider.getParentDataProvider

# Inherited from

DataProvider.getParentDataProvider

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:615

# getParentRecordId()

getParentRecordId(): string

Returns the parent record ID, if this data provider is a child of another data provider.

# Returns

string

# Implementation of

IMemoryProvider.getParentRecordId

# Inherited from

DataProvider.getParentRecordId

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:735

# getProperty()

getProperty<K>(name): IDataProviderProperties[K]

Gets the defined property.

# Type Parameters

• K extends keyof IDataProviderProperties

# Parameters

• name: K

# Returns

IDataProviderProperties[K]

# Implementation of

IMemoryProvider.getProperty

# Inherited from

DataProvider.getProperty

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:182

# getQuickFindColumns()

getQuickFindColumns(): IColumn[]

Returns the columns that are used for quick find search.

# Returns

IColumn[]

# Implementation of

IMemoryProvider.getQuickFindColumns

# Inherited from

DataProvider.getQuickFindColumns

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:781

# getRawData()

getRawData(): IRawRecord[]

Returns an array of raw data records.

# Returns

IRawRecord[]

# Implementation of

IMemoryProvider.getRawData

# Inherited from

DataProvider.getRawData

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:176

# getRecordCurrencySymbol()

getRecordCurrencySymbol(record, columnName): string

Retrieves the currency symbol for a specific column in a record.

# Parameters

• record: IRecord

• columnName: string

# Returns

string

# Implementation of

IMemoryProvider.getRecordCurrencySymbol

# Inherited from

DataProvider.getRecordCurrencySymbol

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:311

# getRecordIndex()

getRecordIndex(recordId): number

Returns array index of a record by it's ID. This index corresponds to the record's position in an array that's return by the

# Parameters

• recordId: string

# Returns

number

# Implementation of

IMemoryProvider.getRecordIndex

# Inherited from

DataProvider.getRecordIndex

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:755

# getRecords()

getRecords(): IRecord[]

Returns the list of records.

# Returns

IRecord[]

A list of records.

# Implementation of

IMemoryProvider.getRecords

# Inherited from

DataProvider.getRecords

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:711

# getSearchQuery()

getSearchQuery(): string

Retrieves the search query string.

# Returns

string

# Implementation of

IMemoryProvider.getSearchQuery

# Inherited from

DataProvider.getSearchQuery

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:286

# getSelectedRecordIds()

getSelectedRecordIds(options?): string[]

Returns the currently selected record IDs.

# Parameters

• options?

• options.includeChildrenRecordIds?: boolean

If true, includes record IDs from child data providers. Defaults to true.

• options.includeGroupRecordIds?: boolean

If true, includes group record IDs in the result. Defaults to false.

# Returns

string[]

# Implementation of

IMemoryProvider.getSelectedRecordIds

# Inherited from

DataProvider.getSelectedRecordIds

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:635

# getSortedRecordIds()

getSortedRecordIds(): string[]

Returns the current record IDs sorted by the current sorting criteria.

# Returns

string[]

# Implementation of

IMemoryProvider.getSortedRecordIds

# Inherited from

DataProvider.getSortedRecordIds

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:631

# getSorting()

getSorting(): SortStatus[]

Retrieves the current sorting criteria.

# Returns

SortStatus[]

# Implementation of

IMemoryProvider.getSorting

# Inherited from

DataProvider.getSorting

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:283

# getSummarizationType()

getSummarizationType(): DataProviderSummarizationType

What type of summary operations this provider has applied.

  • none - no summarization is applied
  • aggregation - only aggregation is applied, such as sum, average, etc (no grouping).
  • grouping - grouping is applied, aggregation can be applied as well

# Returns

DataProviderSummarizationType

# Implementation of

IMemoryProvider.getSummarizationType

# Inherited from

DataProvider.getSummarizationType

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:619

# getTitle()

getTitle(): string

Returns the title provided by the data provider.

# Returns

string

# Implementation of

IMemoryProvider.getTitle

# Inherited from

DataProvider.getTitle

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:168

# getTopLevelDataProvider()

getTopLevelDataProvider(): IDataProvider

If called on a nested data provider, returns the top-level data provider that servers as the root ancestor for all nested data providers. I called from a top-level data provider, it returns itself.

# Returns

IDataProvider

# Implementation of

IMemoryProvider.getTopLevelDataProvider

# Inherited from

DataProvider.getTopLevelDataProvider

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:603

# getViewId()

getViewId(): string

Returns the ID of the current view.

# Returns

string

# Implementation of

IMemoryProvider.getViewId

# Inherited from

DataProvider.getViewId

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:160

# isDestroyed()

isDestroyed(): boolean

Whether the data provider has been destroyed.

# Returns

boolean

# Implementation of

IMemoryProvider.isDestroyed

# Inherited from

DataProvider.isDestroyed

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:179

# isDirty()

isDirty(): boolean

Checks if the dataset has unsaved changes.

# Returns

boolean

# Implementation of

IMemoryProvider.isDirty

# Inherited from

DataProvider.isDirty

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:339

# isError()

isError(): boolean

Returns true if an error occurred during the last data retrieval process.

# Returns

boolean

# Implementation of

IMemoryProvider.isError

# Inherited from

DataProvider.isError

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:142

# isLoading()

isLoading(): boolean

Indicates whether the data provider is currently loading.

# Returns

boolean

True if loading, false otherwise.

# Implementation of

IMemoryProvider.isLoading

# Inherited from

DataProvider.isLoading

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:295

# isTopLevelDataProvider()

isTopLevelDataProvider(): boolean

Returns true if the data provider is a top-level data provider (not a child of another data provider).

# Returns

boolean

# Implementation of

IMemoryProvider.isTopLevelDataProvider

# Inherited from

DataProvider.isTopLevelDataProvider

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:611

# isValid()

isValid(): boolean

Whether the provider contains only valid values.

# Returns

boolean

# Implementation of

IMemoryProvider.isValid

# Inherited from

DataProvider.isValid

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:349

# openDatasetItem()

openDatasetItem(entityReference): void

Can be used to specify what default action happens for record opening on a specific provider.

# Parameters

• entityReference: EntityReference

# Returns

void

# Implementation of

IMemoryProvider.openDatasetItem

# Inherited from

DataProvider.openDatasetItem

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:87

# refresh()

refresh(): Promise<IRecord[]>

Refreshes the records list and returns the refreshed records.

# Returns

Promise<IRecord[]>

A promise resolving to a list of refreshed records.

# Implementation of

IMemoryProvider.refresh

# Inherited from

DataProvider.refresh

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:197

# requestRender()

requestRender(): void

Request a render of all components subscribed to the onRenderRequested event.

# Returns

void

# Implementation of

IMemoryProvider.requestRender

# Inherited from

DataProvider.requestRender

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:355

# retrieveRecordCommand()

retrieveRecordCommand(options?): Promise<ICommand[]>

Retrieve record's associated commands. This method should be used to fetch inline ribbon.

# Parameters

• options?: IRetrieveRecordCommandOptions

# Returns

Promise<ICommand[]>

# Implementation of

IMemoryProvider.retrieveRecordCommand

# Inherited from

DataProvider.retrieveRecordCommand

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:359

# save()

save(records?): Promise<IRecordSaveOperationResult[]>

Saves the provided record to the database.

# Parameters

• records?: IRecord[]

The records to save. If not provided, all dirty records will be saved.

# Returns

Promise<IRecordSaveOperationResult[]>

# Implementation of

IMemoryProvider.save

# Inherited from

DataProvider.save

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:382

# setColumns()

setColumns(columns): void

Sets the columns for the dataset.

# Parameters

• columns: IColumn[]

# Returns

void

# Implementation of

IMemoryProvider.setColumns

# Inherited from

DataProvider.setColumns

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:266

# setCurrencies()

setCurrencies(currencies): void

Sets the currencies the dataset can work with.

# Parameters

• currencies: ICurrency[]

# Returns

void

# Implementation of

IMemoryProvider.setCurrencies

# Inherited from

DataProvider.setCurrencies

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:305

# setCustomProperty()

setCustomProperty(name, value): void

Allows you to set custom properties on the data provider. You can use this to store any custom information you need.

# Parameters

• name: string

• value: any

# Returns

void

# Implementation of

IMemoryProvider.setCustomProperty

# Inherited from

DataProvider.setCustomProperty

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:188

# setError()

setError(value, errorMessage?): void

Sets the error state of the provider.

# Parameters

• value: boolean

• errorMessage?: string

# Returns

void

# Implementation of

IMemoryProvider.setError

# Inherited from

DataProvider.setError

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:145

# setFiltering()

setFiltering(filtering): void

Sets the latest filtering information.

# Parameters

• filtering: null | FilterExpression

The filtering criteria, or null if no filter is applied.

# Returns

void

# Implementation of

IMemoryProvider.setFiltering

# Inherited from

DataProvider.setFiltering

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:274

# setLinking()

setLinking(expr): void

Sets the link entity expressions for joining related entities.

# Parameters

• expr: LinkEntityExposedExpression[]

# Returns

void

# Implementation of

IMemoryProvider.setLinking

# Inherited from

DataProvider.setLinking

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:277

# setLoading()

setLoading(value): void

Sets whether the data provider is currently loading.

# Parameters

• value: boolean

# Returns

void

# Implementation of

IMemoryProvider.setLoading

# Inherited from

DataProvider.setLoading

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:298

# setMetadata()

setMetadata(metadata): void

Allows you to change the initial associated entity metadata.

# Parameters

• metadata: any

# Returns

void

# Implementation of

IMemoryProvider.setMetadata

# Inherited from

DataProvider.setMetadata

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:136

# setProperty()

setProperty<K>(name, value): void

Allows settings of additional properties on data provider.

# Type Parameters

• K extends keyof IDataProviderProperties

# Parameters

• name: K

• value: IDataProviderProperties[K]

# Returns

void

# Implementation of

IMemoryProvider.setProperty

# Inherited from

DataProvider.setProperty

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:185

# setSearchQuery()

setSearchQuery(query?): void

Sets a new search query for filtering.

# Parameters

• query?: string

# Returns

void

# Implementation of

IMemoryProvider.setSearchQuery

# Inherited from

DataProvider.setSearchQuery

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:289

# setSelectedRecordIds()

setSelectedRecordIds(ids, options?): void

Sets the currently selected record IDs.

# Parameters

• ids: string[]

• options?

• options.__bubbleUp?: boolean

# Returns

void

# Implementation of

IMemoryProvider.setSelectedRecordIds

# Inherited from

DataProvider.setSelectedRecordIds

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:652

# setSorting()

setSorting(sorting): void

Sets the latest sorting information.

# Parameters

• sorting: SortStatus[]

The latest sorting details as an array of SortStatus objects.

# Returns

void

# Implementation of

IMemoryProvider.setSorting

# Inherited from

DataProvider.setSorting

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:271

# setTitle()

setTitle(title): void

Sets the dataset's title.

# Parameters

• title: string

# Returns

void

# Implementation of

IMemoryProvider.setTitle

# Inherited from

DataProvider.setTitle

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:172

# setViewId()

setViewId(viewId): string

Sets the id of the current view

# Parameters

• viewId: string

# Returns

string

# Implementation of

IMemoryProvider.setViewId

# Inherited from

DataProvider.setViewId

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:164

# toggleSelectedRecordId()

toggleSelectedRecordId(recordId, options?): void

Toggles the selection state of a record ID.

# Parameters

• recordId: string

• options?

• options.clearExisting?: boolean

# Returns

void

# Implementation of

IMemoryProvider.toggleSelectedRecordId

# Inherited from

DataProvider.toggleSelectedRecordId

# Defined in

src/utils/dataset/data-providers/DataProvider.ts:691