Buy
Try it free
Changes log (txt file) Using custom CSS from 13.3 to 14.0 Upgrading from 9.3 to 10.0 Upgrading from 5.9 to 6.0
Angular React Vue Other frameworks NodeJS server
Simple examples Basic information Creating grid Deleting grid Reloading grid Rendering grid Accessing grid by API
Communication types AJAX communication AJAX SOAP envelope Submit communication Directly included data Data from JavaScript Cross domain / local load by JSONP Sessions (AJAX) Server response (AJAX) Synchronous communication (AJAX) Caching (AJAX) API (AJAX)
Settings for data download Layout XML structure Data XML structure
Settings for data upload API for upload XML structure sent to server
XML structure of download changes XML structure of request for a cell Synchronizing data with server
Complete list of tags Internal XML format Short XML format Extra short XML format DTD XML format JSON format
Cell type Cell format Dynamic format Dynamic type Cell value Reading / writing attributes by API Cell HTML Cell default Range or more values in one cell Cell with link URL Cell hint Cell tooltip / title Cell popup menu
Cell editability Dynamic editing Locking Defaults list Suggest list (auto complete) Tags input Changing cell value Mass cell change Clearing cells Editing cells Controlling <input> tag by JavaScript Input validation and restrictions Side checkbox Cell selecting
Basics Formulas Mathematical functions Aggregate functions Special functions for actions Custom functions
Basics Suggest list (auto complete) Defined names Actions for choosing cells Conditional functions Lookup functions Cell reference functions Logical functions Informational functions Mathematical functions Trigonometry functions Rounding numbers Number conversions String functions Date functions Summary functions Custom functions
Introduction Right side Button Left side Icon
Column span Row span Dynamic spanning
Basic grid style Sizing and scaling - responsive design Dynamic cell style attributes Cell CSS class Cell background color Dynamic cell border Cell HTML style Row color alteration Cell mouse cursor
Format Calendar component Dates dialog Localization
Introduction Definition Related lists Enum specific Radio specific
Checkbox - BoolIntroduction Basic clickable button Switch button Radio / tab button Menu button Combo switch button Combo radio / tab button Special Space rows with buttons
Definition Standard fast panel Custom panel
Html type EHtml type (editable) Icon type Abs type List type Editable Link type Editable Img type DropCols type Upload File type
Column basics Column index Column visibility Column visibility menu Column selecting Column tree Auto column tree Column position and moving Column adding and copying Column deleting Column width Column API
Rows by functionality Rows by position Row name Row id Row index
Description Example of default rows Example of changing default row Attributes
Tree attributes Actions & API for expand / collapse
Setting row id attribute Row id attribute in tree Row id created from cell values API for row ids
Row visibilityFive ways of adding rows to grid Adding and copying restrictions Adding new empty rows Copying existing rows
Row deleting Row moving and dragging Row selecting Row height Row API Space rowsSort settings Controlling sort position Comparing strings Sorting actions Sorting API
Group settings Creating groups Comparing strings Created group rows <D Group='1'/> User interface to choose grouping Grouping actions and API
Filter settings Comparing strings User interface to choose filter Filter actions and API
Search settings User interface for search Search actions and API
Print settings Choosing items to print Page size Print API
Introduction Client side settings Printing options Client side API Server side API Data sent from client to server
Introduction and export types Basic settings Styling export XLSX export Gantt export CSV export Old XLS / XHTML export Export API Communication with server Client export Server export
Basic settings Sheets manipulation
Copy & paste permissions Copying to clipboard Pasting from clipboard
Introduction External master - detail grids Nested master - detail grids Synchronizing grids Other attributes for master - detail
Pivot attributes & API Pivot formulas
External objects (like Adobe Flash) Undo & RedoGantt objects list Display settings Edit settings
Definition of main bar and plans Main bar as Task Edit settings Main bar content and side html Tip on mouse hover Vertical position and height Style specific attributes API to manipulate Main bars Actions Side text (deprecated) Real Flow (deprecated)
GanttRun Definition Extended definition Run bar as Task Edit settings Save format Selecting Run boxes Run box content and side html Tip on mouse hover Box identification Vertical position and height Style specific attributes Overlaid (Error) boxes Containers for more boxes Dragging - moving and resizing API to manipulate Run boxes Actions Run special formulas
Main for Main Main for Run Editable Main Editable Run
Flag - icon with text Point - math points
Header - column captions Cell and column Background Vertical movable Line Mark & Progress line
Zoom options Chart size limits Zoom selection Paging in Gantt chart
Introduction Data units Defining dependencies Dependency colors and shapes Changing dependencies Correcting dependencies Scheduling algorithm Project date constraints Task date constraints Critical path - Slack (Float)
Global base calendar Local calendar Calendar list Calendars dialog Other settings
Resources list Resources assign Resources filter Resources calculations Availability chart Resource usage chart Generated resource usage chart
Gantt popup menu Gantt APICharts in grid cells Chart JSON definition Base chart settings Basic attributes Size Axis and caption Individual chart lines Data sources Visual settings API for standalone usage
Paging types and attributes Auto adding root pages API for paging
Side pager Side pager type Pages Side pager type Gantt Side pager type Custom Pager with navigation buttons & edit Pager as list of page indexes
ChildPaging - load / render on expand MaxChildren - limit children count ChildParts - load / render on scroll
Paging types and attributes Auto adding column pages API for column paging
Server paging for root rows Server communication in root paging Root paging in very large tables Server paging in tree Server communication in tree paging XML Request for Data in root paging XML Download Data in root paging XML Request for root Page / children XML Download root Page / children API for server paging
Introduction Compatibility with TreeGrid control Using TreeGrid server DLL/SO ASP.NET C# ASP.NET VB PHP JSP Java TreeGrid server concepts Function reference Calculations
Base attributes Visual settings Key navigation Behavior Size and scroll
Base attributes Clickable item Inactive caption Collapsible sub level Popup sub menu Columns Bool item Enum item Edit item
Show custom menu Custom menu position Custom menu advanced settings Custom menu JavaScript events Custom menu JavaScript methods
Calendar dialog Custom calendar & JavaScript events Custom dialog in JavaScriptDefault behavior Maximize grid height and width Update size according to the content Let a user to control the grid size Widths of individual sections Other scrolling attributes and API
Media rules - responsive designLanguage & regional setup (Text.xml) Translate texts dynamically Change language
Focused cell and row Focused cell range Move and copy focused cells Filling cell values by dragging Tabulator navigation Key navigation Cursor look - focus & hover
Selecting base Selecting rows Selecting cells Selecting columns
Status messages Configuration menus Configuration menu - options Configuration menu - columns Configuration menu - print / PDF Configuration menu - export Default toolbar Useful API function Help file
Animations base Row animations Column animations Cell animations Animations for undo / redo Animations for server side changes Dialog animations
Grid configuration in cookiesList of event handler types TreeGrid mouse events Mouse event names Key and mouse button prefixes Touch event names Event targets Assigning event actions / callbacks Event action parameters Action name suffix Calling actions from JavaScript Creating custom actions Focused vs. Actual cell TreeGrid key events JavaScript API events
Mouse API event TreeGrid filesTreeGrid documentation glossary
Here is full online documentation for TreeGrid, Gantt chart and SpreadSheet.
Choose desired document in left side tree or find it in documentation search.
In this documentation glossary is described how to use the documentation.
| 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'/>. |
| 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. |
| 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. |
| 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)"/> |
| 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. |
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). |
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.| <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 | |||
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 |
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.| 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 |
TreeGrid
Gantt chart