How to run TreeGrid React examples

Download TreeGrid examples package from http://www.treegrid.com/Download#Trial and unzip it to some directory, preserve its directories structure.
TreeGrid examples package contains simple examples for React framework located in /ExamplesNode/React/.
There are two example sets for plain React without NodeJS created statically and dynamically located in /basic-* directories and next six examples for create-react-app with and without TypeScript.
The examples are for React versions 19, 18 and 17, but they were tested and work without changes also in React version 16 and 15.

Plain React examples (without installation and NodeJS)

If you have any problems running React examples please contact our technical support.


Install and run React examples created by NodeJS template create-react-app (with and without TypeScript)

If you have any problems running React examples please contact our technical support.


Optionally install and run sample NodeJS server that serves data for the React examples from SQLLite database.

The server is needed for the most of the React examples to serve their data.

Using TreeGrid in React project


Installation

1) Copy TreeGrid distribution (/Grid)

Copy TreeGrid required files from TreeGrid examples package to the React project. The TreeGrid examples package can be downloaded from http://www.treegrid.com/Download#Trial

2) Include TreeGrid script (GridE.js)

Link TreeGrid script file GridE.js to the React main html file, e.g. into public/index.html, into <head> section as <script src="Grid/GridE.js"></script>, use correct path to GridE.js file.
Or if your React project displays TreeGrid only conditionally, you can link GridED.js short script instead of GridE.js main script to download the GridE.js automatically on demand.

3) If you use TypeScript copy TreeGrid TypeScript API definition (TreeGrid.TypeScript.API.d.ts)

Copy file TreeGrid.TypeScript.API.d.ts (located in the TreeGrid examples package in /ExamplesNode/React/ directory) to the /src directory.
This file contains TypeScript declaration of all TreeGrid API methods, properties and events.
If you use isolatedModules (default in React), import the TreeGrid.TypeScript.API.d.ts to all files where the TreeGrid API is used.

Create TreeGrid grid / Gantt / sheet

4) Create TreeGrid statically by HTML tag (<treegrid> / <bdo>)

Create TreeGrid statically somewhere in your page by adding <treegrid> tag to some html file or in some React component.
For more information about <treegrid> / <bdo> tag see Creating TreeGrid.

5) Create TreeGrid dynamically by script (TreeGrid(...))

Or create TreeGrid dynamically from JavaScript or TypeScript by window.TreeGrid( ) function.
For example: var grid = window.TreeGrid({Debug:'check', Layout: { Url:"Layouts/StaticDef.js" }, Data: { Url:"Layouts/StaticData.js" } },"MyTag");, where MyTag is an id of <div> tag where TreeGrid will be created (it will be TreeGrid MainTag).
For more information about TreeGrid( ) function see Creating TreeGrid.

Existing grid can be deleted by grid.Dispose( ) method. For more information see Deleting TreeGrid.
To reload grid with new content use grid.ReloadBody( ) method, to recreate grid completely from new layout and data use grid.Reload( ) method. For more information see Reloading TreeGrid.
To access existing grid on page by API link the TreeGrid with React component in point 6) or use global window.Grids object as window.Grids[grid_id] or for the only grid on page use window.Grids[0], for example window.Grids[0].Reload();.
For more information see Accessing TreeGrid by API.

6) Link created TreeGrid with React component (for API)

The simplest way is to assign a reference to React component in TreeGrid object and assign a reference to TreeGrid object in React component.

Create TreeGrid data (structure and content)

7) TreeGrid data formats (JSON / XML)

8) Defining TreeGrid layout (columns and configuration)

TreeGrid layout defines the grid / Gantt structure: configuration, columns (types, formats, widths, ...), toolbars, control rows, Gantt definition, etc. Simply it contains the whole TreeGrid definition except body rows and their cells. See Layout format and JSON format.
TreeGrid layout is usually static JSON or XML file, usually located in /public or similar directory accessible directly for browser.
But TreeGrid layout can be also dynamically created on server or by API or merged to TreeGrid data.
The layout definition is assigned in Layout object in TreeGrid() method (e.g. window.TreeGrid({Layout:{Url:'test.json'},...},...)) or with Layout_ prefix in <treegrid> tag (e.g. <treegrid Layout_Url='test.json' ... >).
For more information about the TreeGrid layouts see especially the Tutorial examples in this package that describe individual features and how defined and use them.

9) Creating TreeGrid data (rows and cells)

TreeGrid data defines the grid data rows and their cells with values. see Data format and JSON format.
TreeGrid data is usually created dynamically on server side from database or any other data source.
But TreeGrid data can be also static JSON / XML file or it can be generated dynamically by API.
The data definition is assigned in Data object in TreeGrid() method (e.g. window.TreeGrid({Data:{Url:'testdata.json'},...},...)) or with Data_ prefix in <treegrid> tag (e.g. <treegrid Data_Url='testdata.json' ... >).

10) TreeGrid data communication (AJAX / REST)

There are three usual ways of passing data to TreeGrid.

TreeGrid events and API

11) Catch TreeGrid XML/JSON events (Actions in data)

The XML/JSON event handlers are defined in TreeGrid Defaults.xml (located in /Grid directory), in layout XML/JSON file or data or in another input XML/JSON data.
The XML/JSON events are mostly mouse and key events like OnClick or OnMouseMove. There are also a few special events like OnChange.
The handlers are defined by On... attribute in Actions tag for the whole grid or by On... attribute assigned to particular column, default column, row, default row, row cell, default row cell.
The handlers are defined as JavaScript code in string. For example Actions: { ... OnClick:"alert('Clicked cell '+Row.id+','+Col);return 1;" ... } or Body:[[{... Col1OnClick:"alert('Clicked cell '+Row.id+','+Col);return 1;" ...},...]]
The React component (linked in point 6)) can be accessed in the handler code by Grid.Component, for example Actions: { ... OnClick:"Grid.Component.MyProcessClick(Row,Col)" ... }
The handler should return 1 to cancel event propagation or 0 to continue propagation and run next event handlers.
For more information see TreeGrid mouse events and TreeGrid key events.

12) Catch TreeGrid API events (in script)

TreeGrid API event handlers are JavaScript callbacks, they are defined as standard JavaScript / TypeScript functions that are called from TreeGrid code when the API event happens.
The API events can be used to run some code after TreeGrid is loaded, ready or rendered or some action is started or finished like data communication, editing, sorting, filtering, mouse actions like click, etc.
The event handlers can be assigned before any TreeGrid is created, e.g. in constructor of React component that uses TreeGrid.
For example: class App extends React.Component { ... constructor(...){ ... window.Grids.OnReady = function(G){ alert(G.id+" grid is ready to render"); } ... } ...
For more information about assigning API events see TreeGrid API events.

13) Using TreeGrid API (API methods)

The most of TreeGrid API methods are methods of (TGrid) grid object. The grid object can be got by this.Grid if called in the React component linked with created TreeGrid as described in point 6).
Or grid object can be got by global Grids object as window.Grids[grid_id] or for the only grid on page use window.Grids[0], for example window.Grids[0].Reload();. For more information see Accessing TreeGrid by API.
Many TreeGrid methods require (TRow) row object. The row object can be got by its id by GetRowById API method or by iterating rows, see Row iteration.
The column are passed to TreeGrid methods by their names as strings. The columns can be also iterated see Column iteration.