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

Grid cursors - hover & focus

TreeGrid documentation

Specifies how the actual (hovered) row and cell and focused row and cells will be highlighted.
<Cfg> int

Hover

[2] Saved to cookies, to not load it, set HoverLap='1'
What to hover under mouse cursor. It can be changed by a user from configuration menu.
0 - nothing, 1 - only cell color, 2 - full row and cell cursor
<Cfg> bool

ShowDrag

[1] Saved to cookies, to not load it, set ShowDragLap='1'
If shows dragged object under mouse cursor. The dragged row(s) or moved column(s).
It can be changed by a user in configuration menu.
new 6.0 chg 9.2 <Cfg> int

AbsoluteCursors

[5/0]
How the focus and hover cursors will be managed, bit array.
1.bit (&1)If hover cursors are absolutely positioned
2.bit (&2)If focus cursors are absolutely positioned
3.bit (&4)If hover cursor does not display its row and cell border when hovering focus cursor. Useful when hover cursor is absolute and focus relative
Relative (0) - cursors are relatively positioned tags inside grid main tag. Slower. It should not cause any problems.
Absolute (1) - cursors are absolutely positioned tags inside document body. Faster. It can cause problems when grid is hidden or partially overflowed by some its parent.
Absolute cursors also blinks when scrolling page or some grid parent tag (but not in grid itself).
By default TreeGrid uses fast absolute cursors for hover and slow relative cursors for focus.
Since 9.2 by default in Firefox are not used absolute cursors at all (AbsoluteCursors='0'), because they are remarkably slower in latest FF.
new 6.6 chg 11.0 <Cfg> int

BorderCursors

[1]
If Border and Background hover and focus cursors are displayed.
0 - Never, 1 - in all browsers (also in Safari, Chrome and Opera), 2 - only in fast browsers (IE and FF). Since 10.0 also on iPad.
In runtime it has only two values 0 or 1.
Since 11.0. By default are the cursors for Opera, Safari and Google Chrome also enabled, because the newest versions of these browsers are enough fast.
deleted 6.6 <Cfg> bool

SafariCursors

[0]
Renamed to BorderCursors and values meaning changed.
new 11.0 <Cfg> int

FocusCellBorderCursor

[0]
Mouse cursor when above focused cell border. 0 - default, 1 - move, 2 - resize.
new 6.0 <I><C><cell> string[ ]

HoverRow

[...]
How the whole row will be hovered. A list of comma separated keywords.
BorderBorder around the whole row.
BackgroundBackground over the whole row except the actual cell, it is done by opacity. Not for Space rows.
ColorBackground color for all cells in the row except the actual cell, it is computed color - it differs according to the actual row state and background. Can remarkably slow down the hover!
ClassN / A
Default value is "Background" for Header and Panel, "" for Space and "Border,Background" for all other rows.
new 6.0 <I><C><cell> string[ ]

HoverCell

[...]
How the cell will be hovered. A list of comma separated keywords.
BorderBorder around the cell.
BackgroundN / A
ColorCell background color, it is computed color - it differs according to the actual row state and background. Can slightly slow down the hover!
ClassCell class for change text properties like font or color. Can remarkably slow down the hover!
Default value is "Color" for Header, Panel and Space and "Border,Color" for all other cells.
new 6.0 <I><C><cell><Root> string[ ]

FocusRow

[...]
How the whole row will be focused. A list of comma separated keywords. Root is for not rendered pages.
BorderBorder around the whole row.
BackgroundBackground over the whole row except the actual cell, it is done by opacity. Not for Space rows.
ColorBackground color for all cells in the row except the actual cell, it is computed color - it differs according to the actual row state and background. Can slow down the focus!
ClassCell class for all cells in the row except the actual cell, for change text properties like font or color. Can remarkably slow down the focus!
Default value is "Background" for Header, "" for Space and "Border,Background" for all other rows.
new 6.0 upd 11.0 <I><C><cell><Root> string[ ]

FocusCell

[Border,Color,Class]
How the cell will be focused. A list of comma separated keywords. Root is for not rendered pages.
BorderBorder around the cell.
BackgroundN / A
ColorCell background color, it is computed color - it differs according to the actual row state and background.
ClassCell class for change text properties like font or color. Can slightly slow down the focus!
Corner(new 11.0) Bottom right corner point. For auto fill or other dragging rectangle features.
It can be shown also in edit mode if set <Cfg DragEdit/>
new 11.0 <C> int

ColorCursor

[0]
If set, the column cell will be colored if the row has appropriate flag. Bit array.
Only for left and right side columns. Only if permitted by <Cfg ColorCursor/>
1. bit&1The row is hovered, it is ARow.
2. bit&2The row is in focused range, inside FRect.
3. bit&4The row has focus, it is FRow.
4. bit&8The row or its cells are selected. It has set Selected attribute.
5. bit&16Set it to columns with no other ColorCursor bits set to not show the row ColorCursor.
new 11.0 <I> int

ColorCursor

[0]
If set, the row cell will be colored if the column has appropriate flag. Bit array.
Only for fixed rows. Only if permitted by <Cfg ColorCursor/>. Cannot be set to default row.
1. bit&1The column is hovered, it is ACol.
2. bit&2The column is in focused range, inside FRect.
3. bit&4The column has focus, it is FCol.
4. bit&8The column cells are selected. There is at least one row with cell attribute in this column with Selected = 1.
5. bit&16Set it to row with no other ColorCursor bits set to not show the column ColorCursor.
new 11.0 <Cfg> int

ColorCursor

[0]
Must be set to support the rows and columns attributes ColorCursor.
Bit array, set the bits to permit the bits in row and column attributes ColorCursor.
1. bit  -4. bitSee row or column ColorCursor.
5. bit&16If set, the cell will have set also special CSS class to control other style attributes than background color. It can slow down the action.
<Cfg> int

FocusWholeRow

[0]
If set, does not show cursor for the cell, only for row.
For this case should be set also <Cfg Editing='0'/>