TreeGrid documentation

TreeGrid documentation glossary

Documentation items

XML or JSON attribute definition. The XML and JSON formats have the same attributes and tags/objects.

version	TreeGrid version(s) where the attribute was changed. See the versions.
tag	A list of XML tags or JSON object where the attribute can be used. See all possible tags. The most of XML/JSON attributes can be accessed also by JavaScript API, it is also described in the tag list.
type	Informational attribute type according to the attribute meaning. See all possible types. In XML all attributes are strings, in JSON the values can be number or strings regardless on this type. In JavaScript API the property type is integer or string according to the value itself, not according to this type.
default value	Initial attribute value. The default values are preset usually in Defaults.xml, but some of them are also set directly in TreeGrid code. If the default value is not defined, the item has initially null or 0 or empty string according to its type.
specialty	Information that the attribute is saved to and loaded from cookies (therefore can be ignored in XML/JSON data) and information how to avoid it. Or information that the attribute is uploaded to server. Or information that the attribute can be undone (supports Undo), when set <Cfg Undo='1'/>.

JavaScript API method, API event or API variable definition.
All these API items are part of Extended API. The Extended API is not included in any component license and must be purchased apart!

version	TreeGrid version(s) where the attribute was changed. See the versions.
object	JavaScript object this item belongs to as its property or method. See all possible objects.
type	Informational property or function return type according to the item meaning. The real JavaScript type can be different. See all possible types.
parameters	Are shown for JavaScript functions. Note, the parameter types and names are just informational, the only exact thing is the parameters order.
read only	Is listed for API variable that should not be changed.

JavaScript action. It can be attached to any XML/JSON mouse or key event, usually in <Actions> tag.
Many actions are attached by default to some event in <Actions> tag in Defaults.xml, e.g. <Actions OnClickButtonSave="Validate AND Save"/>
The action can be called also from JavaScript as API method of grid object, named with Action prefix, e.g. Grids[0].ActionSave ( ); for action named Save.

version	TreeGrid version(s) where the attribute was changed. See the versions.
attached to	Information where the action is attached by default (in Defaults.xml) and restrictions to which events can be attached.
...FSARCWO	It means that there are more available action names, with suffixes from all combinations of listed letters. See the Action name suffix chapter.

XML/JSON mouse or key event.
The XML/JSON event handler code you write directly to the XML/JSON data (oposite to JavaScript API event written in JavaScript code).
In documentation there are listed only events special for described features.
All standard XML/JSON mouse and key events are described in Mouse events and Key events.

version	TreeGrid version(s) where the attribute was changed. See the versions.
parameters	The XML/JSON mouse or key event has always these parameters: (TGrid Grid, TRow Row, TCol Col, TEvent Event); where Row, Col is cell under mouse for mouse event or focused cell for key event. The Grid, Row, Col and Event variables can be used in the event handler code as JavaScript objects; e.g. <Actions OnClickCell="alert('clicked cell '+Row.id+','+Col)"/>

Formula that can be used in Formula attribute code, e.g. <I RFormula="sum()"/>.

version	TreeGrid version(s) where the attribute was changed. See the versions.
parameters	Are shown as for JavaScript function. Note, the parameters types and names are just informational, the only exact thing is the parameters order.

Any of the above listed items that is deleted and should be no longer used.
The most of deleted items are still present and usable in TreeGrid, they are only deprecated.

Version

Last update done to the item

new 10.0	Item was released in the given version (the item did not exist in previous versions).
chg 10.0	Major update to item was done in the given version (the usage of the item was changed).
upd 10.0	Minor update to item was done in the given version (like new parameter added to function or new value added to bit array or flags).
renamed 10.0	The item has been renamed in the given version (the old name is usually still usable, but deprecated).
deleted 10.0	The item has been removed since the given version (the item name is usually still usable, but deprecated).

Tag

Where the XML / JSON attribute can be used

There can be listed more places like <C> <cell> - item is an attribute of column or cell.
For <C><I><cell> or <I><C><cell> the attribute is read from cell, next if null from column and next if null from row; except it is stated different order in the attribute description.
For JSON format the tag names are the same, just with different syntax.

