DataStore

Core of all operations for data collection-based components

Methods
add adds an item to the store
addMark allows setting custom flag for a data item.
attachEvent attaches the handler to an inner event of the component (allows behavior customizations)
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
changeId changes the id of a data item
clearAll removes all items from the component
clearMark removes mark from all items in store
count returns the number of currently visible items
destructor destroy datastore
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
each iterates through the collection of data items
exists checks whether an item with the specified id exists
filter filters the component
find returns rows that match the criterion
getFirstId returns the ID of the first item
getIdByIndex returns the id of the item with the specified index
getIndexById returns the index of the item with the specified id
getIndexRange gets ids of items in the specified index range
getItem gets the object of the data item with the specified id
getLastId returns the id of the last item
getMark returns mark value by record id and mark name
getNextId returns the ID of an item which is positioned the specified step after the specified item
getPrevId returns the ID of an item which is positioned the specified step before the specified item
getRange gets ids of items in the specified range
hasEvent checks whether the component has the specified event
id gets the id of a data item
importData import data from different datastore
mapEvent routes events from one object to another
move moves the specified item to the new position
provideApi assigns methods (and events) of DataStore to an object
refresh repaints the whole view or a certain item
remove removes the specified item/items from datastore
removeMark removes a flag set for the specified item
scheme sets hash of default values for properties
serialize serializes data to a JSON object
setDriver defines type of used data driver
silent code that you pass here as the parameter will not be affected by 'onStoreUpdated' event handler
sort sorts datastore
sync allows syncing two copies of data (all or just a part of it) from one DataCollection to another
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
unsync breaks "sync" link
updateItem updates the data item with new properties
Events
onAfterAdd fires after adding item to datastore
onAfterDelete fires after item deleting
onAfterFilter fires after DataStore was filtered
onAfterSort fires after sorting dataset
onBeforeAdd fires before adding item to datastore
onBeforeDelete fires before item deleting
onBeforeFilter fires before datatable filtering
onBeforeSort fires before sorting dataset
onClearAll fires after datastore was cleared
onDataUpdate fires when data item is in update process
onIdChange event fires when id of record changed
onParse fires when data is ready to be processed by component
onServerConfig fires when the component loads data containing the config tag (key) inside.
onServerOptions fires when client side api loads sub-collection from server side
onStoreLoad fires after data is loaded from external resource
onStoreUpdated fires after data is changed in datastore
onSyncApply fires the moment sync() method is applied
Properties
on allows attaching custom handlers to inner events of the component
Other
driver defines data driver - methods and properties for data parsing
name indicates the name of the component (a read-only property)
order returns an array of IDs of the displayable items
pull returns the hash of data items (where the key is the item id).
sorting
Back to top