News in version
TreeGrid Gantt chart SpreadSheet Examples Documentation Download Development Licensing Prices References Contacts Buy Try it free
Documentation
Search in documentation
TreeGrid versions compatibility

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

Using in JavaScript frameworks

Angular React Vue Other frameworks NodeJS server

Creating grid

Simple examples Basic information Creating grid Deleting grid Reloading grid Rendering grid Accessing grid by API

Data & communication
Data communication with server

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)

Download data

Settings for data download Layout XML structure Data XML structure

Upload data

Settings for data upload API for upload XML structure sent to server

Changing data from server

XML structure of download changes XML structure of request for a cell Synchronizing data with server

Input / output data formats

Complete list of tags Internal XML format Short XML format Extra short XML format DTD XML format JSON format

Cells
Cell basics

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 editing and changing values

Cell editability Dynamic editing Locking Defaults list Suggest list (auto complete) Changing cell value Mass cell change Clearing cells Editing cells Controlling <input> tag by JavaScript Input validation and restrictions Side checkbox Cell selecting

Calculations - cell formulas

Basics Formulas Mathematical functions Aggregate functions Special functions for actions Custom functions

Calculations - editable cell formulas

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

Cell side buttons

Introduction Right side Button Left side Icon

Cell spanning

Column span Row span Dynamic spanning

Cell style and color

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

Editable cell images

Insert image Edit image

Cell types
Automatic type - Auto String - Text, Lines & Pass
Number - Int & Float

Format Localization

Date and time - Date

Format Calendar component Dates dialog Localization

List & combo - Enum & Radio

Introduction Definition Related lists Enum specific Radio specific

Checkbox - Bool
Action button - Button

Introduction Basic clickable button Switch button Radio / tab button Menu button Combo switch button Combo radio / tab button Special Space rows with buttons

Panel with more buttons - Panel

Definition Standard fast panel Custom panel

HTML and special types

Html type EHtml type (editable) Icon type Abs type List type Editable Link type Editable Img type DropCols type Upload File type

Columns

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
Row basics

Rows by functionality Rows by position Row name Row id Row index

Default rows

Description Example of default rows Example of changing default row Attributes

Row tree

Tree attributes Actions & API for expand / collapse

Row identification

Setting row id attribute Row id attribute in tree Row id created from cell values API for row ids

Row visibility
Row adding and copying

Five 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 rows
Features
Sorting rows

Sort settings Controlling sort position Comparing strings Sorting actions Sorting API

Grouping rows to tree

Group settings Creating groups Comparing strings Created group rows <D Group='1'/> User interface to choose grouping Grouping actions and API

Filtering rows

Filter settings Comparing strings User interface to choose filter Filter actions and API

Searching in rows and cells

Search settings User interface for search Search actions and API

Printing grid

Print settings Choosing items to print Page size Print API

Print / export to PDF

Introduction Client side settings Printing options Client side API Server side API Data sent from client to server

Export to Excel or CSV

Introduction and export types Basic settings Styling export XLSX export CSV export Old XLS / XHTML export Export API Communication with server Client export Server export

Import from Excel

Basic settings Sheets manipulation

Copy & paste rows via clipboard

Copy & paste permissions Copying to clipboard Pasting from clipboard

Master - detail grids

Introduction External master - detail grids Nested master - detail grids Synchronizing grids Other attributes for master - detail

Pivot tables

Pivot attributes & API Pivot formulas

External objects (like Adobe Flash) Undo & Redo
Gantt and bar chart
Gantt objects

Gantt objects list Display settings Edit settings

Main bar

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)

Run bar

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

Summary task

Main for Main Main for Run Editable Main Editable Run

Gantt icons - Flag & Point

Flag - icon with text Point - math points

Gantt display objects

Header - column captions Cell and column Background Vertical movable Line Mark & Progress line

Gantt zoom

Zoom options Chart size limits Zoom selection Paging in Gantt chart

Dependency, constraints & schedule

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)

Gantt calendars

Global base calendar Local calendar Calendar list Calendars dialog Other settings

Gantt resources

Resources list Resources assign Resources filter Resources calculations Availability chart Resource usage chart Generated resource usage chart

Gantt popup menu Gantt API
Line and XY points charts

Charts 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 in large grids
Paging root rows

Paging types and attributes Auto adding root pages API for paging

Pager components

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

Paging in tree

ChildPaging - load / render on expand MaxChildren - limit children count ChildParts - load / render on scroll

Paging columns

Paging types and attributes Auto adding column pages API for column paging

Server 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

TreeGrid DLL/SO 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

JSON menus and dialogs
JSON menu description JSON menu definition example
Menu settings

Base attributes Visual settings Key navigation Behavior Size and scroll

Menu item settings

Base attributes Clickable item Inactive caption Collapsible sub level Popup sub menu Columns Bool item Enum item Edit item

Custom menu in JavaScript

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 JavaScript
Global grid settings
Grid size and scroll

Default 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 design
Languages

Language & regional setup (Text.xml) Translate texts dynamically Change language

Grid cursor - Focus & hover

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 rows, cells and columns

