Events

This section describes events raised by this ODataStore instance.

To handle events, use one of the following methods.

inserted

Fires after a data item is added.

Type:

Event

Function parameters:
values:

Object

An object representing the inserted item.

key:

Object

|

String

|

Number

A key value of the inserted item.

To learn how to handle events, refer to the Events and Change Tracking topic.

inserting

Fires before a data item is added.

Type:

Event

Function parameters:
values:

Object

An object representing the item being inserted.

To learn how to handle events, refer to the Events and Change Tracking topic.

loaded

Fires after data is loaded.

Type:

Event

Function parameters:
result:

Array

The loaded data array.

To learn how to handle events, refer to the Events and Change Tracking topic.

loading

Fires before data is loaded.

Type:

Event

Function parameters:
loadOptions:

Object

An object defining options for the loaded data.

Object structure:
filter:

Object

A filter expression for the loaded data.

sort:

Object

A sort expression for the loaded data.

select:

Object

An expression for selection in the loaded data.

group:

Object

An expression for grouping in the loaded data.

skip:

Number

The number of items to skip.

take:

Number

The number of items to take for the loaded data.

userData:

Object

A bag for holding user-defined parameters.

requireTotalCount:

Boolean

Specifies whether or not the load function should resolve the returned Deferred.Promise using the second argument (extra) containing the totalCount field.

searchOperation:

String

A search operation expression.

searchExpr:

getter

|

Array

A getter representing a search expression.

To learn how to handle events, refer to the Events and Change Tracking topic.

modified

Fires after data is modified.

Type:

Event

To learn how to handle events, refer to the Events and Change Tracking topic.

modifying

Fires before the data is modified.

Type:

Event

To learn how to handle events, refer to the Events and Change Tracking topic.

removed

Fires after a data item has been removed.

Type:

Event

Function parameters:
key:

Object

|

String

|

Number

A key value of the removed item.

To learn how to handle events, refer to the Events and Change Tracking topic.

removing

Fires before a data item is removed.

Type:

Event

Function parameters:
key:

Object

|

String

|

Number

A key value of the item being removed.

To learn how to handle events, refer to the Events and Change Tracking topic.

updated

Fires after a data item has been updated.

Type:

Event

Function parameters:
key:

Object

|

String

|

Number

A key value of the updated item.

values:

Object

New values for the updated item.

To learn how to handle events, refer to the Events and Change Tracking topic.

updating

Fires before a data item is updated.

Type:

Event

Function parameters:
key:

Object

|

String

|

Number

A key value of the item being updated.

values:

Object

New values for the item being updated.

To learn how to handle events, refer to the Events and Change Tracking topic.