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

Row height

TreeGrid documentation

Every row is as high as its highest cell.
Any row can have set minimal height by Height (or global MinRowHeight) and maximal height by MaxHeight. Fixed and Space rows can have computed relative height to completely fill the main tag by ratio, set by RelHeight.

Every standard (non Space) row has up to three independent sections (left, mid, right) and these sections must have the same height to not break grid layout. If cells in the row have different height, the height of the row and its sections must be updated by script (row by row). It can slow down grid, if there are many rows, so if you know the height of the highest cell, specify row Height or global MinRowHeight attributes.
renamed 6.0 <Cfg> int

MinRowHeight

Base minimal row height in pixels. It overrides the base row height set in CSS style by G_RowHeight class and is used if the row has not its Height attribute set.
It specifies minimal height of standard (non space) row. But the row is always at least as high as its content - cannot overflow its content.
Set the RowHeight if most or all your rows' contents are higher than usual, to speed up row measurement. Or set it if you want to have rows higher than their content.
This height is used also in server paging when computing height of not yet loaded page or child page, the resulted height is page.Count * grid.MinRowHeight.
new 6.0 <Cfg> int

MinSpaceRowHeight

Base minimal space row height in pixels. It overrides the base space row height set in CSS style by G_SpaceRowHeight class and is used if the row has not its Height attribute set.
The minimal height of row is at least as high as its content. This height is without space row margin, border and padding, just height of the cell.
Set it if you want have space rows higher than their content. Be careful, in some styles setting the space row height can break down the style.
upd 6.0 <I><Space><B> int

Height

Minimal row height in pixels. Used only if its content is smaller. It is height of the row, including cell border and padding (see difference to MaxHeight).
Set the row Height if you know the maximal height of the row content to speed up row measurement.
Or set it if you want to have the row higher than its content. The row is always as high as its highest cell or minimally as Height.
This height is used also in client paging when computing height of not yet rendered page or child page.
Since 11.0 it can be changed by a user when set dragging edge of cell with Resizing = 1.
upd 6.0 <I><Space> int

MaxHeight

Maximal height of row cells in pixels. By default in variable rows it affects and overflows only multiline Type cells: Lines, Html, Radio, Img, List, see MaxHeightAll.
It is the height of the cell content, without cell border and padding (see difference to minimal Height).
Since 11.0 it affects also resizing row by a user by Resizing = 1 cell.
Setting to 0 disables the attribute usage.
It does not affect RelHeight row.
new 6.0 <C><I><cell> int

MaxEditHeight

Maximal height in pixels of multiline cell while editing.
If not set, the MaxHeight is used.
new 6.0 <I><Space> bool

MaxHeightAll

[0/1]
If the MaxHeight attribute is applied for all cells or for only multiline.
By default it is 0 for variable rows and 1 for fixed and space rows.
Setting to 1 for all variable rows can slightly slow down the grid rendering, because it adds one new <DIV> tag to every cell.
If set to 0, the MaxHeight is applied only to multiline Type cells: Lines, Html, Radio, Img, List.
<I><Space> int

RelHeight

If set, the row height is automatically computed to fill all the remaining space in main tag.
The height is automatically recalculated whenever the height of the main tag or its content changes.
If there are more RelHeight rows in grid, their height is computed as ratio of their RelHeight values.
The RelHeight rows together fill the remaining vertical space in main tag, so the grid has always constant height of the main tag.
Can be set only for fixed or Space rows. Ignored when set <Cfg NoVScroll or MaxVScroll or NoScroll /> attributes.
You can set row MinHeight attribute to specify minimal height of the row. For standard (not Space) rows the MinHeight cannot be set to 0.
The result height of the RelHeight row can exceed MaxHeight bound!
<I><Space> int

MinHeight

Minimal height of RelHeight row in pixels.
For standard (non Space) rows it cannot be lower than the row's content. If the row shows only custom HTML by LeftHtml, MidHtml and RightHtml, the minimal MinHeight value is 1.
For Space rows it can be also 0.
It has different meaning and usage than Height attribute and is related only to RelHeight.
Since 11.0 it affects also resizing row by a user by Resizing = 1 cell.
new 11.0 <I> int

CanResize

[1]
If the row height can be resized by mouse dragging. Cannot be used in Space rows.
In such row there should be set also some cell with Resizing='1' to resize the row by dragging the cell edge.
0 - no, 1 = between MinHeight and MaxHeight, 2 - without limits
new 11.0 <C> <cell> int

Resizing

[0/2]
If the cell checks its edges for mouse actions, bit array.
Default value is 2 for Header rows and 0 for other rows.
0 - no edge
1 - top and bottom edge for row resizing, event target is HeaderTop and HeaderBottom
2 - left and right edge for column resizing, event target is HeaderLeft and HeaderRight. Cannot be set for Space cell.
3 - both vertical and horizontal edges.
new 11.0 <I> bool

Resized

[0]   Uploaded to server, supports Undo
If the row height has been changed by a user.
It is uploaded to server if Upload_Type contains Resized flag.
new 11.0 <Cfg> bool

Resizing

[1]
If row resizing is permitted.
new 12.0 <Cfg> int

UpdateHeightsTimeout

[0]
How often synchronizes row heights in column sections.
By default it is not required to synchronize row heights in the sections, but if rows have different heights and the sections sometimes become not synchronized, due too complex layout, set UpdateHeightsTimeout.
Value is in 200ms. 0 means never. For example value 5 means 5*200ms = every 1s.
Smaller value slows down the grid and browser, bigger value causes longer delay before the sections are synchronized.
API method int

GetRowHeight

(TRow row)
It returns height of the row in pixels. For already rendered rows returns its exact height, for not rendered rows returns its Height or MinRowHeight.
It can be called also for page and it returns height of all its rows.
API method bool

UpdateRowHeight

(TRow row, bool callUpdate)
Updates height of all row sections to be the same and also shrinks the row to its minimal possible height.
Call it to immediately correct the layout if the row content height was changed externally.
If set callUpdate, calls Update method after change.
Returns true if the layout is correct and false if it could not be corrected and the section still have different height - the layout is broken.
new 6.0 upd 9.0 API method bool

UpdateHeights

(int always = 0)
Immediately corrects grid layout, updates height of all sections to be the same. This method is called in interval to preserve layout break.
Call it after expected change of layout to correct the layout immediately and do not wait for the interval. This method checks first if there is some problem and if not, it returns.
It calls also Update method if there has been any change in layout.
(new 9.0) If set always = 1, it iterates, checks and corrects always all rows in grid. It can be very slow. Call it if the layout is still broken down even after calling UpdateHeights(0).
If set always = 2, it does the action in timeout, after actual script finishes. It can be called more times in the actual script and will be done only once.
new 11.0 API method int

OnRowResize

(TGrid grid, TRow row, int newheight, int oldheight)
Called before the row is resized from oldheight to newheight, in pixels.
Return 0 to cancel action, null to continue, integer for new newheight.
new 11.0 API method void

ResizeRow

(TRow row, int height)
Changes row height. Sets Resized attribute to 0 or 1 depending on the new height is equal to original height. Calls also OnRowResize.