Selecting base Selecting rows Selecting cells Selecting columns

Global settings

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

Animations base Row animations Column animations Cell animations Animations for undo / redo Animations for server side changes Dialog animations

Grid configuration in cookies
Mouse & key events & actions

List 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 files
Debugging and testing

Debug window Automated testing

Column tree

TreeGrid documentation

Since 7.0 version TreeGrid supports tree also in columns, it means hiding and showing individual columns on click to expand / collapse button in some cell (usually header cell).
Similarly it supports also showing and hiding individual rows (usually, but not required, fixed rows) on click to Expand button.
The collapsed / expanded columns or rows do not need to be adjacent!
The tree level count is not limited!
<C> bool

Visible

[1] Saved to cookies, avoid it by <C VisibleLap='1'/>
If the column is displayed in grid. Set <C Visible='0' Hidden='1'/> for collapsed columns on start.
new 6.0 <C> bool

Hidden

[0]
Hidden='1' can be set only for Visible='0' and <Cfg FastColumns ='1'/>. This column will be rendered as hidden (width 0px).
It slows down rendering grid (the column is rendered) but speeds up showing / expanding the column (it is just resized).
Set <C Visible='0' Hidden='1'/> for collapsed columns on start.
new 6.0 upd 15.0 <Cfg> int

FastColumns

[1]
If column hiding is done by setting its width to 0px. This action is faster than removing the cells and speeds up also showing the column.
For expanding / collapsing columns is strongly recommended to use default setting FastColumns='1'.
Since 15.0 it can be set to 2 for xlsx import to not render hidden columns on start except they are in tree.
<I> bool

Visible

[1] Saved to cookies, avoid it by <Cfg ExpandedLap='1'/>
If the row is displayed in grid. Set to 0 for collapsed rows on start.
new 7.0 <C> <cell> string

Button

Button = "Expand"
To show right side Expand button set Button="Expand".
It is shown usually in <Header> cell to show / hide columns, but can be shown in any cell, in variable, fixed or space cell.
new 7.0 <C> <cell> string

Icon

Icon = "Expand"
To show left side Expand button set Icon="Expand".
It is shown usually in <Header> cell to show / hide columns, but can be shown in any cell, in variable, fixed or space cell.
new 15.0 <C> <cell> string

ExpandCol

Name of main column that collapses / expands the cells. Useful for reversed tree with spanned cells.
For example <I Spanned='1' ASpan='3' AButton='Expand' AExpandCol='C' CExpandCells='A,B'/>.
new 7.0 <C> <cell> string[ ]

ExpandCols

A list of column names to show / hide them on click to Button='Expand'.
If you want to have deep tree of expanding columns (more nested levels) you must list here only immediate children, not the whole tree. And set appropriate ExpandLevel to the columns.
new 7.0 upd 9.3 <C> <cell> string[ ]

ExpandRows

A list of row ids to show / hide them on click to Button='Expand'
Since 9.3 the item can be also a Name of default row to represent all rows with this default.
new 7.0 <C> <cell> bool

Expanded

[ ] Saved to cookies, avoid it by <Cfg ExpandedLap='1'/>
Initial state of the Button='Expand'.
If not set, the state is 1 if any column in the ExpandCols is visible. If ExpandCols is not defined it tests ExpandRows.
If neither ExpandCols nor ExpandRows defined returns state of row Expanded attribute.
Set it for more complex tree where the Expanded state is computed incorrectly.
new 7.0 <C> <I> int

ExpandLevel

[ ] Saved to cookies, avoid it by <C VisibleLap='1'/> or <Cfg ExpandedLap='1'/> for rows
The row / column is shown on click to Expand Button when its ExpandLevel is positive (>=1). It is hidden if its ExpandLevel is zero or negative (<=0).
Use it when more Expand Buttons show / hide one row / column.
If not set, every Expand Button shows / hides the row / column on its click.
If set, click to Expand Button will increase (when expanding) / decrease (when collapsing) this value and only if the value changes from 0 to 1 (shows the column / row) or from 1 to 0 (hides the column / row).
The ExpandLevel must be set accordingly to the row / column Visible attribute and also Expanded state of the Expand Buttons that control the row.
Let's say there are three collapsed buttons that control the row. Setting ExpandLevel='-2' means that all three buttons must be expanded to show the row. Setting ExpandLevel='0' means that every button shows the row and all three buttons must be collapsed to hide it. The row attribute Visible must be set to '0'.
Let's say there are three expanded buttons that control the row. Setting ExpandLevel='1' means that all three buttons must be expanded to show the row. Setting ExpandLevel='3' means that every button shows the row and all three buttons must be collapsed to hide it. The row attribute Visible must be set to '1'.
new 9.2 <I> bool

CollapseOther

[0]
If set to 1, it collapses all other cells in this row when some cells is being expanded.
new 9.0 <C> <cell> bool

HideParentCol

[0]
If set to 1, it hides parent column when expanding it = shows the children instead of the parent column and vice versa.
In this case the cell with expand button should be spanned through the child columns to be still visible after the parent column hides.
If used more column levels, they should have set ExpandLevel to correctly hide / collapse the columns.
new 15.0 <C> <I> <cell> bool

