DHTMLX Touch documentation
grid
Methods
Events
Properties
Start
Components
grid
Type: Component
File: ui/grid.js
Based on:
SelectionModel
,
MouseEvents
,
KeyEvents
,
EditAbility
,
RenderStack
,
DataLoader
,
AtomDataLoader
,
touch_view
,
view
,
Settings
,
Destruction
,
EventSystem
,
Settings
Included in:
Methods
attachEvent
- attach custom handler to inner event
block
- stop event calls until unblocking
callEvent
- calls inner event
customize
- applies new type settings
define
- sets configuration property or a hash of properties
destructor
- destructs the object
detachEvent
- detach custom code from handler
edit
- switch item to the edit state
getNode
- gets html object of a view
getParent
- gets a parent view
getSelected
- returns ID of selected item(s)
id
- gets id of data object
isEdit
- returns id of item in edit state, or null if none
isSelected
- checks is item selected or not
load
- loads values from external datasource
locate
- gets the ID of the item which is affected by
HTML
event
mapEvent
- route events from one object to another
parse
- added data from a datasource
render
- renders a current state of an item or the whole component
resize
- recalculates and adjusts view sizes
select
- selects item
selectAll
- selects all items
show
- adjust scroll state to show item in question
stopEdit
- switch any item in edit state, back to normal
unblock
- restore normal event processing
unselect
- unselects item
unselectAll
- unselects all items
add
- adds item to the store
clearAll
- remove all items from the component
dataCount
- gets count of items
each
- iterates through collection
exists
- checks if the item with such ID exists
filter
- filters data
first
- gets the ID of the first item
get
- gets hash with properties of an item
getIndexRange
- converts the range of indexes to array of all IDs between them
getRange
- converts range IDs to array of all IDs between them
id
- gets id of data object
idByIndex
- gets the id of an item with taken index
indexById
- the index of the item in question
last
- gets the id of the last item
move
- moves an item from one position to another
next
- gets ID of the next element which is positioned in defined step
previous
- gets ID of the previous element which is positioned in defined step
provideApi
- assigns methods (and events) of DataStore to an object
refresh
- repaint the whole view or a certain a item
remove
- removes element from datastore
set
- sets the new hash of properties for an item
setDriver
- defines type of used data driver
sort
- sorts datastore
Events
onbeforeselect
- item selection is started
onafterselect
- item was selected
onselectchange
- selection state was changed
onitemclick
- item was clicked
onbeforecontextmenu
- context menu call in the item area
onitemdblclick
- item was double-clicked
onmousemove
- mouse was pointed over item
onmouseout
- mouse was moved out from item
onmousemoving
- mouse was moved over component
onkeypress
- for each key action in default state
oneditkeypress
- for each key action in default state
onbeforeeditstart
- edit operation initiated
onaftereditstart
- edit operation initiated, editor opened and ready for input
onbeforeeditstop
- stop edit command was received
onaftereditstop
- edit operation finished
onbeforerender
- occurs when rendering is starting
onitemrender
- for each item rendering, occurs only for items with custom templates
onafterrender
- after view rendered
onxls
- before xml loading start
onxle
- after xml loading end
Properties
fields
- an array with settings for all columns
header
- shows/hides grid header
select
- Enable|Disable selection
edit
- allow or deny edit operations
type
- type name or an object that defines Type properties
template
- item template
datastore
- custom DataStore object
data
- loaded data
url
- data url
datatype
- type of loaded data
container
- html container or its id where view needs being initialized
id
- view id
css
- class name for view container
width
- view width
height
- view height
gravity
- view gravity (1 by default)