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 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 and 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) Mathematical functions 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 Special cell style attributes Cell CSS class Cell background color Dynamic cell border Cell HTML style Row color alteration Cell mouse cursor

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

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

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

Changes from 9.3 to 10.0 in Gantt chart

TreeGrid documentation

This document describes only changes in compatibility between TreeGrid 9.3 and TreeGrid 10.0.
This document does not describe new features of TreeGrid 10.0.

Incompatibilities

These items must be changed to work like in previous version

Gantt chart is not resized according to side text by default.
GanttShowHtml and GanttRunShowHtml are set to 1 by default, to not resize Gantt column width according to side text, if set GanttSize="" or "0".
Set them to 3 for 9.3 behavior used for GanttFormat.


Dependency must have defined bar plan if more plans are permitted for dependencies.
If more bar types (more main bar plans and / or run) support dependencies, the dependency definition must contain the bar identification (number for main bar plan or '-' for run bar). Like "1,1@R1", where 1,1 is the from and to plan number.
Only the first object in GanttTask (formerly GanttObject) need not have this identification.
In 9.3 version only the first bar defined in row had dependencies and no identification was required.


Dependency API changed, the dependency API definition is different.
Changed OnGetDependency, OnCheckDependencies, GetIncorrectDependencies, GetIncorrectConstraints, GetTasksToSchedule, OnCorrectDependencies.
API GetDependency and SetDependency deleted and replaced by GetDependencies, DeleteDependencies, AddDependencies and TestDependencies.
GetGanttXY returns different values for dependency.

Scheduling algorithm was rewritten.
It can produce different results than 9.3. version especially due different meaning of GanttStrict options.
The tasks with none of dependency, dependencycorrect and bar ...correct in GanttEdit are ignored when scheduling, including their relation (dependencies and children).


GanttResources for Run was renamed to GanttRunResources.
GanttResources are now used only for the first main bar plan and due compatibility also for GanttFlow.


GanttSummary for Run was renamed to GanttRunSummary.


GanttComplete (GanttFlowComplete) / GanttRunComplete is used only if the bar is included in GanttTask (GanttObject).


OnGetGanttHtml does not change the main bar class to Html.
In 9.3. if OnGetGanttHtml API event returned not null, the bar class was set to Html, without border and background.
Now you must explicitly set the GanttClass/X to "Html", "Void" or "None" to change the class for the bar.


By default the Sort and Calc buttons on Toolbar are hidden.
You can show them by setting <Toolbar SortVisibleFormula='1' CalcVisibleFormula='1'/>


Empty Run box is not shown by default, even if it has set Text or Class.
Set <C GanttRunEmpty='1'/> to show it in this case.


OnGetGanttRunRect is called also when calculating dependencies.


For milestone the GanttDuration column value is set to 0 or "" according to CanEmpty value regardless on the cell Type.


GanttClass is now used only for the first main bar plan.
Run has GanttRunClass or Run Class and other main bar plans have their own GanttClassX attribute.


CSS style sheet for Gantt chart was rewritten.
The Gantt CSS was separated from Grid.css to its own file Gantt.css.
Many of the CSS classes renamed, deleted or created new.
Gantt internal HTML height was increased from 500 to 5000 pixels to support rows higher than 500 pixels.
If you used customized CSS for Gantt, you need to rewrite it completely, based on the new TreeGrid Gantt.css.


The Run FastGantt is now boolean and affects all browsers.


OnGanttMenuClick is called for all items, not only for custom ones.


Various changes in TreeGrid (not only Gantt).
Some of previous HTML ids used by TreeGrid were changed, especially in Gantt objects.
Copying, CopyDeleted, CanCopy and Copy attributes are now used also when copying rows between grids by dragging.
The exported HTML is now in UTF8 also in IE5,6,7,8, regardless on the page encoding.
Hover classes in CSS for space Bool and Select types were modified and renamed.

Deprecated items

These items work also in the new version, but it is strongly recommended to use them in the new way

GanttSummary should be set to main bar plan, 0 for first plan.
In 9.3. the GanttSummary was set to 1 for all bars, or to 2 for all editable bars.
For editable summary should be set GanttSummaryType instead of GanttSummary = 2.


GanttFlow should be replaced by GanttParts.
The Flow bar was removed and should be replaced by main bar. It is possible to have more main bar plans and also discrete main bars.
Set also GanttCount=2 or more if you want to have two main bar plans (formerly main bar and flow together).
Rename or update also other Flow attributes to main bar attributes.


GanttFormat should be replaced by bar side text.
Use GanttHtmlLeft/X or GanttHtmlRight/X for main bar or GanttRunHtmlLeft or GanttRunHtmlRight for run bar.
GanttFormatObject is replaced by GanttHtmlLeftEdge/X or GanttHtmlRightEdge/X for main bar or GanttRunHtmlLeftEdge or GanttRunHtmlRightEdge for run bar.


Scheduling algorithm was rewritten.
GanttStrict option 2 has been replaced by manual date (GanttManual, GanttRunManual, GanttRun - Manual).


GanttObject renamed to GanttTask.
By default only the first main bar plan is set as Gantt task and provides dependencies, resources, completion state, manual constraint and locked / disabled state.


ZoomToPage in Pager was replaced by attributes Click and DblClick.