<treegrid,bdo>	Basic TreeGrid definition on HTML page, defines TreeGrid data sources. It can be used <treegrid> or <bdo> tag.
<Cfg>	XML attribute of tag <Cfg>	basic grid configuration
<C>	XML attribute of tag <C>	whole column settings
<C Panel>	XML attribute of tag <C> or <Panel>	whole column settings for column type Panel
<B>	XML attribute of tag <B>	settings of page
<Root>	XML attribute of tag <Root>	row setting of virtual root row as parent of all first level rows
<D>	XML attribute of tag <D>	row or column setting of default row or column
<I>	XML attribute of tag <I>	row setting of normal row within columns (Data, Header, Filter)
<Header>	XML attribute of tag <I> or <Header>	setting of Header row
<Filter>	XML attribute of tag <I> or <Filter>	setting of Filter row
<Space>	XML attribute of tag <I> or <Space>	setting of any Space row (row kinds Space, Group, Search, Toolbar)
<Group>	XML attribute of tag <I>, <Space> or <Group>		row settings special for grouping
<Search>	XML attribute of tag <I>, <Space> or <Search>		row settings special for searching
<Toolbar>	XML attribute of tag <I>, <Space> or <Toolbar>		settings of Toolbar row
<cell>	XML attribute postfix of tag <I>	setting of any row cell, set with column name as prefix (e.g <I Col1Visible=’0’/>)
<I cell>	XML attribute postfix of tag <I>	setting of any non Space cell (row kinds Data, Header, Filter)
<Header cell>	XML attribute postfix of tag <I> or <Header>		setting of Header cell
<Filter cell>	XML attribute postfix of tag <I> or <Filter>		setting of Filter cell
<Space cell>	XML attribute postfix of tag <I> or <Space>		setting of any Space cell (row kinds Space, Group, Search, Toolbar)
<Group cell>	XML attribute postfix of tag <I>, <Space> or <Group>			special setting of cell for grouping
<Search cell>	XML attribute postfix of tag <I>, <Space> or <Search>			special setting of cell for searching
<Pager>	XML attribute of tag <Pager>	side pager settings
<IO>	XML attribute of tag <IO>	data communication, settings of individual data request or response
<Changes>	XML attribute of tag <Changes>	downloaded changes from server
<P>	XML attribute of tag <P>	definition of attributes in XML short and extra short format
<Resources>	XML tag as child of tag <Resources>	a list of Gantt resources
<R>	XML attribute of tag <R>	an individual Gantt resource
<Zoom>	XML tag as child of tag <Zoom>	a list of Gantt zoom levels
<Z>	XML attribute of tag <Z>	an individual Gantt zoom level
<Calendars>	XML tag as child of tag <Calendars>	a list of Gantt calendars
<E>	XML attribute of tag <E>	an individual Gantt calendar
<Lang>	XML tag as child of tag <Lang>	language dependent settings
<Format>	XML attribute of tag <Format>	language dependent settings for numbers and dates, <Lang> <Format /> </Lang>
<MenuCfg>	XML attribute of tag <MenuCfg>	settings of configuration menu dialog
<HTML tag>	HTML tag	a tag used in HTML, the <bdo> tags <treegrid> tags

Object

Owner objects of JavaScript API items

API variable	JavaScript property of grid (TGrid object)
API method	JavaScript method of grid (TGrid object)
API event	JavaScript method of global Grids array called as callback for defined event (like event handler) This method is defined by you in your code and called by TreeGrid from its code! For example define: Grids.OnClick = function(G,row,col,x,y){ alert("clicked "+row.id+","+col); }
API TCol var.	JavaScript property of column (TCol object), the object is accessible by grid.Cols array
API TRow var.	JavaScript property of row (TRow object)
global func.	JavaScript global function (a method of window object)
global prop.	JavaScript global property (a property of Grids object)
global variable	JavaScript global variable (a property of window object)
TCalendar	JavaScript property, method or event of TCalendar object - JSON calendar dialog
TDialog	JavaScript property, method or event of TDialog object - JSON dialog
TMenu	JavaScript property, method or event of TMenu object - JSON menu
TMenuItem	JavaScript property, method or event of TMenuItem object - one menu item in JSON menu
TEdit	JavaScript property, method or event of TEdit object - JSON edit input
TPosition	JavaScript property, method or event of TPosition object - position of JSON dialog or menu
TLineChart	JavaScript property, method or event of TLineChart object - Line chart object
TChartLine	JavaScript property, method or event of TChartLine object - one line in Line chart object

Type

Standard (like C++) item type, not JavaScript type

The type is not JavaScript variable type, but it is similar to standard type in languages like C++, C# or Java.
The type is shown only in documentation, it is used nowhere in XML, JSON or JavaScript. The sense of the type in XML / JSON is to more precisely define what is expected to get in the item, it has not any other special meaning.

void	In API: method does not return value or event does not expect return value
bool	In XML: 0 or 1 (not true or false)
	In API: any expression that can be converted to true or false
int	Integer value, in API it should be Number type
	It can be also bit array – every bit in the number has its own meaning and the value is sum of the bits (1.bit=1, 2. bit=2, 3.bit=4, 4.bit=8, 5.bit=16, 6.bit=32, 7.bit=64, 8.bit=128, 9.bit=256, ...) Examples of bit array: to set first, third and sixth bit set 1+4+32 = 37, to set second, third, fifth and tenth bit set 2+4+16+512 = 534
string	String value, in API it should be String type
string[ ]	In XML: one string with individual items separated with comma: "One,Two,Three" In API: array of strings
string[*]	In XML: one string with individual items separated by first character in the string – the string starts with the separator: "|One|Two|Three" The separator can be any Unicode character not included in any of the separated items
string[ ][ ]	In API: two dimensional array of strings
TCol	In API: column object (not name)
TRow	In API: row object
TGrid	In API: grid object, all API events get it as the first parameter