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
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 all rows that match the criterion, or only the first one
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 that is after the specified item, either directly after or after a number of items (defined by the step)
getPrevId	returns the ID of an item that is before the specified item, either directly before or before a number of items (defined by the step)
getRange	gets ids of items in the specified range
hasEvent	checks whether the component has the specified event handler
id	gets the id of a data item
importData	import data from a different datastore
mapEvent	routes events from one object to another
move	moves the specified item to a 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 object with default values for properties
serialize	serializes data to an array of JSON objects
setDriver	defines type of used data driver
silent	cancels refreshing for operations, passed as the parameter
sort	sorts datastore
sync	allows syncing two copies of data (all or just a part of it) from one DataCollection to another
unblockEvent	cancels events blocking that was enabled by the 'blockEvent' command
unsync	breaks "sync" link
updateItem	updates the data item with new properties

Events

onAfterAdd	fires after adding an item to the datastore
onAfterDelete	fires after an item is removed
onAfterFilter	fires after DataStore was filtered
onAfterSort	fires after sorting dataset
onBeforeAdd	fires before adding an item to the datastore
onBeforeDelete	fires before an item is removed
onBeforeFilter	fires before component filtering
onBeforeSort	fires before sorting of the dataset
onClearAll	fires after datastore was cleared
onDataUpdate	fires when a data item is being updated
onIdChange	the event fires when the ID of a record is changed
onParse	fires when data are ready to be processed by the component
onServerConfig	fires when the component loads data that contain the config tag (key)
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 object with data items (where the key is the item id).
sorting	the object that controls sorting