DevExtreme Angular - ArrayStore Properties

This section describes properties that configure the ArrayStore.

data

Specifies the store's associated array.

Type:

Array<any>

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • data: [
  • { id: 1, name: "John Doe" },
  • // ...
  • ]
  • })
  • }
  • }

errorHandler

Specifies the function that is executed when the store throws an error.

Type:

Function

This function accepts a JavaScript Error object as the parameter.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • // ...
  • errorHandler: function (error) {
  • console.log(error.message);
  • }
  • })
  • }
  • }

key

Specifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique.

Type:

String

|

Array<String>

In the following example, the ProductID and ProductCode properties are specified as key properties:

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • // ...
  • key: ["ProductID", "ProductCode"]
  • })
  • }
  • }

onInserted

A function that is executed after a data item is added to the store.

Type:

Function

Function parameters:
values:

Object

The added data item.

key:

Object

|

String

|

Number

The item's key.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onInserted: function (values, key) {
  • // Your code goes here
  • }
  • })
  • }
  • }

onInserting

A function that is executed before a data item is added to the store.

Type:

Function

Function parameters:
values:

Object

The data item to be added.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onInserting: function (values) {
  • // Your code goes here
  • }
  • })
  • }
  • }

onLoaded

A function that is executed after data is loaded to the store.

Type:

Function

Function parameters:
result:

Array<any>

The loaded data.

loadOptions:

LoadOptions

Data processing settings.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onLoaded: function (result) {
  • // Your code goes here
  • }
  • })
  • }
  • }

onLoading

A function that is executed before data is loaded to the store.

Type:

Function

Function parameters:
loadOptions:

LoadOptions

Data processing settings.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onLoading: function (loadOptions) {
  • // Your code goes here
  • }
  • })
  • }
  • }

onModified

A function that is executed after a data item is added, updated, or removed from the store.

Type:

Function

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onModified: function () {
  • // Your code goes here
  • }
  • })
  • }
  • }

onModifying

A function that is executed before a data item is added, updated, or removed from the store.

Type:

Function

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onModifying: function () {
  • // Your code goes here
  • }
  • })
  • }
  • }

onPush

The function executed before changes are pushed to the store.

Type:

Function

Function parameters:
changes:

Array<any>

Changes passed in the push(changes) method.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onPush: (changes) => {
  • // Your code goes here
  • }
  • })
  • }
  • }

onRemoved

A function that is executed after a data item is removed from the store.

Type:

Function

Function parameters:
key:

Object

|

String

|

Number

The removed data item's key.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onRemoved: function (key) {
  • // Your code goes here
  • }
  • })
  • }
  • }

onRemoving

A function that is executed before a data item is removed from the store.

Type:

Function

Function parameters:
key:

Object

|

String

|

Number

The key of the data item to be removed.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onRemoving: function (key) {
  • // Your code goes here
  • }
  • })
  • }
  • }

onUpdated

A function that is executed after a data item is updated in the store.

Type:

Function

Function parameters:
key:

Object

|

String

|

Number

The updated data item's key.

values:

Object

Updated values.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onUpdated: function (key, values) {
  • // Your code goes here
  • }
  • })
  • }
  • }

onUpdating

A function that is executed before a data item is updated in the store.

Type:

Function

Function parameters:
key:

Object

|

String

|

Number

The key of the data item to be updated.

values:

Object

New values for the data item fields.

TypeScript
  • import ArrayStore from "devextreme/data/array_store";
  • // ...
  • export class AppComponent {
  • store: ArrayStore;
  • constructor() {
  • this.store = new ArrayStore({
  • onUpdating: function (key, values) {
  • // Your code goes here
  • }
  • })
  • }
  • }