News in version
TreeGrid Gantt chart SpreadSheet Examples Documentation Download Development Licensing Prices References Contacts Buy Try it free
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

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

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


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

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

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

Media rules - responsive design

TreeGrid documentation

TreeGrid can apply different attributes for different screen sizes or other settings like style, like CSS @media rule.
It is possible to show / hide particular rows, columns or space cells. Change column width or height. Or change any other configuration attributes, especially for grid size.
It is not possible to change row or column order. It is not possible to add new or remove existing rows or columns.
It is possible to change default rows attributes, but it is not possible to change default columns attributes.
The items changed by Media should not be saved to / loaded from cookies. The loaded configuration for these items is overwritten by original values.

   <M MaxWidth="1024">
         <C Name="A" Visible="0"/> <C Name="B" Width="50"/>
         <I id="Toolbar" Visible="0"/>
      <Cfg NoHScroll="1"/>
         <MenuCfg Caption="Small caption"/>
   <M MaxHeight="800">
         <I id="Filter" Visible="0"/> <I id="Header" Visible="0"/>
new 12.1 upd 13.0 <Media>


<M> tag defines individual one media settings.
It can be placed in root <Media> tag.
It contains its specific attributes to determine if the rule will be applied or not like MaxWidth or MinHeight.
If there is no such attribute, the media rule is applied always.
If more media <M> tags fulfill actual conditions, they are applied in the order they are defined.

The <M> tag can contain only these sub tags to set their attributes to grid:
<Cols> - contains individual columns as <C> tags with at least Name attribute to identify the column to change.
<Rows> - contains individual rows as <I> tags, including fixed and space rows, with at least id attribute to identify the row to change.
<Pagers> - (since 13.0)contains individual side pagers as <P> tags.
<Def> - contains default rows as <D> tags with at least Name attribute to identify the default row to change.
<Lang> - contains all Lang sub tags like <Format> or <Text> to change particular language settings.
<Cfg> - contains attribute to change in configuration.
<MenuCfg>, <MenuColumns>, <MenuPrint>, <MenuExport> - contains attributes to change in particular menu.
<Actions> - contains attributes to change in action schema.

Since 13.0 it is possible to change columns, defs, pagers and rows with specific attribute value.
Set the row id or column/def/pager Name as "*Attribute*Value", e.g. <D Name="*Color*Red" Color="Blue" changes all default rows Color attribute from Red to Blue.
new 12.1 upd 15.0 <M> string


What will be tested against the MaxWidth, MinWidth, Width, MaxHeight, MinHeight, Height attributes.
If set to empty string (default), tests actual viewport (window.innerWidth, window.innerHeight).
If set to 1, tests grid main tag clientWidth / clientHeight.
Since 15.0 If set to 2, tests grid main tag clientWidth / clientHeight, but if set NoHScroll / NoVScroll tests last size of main tag before plus actual viewport change since change.
If set to id of some HTML tag on page, it tests this tag clientWidth / clientHeight.
If set, the tag size must not be affected by grid size or the grid size must not be affected by the media changes.
new 12.1 <Cfg> string


Default value used for all Media Tags.
new 12.1 <M> string


The <M> rule will be applied only on given media device. Case insensitive keyword. If not set, the rule is used for all devices.
Screen - screen device, both desktop and tablets.
Desktop - screen device, controlled primarily, but not only, by mouse and keyboard.
Tablet - touchscreen device, controlled primarily by fingers.
Print - printer device or print to PDF. Ignores all <M> size attributes like MaxWidth.
Export - export to Xlsx/Xls/Csv. Ignores all <M> size attributes like MaxWidth.
new 12.1 <M> int


The <M> rule will be applied only if the browser window width is less or equal to given value in pixels.
new 12.1 <M> int


The <M> rule will be applied only if the browser window width is greater or equal to given value in pixels.
new 12.1 <M> int


The <M> rule will be applied only if the browser window width is equal to given value in pixels.
new 12.1 <M> int


The <M> rule will be applied only if the browser window height is less or equal to given value in pixels.
new 12.1 <M> int


