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) Upgrading from 9.3 to 10.0 Upgrading from 5.9 to 6.0

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 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 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) 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

Cell types
Auto 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 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 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 Basic settings Communication with server Export API 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
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 Language & regional setup (Text.xml) 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 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

Space rows

TreeGrid documentation

Space rows have all row and cell attributes as normal grid rows.

Solid space rows are especially used for toolbars, tabbers, functional rows like Group or Search or any custom control rows.
Space row is not divided to column sections, is still visible and never scrolled.
Space row cannot be sorted, filtered, selected, deleted, added or dragged, cannot have child rows, cannot be exported to Excel.
By space rows are done special rows Group, Search, Toolbar and Tabber.

Space row can be placed in <Solid> tag as the <I> or <Space> tag.
It is placed into table between other rows sections (Head / Body / Foot) or above or below table, the position is set by Space attribute.
It can be placed also outside grid by Tag attribute.

Every space row can have its own named cells defined by Cells array. The names of cells can, but don't need to be the same as column names.
The space cells are not related to grid columns, every cell have its width set by its Width attribute. The cells cannot be spanned.
The space cell attributes never read its value from grid column, even if they are named same. The space cells are not affected by any grid column resize or move.

Space row can be hidden and displayed by Visible attribute or by ShowRow / HideRow API methods.
Can be calculated, the Formula must be set for individual cells. Can run after cell change or button type cell click. Cells can be focused and/or edited.
<Space> string[ ]

Cells

Comma separated list of cells in the row. The names of cells can, but don't need to be the same as column names.
These cells are not related to grid columns, even if they have the same names.
Every cell have its width set by its Width attribute, so the cells are not aligned with grid columns. The cells cannot be spanned.
new 12.0 <Space> string[ ]

CellsXXX

If the space row contains many cells, it is possible to split their definition to more CellsXXX arrays.
The XXX can be any alphanumeric string. The final Cells order is done by sorting the CellsXXX by the XXX, always as strings.
For API the cells are all always placed in the Cells array.
It is not possible to use both Cells and CellsXXX attributes in one row.
For example definitions <I Cells5="A,B" Cells06="C,D" Cell10Test="E,F,G" Cells100C="H" CellsB="I,J" Cellsaaa="K"/> and <I Cells="C,D,H,E,F,G,A,B,I,J,K"/> are the same.
upd 6.0 <Space> int

Space

[2]
Position of the row inside grid, specifies horizontal section of the grid.
If more solid rows has the same Space value, they are placed in the order they are in XML.
-1 - above table, 0 - above Head, 1 - between Head and Body, 2 - between Body and Foot, 3 - between Foot and vertical scrollbar, 4 - under vertical scrollbar, 5 - under table
-1, 0, 4, 5 are spanned for whole grid, including vertical scrollbar and pager,
1, 2, 3 are spanned only for columns - the vertical scrollbar and pager are placed right side.
<Space> string

Tag

To place Space row outside the grid to any HTML tag on page. If set, the Space attribute is ignored.
It is the id of HTML tag where to render the row.
The width of the external space row is still preserved to be the same as the actual main table width.
In trial version this attribute is ignored.
upd 7.0 <Space> string

Kind

Kind of the space row, can be set also by tag name, e.g <Space Kind='Test' ... /> is the same as <Test ... />
There are special kinds of space rows: Group, Search, Toolbar, Toolbar1, Toolbar2, Toolbar3, Topbar, Topbar1, Topbar2, Topbar3, Tabber, Tabber2 (since 10.0), Fill (empty row created for ConstHeight) with special features, NoData (row shown on empty grid).
By the custom Kind settings you can set CSS class for the whole row, the CSS class name will be Tx + kind + Row, e.g. TSTestRow.
new 12.1 <Space> string

Mirror

If set, copies all not defined attributes in actual space row from the Mirror space row. The Mirror is the row id.
Use especially to split toolbar with many cells to more rows for different media rule - mirror the original toolbar, hide it and hide particular cells in the destination toolbars.
It should be used instead of default row (Def attribute), because the default space row cannot define cells.
Mirror can be nested, one row can mirror another row that already mirrors another row.
<Space> int

Panel

If the row displays (disabled) left panel, just for the same look as other rows.
If set to 2, it displays the panel even if the whole panel column is hidden.
new 6.0 <Space cell> string

Label

HTML label displayed in front of the cell.
Inserts new cell Type='Html' CanFocus='0' Width='-1' in front of the cell.
new 6.3 <Space cell> string

LabelRight

HTML label displayed after the cell.
Inserts new cell Type='Html' CanFocus='0' Width='-1' after the cell.
new 6.0 <Space cell> int

Left

Left indent of any cell, in pixels.
Inserts new cell Type='Html' CanFocus='0' Width='Label width' in front of the cell.
<Space cell> bool

RelWidth

[0]
Set it to 1 to resize the cell to whole rest of the space row.
Or to have previous cells aligned to left edge and next cells aligned to right edge of the row.
new 13.0 <Space> bool

SpaceWrap

[0]
If set to 1 it wraps row cells to more lines if there is not enough room to display them horizontally in one line.