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 Ember Express React Svelte Vue Other frameworks NodeJS server SalesForce LWC

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

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 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 (custom JavaScript objects) 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 visibility

TreeGrid documentation

<C> bool

Visible

[1] Saved to cookies, avoid it by <C VisibleLap='1'/>
If the column is displayed in grid.
Hidden column can be shown by a user from columns menu or by action - depending on CanHide settings.
upd 8.0 <C> int

CanHide

[1]
If the column can be hidden or shown by a user action.
It controls also if the column is displayed in Columns visibility menu.
If set to 0, the column can be shown or hidden by API ShowCol / HideCol only. If the column has Visible='0' and is in Sort, it cannot be removed from the Sort.
If set to 1, the column can be shown or hidden also by actions like ShowCol / HideCol and from Columns visibility menu.
If set to 2, (since 8.0) the column can be shown or hidden by API ShowCol / HideCol only, but its sort behavior is normal. Use for child columns in tree.
You can also use CanHide=0 and Visible=0 to define always hidden column to store any custom data or to predefine sorting behavior - see Sort attribute.
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.
The column is hidden correctly, but it is still present in HTML and is not removed either on re-render.
If the column is shown for first time (it was not displayed on first render, had set <C Visible='0'/>), it is still slow.
Since 15.0 it can be set to 2 for xlsx import to not render hidden columns on start except they are in tree.
new 6.0 <C> bool

Hidden

[0]
Hidden='1' has sense only for Visible='0' and <Cfg FastColumns ='1'/>. On start or re-render this column will be rendered as hidden (width 0px).
It slows down rendering grid (the column is rendered) but speeds up showing column (it is just resized).
Set it to 1 if you expect the column will be shown later to speed it up.
<Space cell> bool

Visible

[1]
Space cells are independent on columns and can be shown or hidden by its cell attribute Visible.
If the space cell is not visible, it is not displayed at all (it is displayed with zero width).
Remember, this attribute can be also calculated (colVisibleFormula), so you can show or hide the space cells dynamically by the formula.
<I cell> int

Visible

[1]
The normal (not Space) cells cannot be hidden completely, they will have always the width of its column.
If set Visible attribute to 0, the cell content is not displayed - the cell is shown empty, but its left / right button is visible.
If set Visible attribute to -1, the cell content is shown empty and also its left / right side button is not displayed.
upd 7.0 API method void

ShowCol

(string col)
Displays hidden column col in grid. If the column is already shown or does not exist, does nothing.
If the column is displayed for first time (it was hidden by XML <C Visible='0'/> or is set <Cfg FastColumns='0'/> the displaying of the column can be slow.
Since 7.0 it never does Render.
upd 7.0 API method void

HideCol

(string col)
Hides visible column col. If the column is already hidden or does not exist, does nothing.
Since 7.0 it never does Render.
chg 7.0 API method void

ChangeColsVisibility

(string[ ] Show, string[ ] Hide, bool prefer = 0)
Changes visibility of given columns.
Show - an array of column names to show
Hide - array of column names to hide
If column is present in both arrays, it will be shown for prefer = 0 or hidden for prefer = 1.
Since 7.0 it never require Render and always returns null.
new 12.0 API event bool

OnColShow

(TGrid grid, string col, bool hide)
Called when the column will be shown (hide = 0) or hidden (hide = 1).
Return true to suppress the action.
new 12.0 <Actions>

HideCols ...FSACWO

Not assigned to any event
Hides actual or focused or selected columns.
deleted 15.0 <Actions>

HideCol

,

HideSelectedCols ...F

Not assigned to any event
Replaced by HideCols.
<Actions>

ShowColLeft ...FSACO

Not assigned to any event
Shows hidden column on left side from actual or focused cell.
<Actions>

ShowColRight ...FSACO

Not assigned to any event
Shows hidden column on right side from actual or focused cell.
new 12.0 <Actions>

ShowCols ...FSCW

Not assigned to any event
Shows all hidden columns in focused or selected range.
new 12.0 deleted 12.0 <Actions>

ShowAllCols

Not assigned to any event
Replaced by ShowCols.

Columns visibility menu

Visible columns can be chosen in configuration menu, in Columns visibility menu or in TreeGrid options menu.
For more information see Configuration menu.