The <M> rule will be applied only if the browser window height is greater or equal to given value in pixels.
new 12.1 <M> int


The <M> rule will be applied only if the browser window height is equal to given value in pixels.
new 14.0 <M> string[]


The <M> rule will be applied only if the grid has given language. It can be comma separated list of language codes to be applied for any of them, if the <Cfg Language> contains the code.
new 12.1 upd 13.0 <M> string[]


The <M> rule will be applied only if the grid has given style. The Style is <Cfg Style> as style prefix like "TS" or "TW".
Since 13.0 it can be comma separated list of styles to apply the media for all of them.
Media are not applied recursively, it is not possible one media to change grid style and other media to test style and change something else.
new 13.0 <M> string[]


The <M> rule will be applied only if the grid has given Gantt style. The Style is <Cfg GanttStyle> as style prefix like "GW" or "GS".
It can be comma separated list of styles to apply the media for all of them.
Media are not applied recursively, it is not possible one media to change grid style and other media to test style and change something else.
new 13.0 <M> string[]


The <M> rule will be applied only if the grid has given style size. The Size is the first item / class in <Cfg Size> like "Low" or "Small". It is not the whole Size item!
It can be comma separated list of items / classes to be applied for all of them, if the <Cfg Size> starts by any of them.
new 13.0 <M> bool


The <M> rule will be applied only if the grid is in rtl mode (for Rtl=1) or is not in rtl mode (for Rtl=0).
new 13.0 <M> string


Name of the <M> tag to be referred by other <M> tag by Def attribute.
If the <M> tag contains only Name attribute, it is never applied directly, it is applied only via other media that refers it by Def attribute.
new 13.0 <M> string


Comma separated list of Name attributes of other <M> tags.
This <M> tag reads all its not defined attributes from the referred <M> tags. To simply share the same definitions among more <M> tags.
In JSON definition it can be named also as Default, to not collide with <Def> definition, if both need to be defined.
new 12.1 <Cfg> int


What action will be done if window size is changed when grid is already rendered and some media changed some attribute.
0 - nothing will be done, media are applied only on grid load.
1 - grid will be re-rendered after every change done by media.
2 - grid layout will be updated after every change done by media. Use if media changes only grid size attributes like MaxHeight or NoHScroll.
It is ignored if some media changed <Cfg Style/>.
new 15.0 <Cfg> int


Width of main tag in pixels. Can be used only inside <M> tag to change main tag width by this media.
new 15.0 <Cfg> int


Height of main tag in pixels. Can be used only inside <M> tag to change main tag height by this media.
new 15.0 <Cfg> string[]


Comma separated list of standard or custom attributes in <M> tags checked against the same attributes in <Cfg> tag.
If <M> tag contains some of the listed attributes, it is used if <Cfg> tag contains this attribute with the same value.
new 15.0 API event bool


(TGrid grid, object M, bool use)
Called to check if given Media part can be used in actual state. M is parsed <M> tag, one child of <Media> tag.
use is true if the M would be applied, otherwise false. Return new use.
new 13.0 API event void


(TGrid grid, object Media)
Called before default media is created from loaded values. The default media is used to restore original values after media change.
Media is parsed <Media> tag. This event is called before OnLoaded.
new 12.1 API event bool


(TGrid grid, bool start)
Called before media are applied to grid. Return true to cancel the action.
start is true when the change is applied first time on grid load.
new 12.1 API event bool


(TGrid grid, bool changed, bool start)
Called after media are applied to grid, but before the grid is re-rendered. Return true to not re-render the grid.
changed is set if some media changed some grid attribute.
start is true when the change is applied first time on grid load. In this case the return value is ignored.
new 12.1 API event bool


( )
Applies media changes for actual state. Returns true if something was changed.
It calls OnMediaApply and OnMediaApplied.
new 12.1 API variable object[]


Array of all media rules in grid.
The individual objects contain properties like Cols, Rows, Cfg, ... with the individual settings.
And its property Attrs contains the <M> attributes like MaxWidth.