ExpandIcon

[0]
Icon type used for Button / Icon = "Expand", bit array.
1. bit &1 - 0 normal direction, 1 - reversed direction (of tree or column tree). Has sense only if the icon has direction, not for + / - icons.
2. bit &2 - 0 without tree lines, 2 - with tree lines. Tree lines implemented only for column tree in responsive css styles.
3. bit &4 - 0 row tree, used to expand rows, 4 - column tree, used to expand columns. Has sense only if the icon has direction, not for + / - icons.
new 9.2 <cell> bool

ShowHiddenBorder

[1]
Set to 1 in the spanned expand / collapse cell when set HideParentCol=1 and FastColumns=1 to not hide the cell border when the column is hidden.
new 7.0 API method bool

IsCellExpanded

(TRow row, string col)
Returns true if the cell side Button Expand is expanded.
new 7.0 API method void

ExpandCell

(TRow row, string col)
Expands or collapses the rows / columns defined by ExpandCols / ExpandRows in the cell.
new 7.0 <Actions>

ExpandCell ...FAO

Assigned to event OnClickSideExpand
Expands or collapses the rows / columns defined by ExpandCols / ExpandRows in actual or focused cell.
new 12.0 <Actions>

ExpandCol ...FAO

Not assigned to any event
Expands columns defined by ExpandCols in actual or focused cell.
new 12.0 <Actions>

CollapseCol ...FAO

Not assigned to any event
Collapses columns defined by ExpandCols in actual or focused cell.
new 12.0 <Actions>

ExpandRow ...FAO

Not assigned to any event
Expands rows defined by ExpandRows in actual or focused cell.
new 12.0 <Actions>

CollapseRow ...FAO

Not assigned to any event
Collapses rowss defined by ExpandRows in actual or focused cell.
new 7.0 <Actions>

ExpandAllCells

not assigned to any event
Expands all cells in all Header rows in grid.
To expand cells in other rows use API IsCellExpanded / ExpandCell in loop instead.
new 7.0 <Actions>

CollapseAllCells

not assigned to any event
Collapsed all cells in all Header rows in grid.
To collapse cells in other rows use API IsCellExpanded / ExpandCell in loop instead.
new 9.2 <Actions>

ExpandRowCells

not assigned to any event
Expands all cells in actual Header row.
new 9.2 <Actions>

CollapseRowCells

not assigned to any event
Collapsed all cells in actual Header row.
new 15.0 API method bool

ShowColTreeLevel

(TRow row)
Collapses all cells in the row and in next fixed rows. And expands all cells in all fixed rows above the row.
Returns true if some change was done.

new 15.0 <Actions>

ShowColTreeLevel ...FA

Attached to event OnClickSideLevel
Expands / collapses grid after click to Level button.

Auto column tree

Creating and maintaining column tree automatically according to the column level.

The column tree is placed above the first header by default, to place it somewhere else, add <I Def='ColTree'/> to the position in <Head> or <Foot> section.
new 15.0 <Cfg> int

ColTree

[0] Saved to cookies, avoid it by <Cfg ColTreeLap='1'/>
If the auto column tree is shown and if it is reversed.
0 - disabled and cannot be shown or changed. It is not saved and exported.
1 - disabled and can be shown. It is not saved and exported.
2 - hidden. It is saved and exported. It is exported as hidden in xlsx.
3 - shown. Parents (summaries) are shown on left side like in normal tree.
4 - shown. Parents (summaries) are shown on right side like in default MS Excel tree.
new 15.0 API method void

SetColTree

(int value)
Changes ColTree to given value and updates the view.
new 15.0 <Cfg> int

ColTreeLast

[1]
If the auto column tree shows last empty row to display Levels button.
new 15.0 <Cfg> int

MaxColLevel

[10]
Maximal level in column tree.
Should be set to reasonable count, to avoid too high head section that displays one row per column tree level.
new 15.0 <C> int

Level

Column level in automatic column tree. 0 means root level.
The Level is automatically updated after indenting or outdenting column.
The Level is automatically decreased if it is higher than previous column Level by 2 or more.
If the next columns have higher level than this column, they are shown as child columns.
If the next child columns are all hidden, this column is marked as collapsed.
new 15.0 <Actions>

IndentCols ...FSARCO

Not attached to any event
Indents actual, focused or selected columns. It increases column Level by 1. It fails if the column level cannot be increased without affecting other columns.
new 15.0 <Actions>

IndentColsForce ...FSARCO

Not attached to any event
Indents actual, focused or selected columns. It increases column Level by 1. It indents also adjacent columns if required.
new 15.0 <Actions>

OutdentCols ...FSARCO

Not attached to any event
Outdents actual, focused or selected columns. It decreases column Level by 1. It fails if the column level cannot be decreased without affecting other columns.
new 15.0 <Actions>

OutdentColsForce ...FSARCO

Not attached to any event
Outdents actual, focused or selected columns. It decreases column Level by 1. It outdents also adjacent columns if required.