How to run FastGrid React examples
0) Run and test FastGrid React examples (optional)
Download FastGrid examples package from
http://www.treegrid.com/FDownload#Trial and unzip it to some directory, preserve its directories structure.
FastGrid examples package contains simple examples for React framework located in
/Examples/Frameworks/React/.
There are four example sets for plain React without NodeJS created statically and dynamically located in
/basic directory
and next four 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)
React examples created by NodeJS template create-react-app (with and without TypeScript)
-
Go to directory /Examples/Frameworks/React/react-app19/ for React with JavaScript or to /Examples/Frameworks/React/react-app-typescript19/ for React with TypeScript. Or for React 18 / 17 and older use the xxx18 / xxx17 directory.
-
Run here command npm install to install the node modules and wait until they are installed.
-
Next run npm start to serve the example and wait until it is compiled (shows message in console: Compiled successfully).
-
Finally navigate your browser to http://localhost:3000/ to run the examples.
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.
-
Go to directory /Examples/Frameworks/Server/.
-
Run here command npm install to install the node modules and wait until they are installed.
-
Next run npm start to start the NodeJS server. The server serves at http://localhost:8000/.
Using FastGrid in React project
Installation
1) Copy FastGrid script (/Grid/FGridE.js)
Copy FastGrid script file(s) from FastGrid examples package to the React project.
The FastGrid examples package can be downloaded from
http://www.treegrid.com/FDownload#Trial
-
Copy the FastGrid script file /Grid/FGridE.js from FastGrid package to your React project.
The destination location can be chosen freely, it just must be accessible for the React server for reading.
In some types of React it must be copied into specific directory, e.g. in create-react-app template it must be copied into /public directory or some its subdirectory!
It can be also shared among more React projects if the location is accessible for all the project servers.
-
Optionally if you purchased the partial sources,
copy the FastGrid script file that loads partial sources /Grid/FGridEPart.js and also copy the whole /GridSrc directory, from FastGrid package to your React project.
If you plan to modify FastGrid defaults, texts, language and styles files and want to link the modified source files to FastGrid for simpler debugging.
-
Optionally if you purchased the debug sources,
copy the FastGrid script file that loads debug sources /Grid/FGridESrc.js and also copy the whole /JS and /GridSrc directories, from FastGrid package to your React project.
Remember, the FastGrid source files must not be accessible outside your company!.
2) Include FastGrid script (FGridE.js)
Link appropriate FastGrid script file
FGridE.js (standalone script) /
FGridEPart.js (script loading partial source) /
FGridESrc.js (script loading debug sources)
to the React main html file, e.g. into
public/index.html, into <head> section as
<script src="FGridE.js"></script>, use correct path to FGridE.js file.
Or if your React project displays FastGrid only conditionally, you can link
FGridED.js short script instead of FGridE.js main script to download the FGridE.js automatically on demand.
3) If you use TypeScript copy FastGrid TypeScript API definition (FastGrid.TypeScript.API.d.ts)
Copy file
FastGrid.TypeScript.API.d.ts (located in the FastGrid examples package in
/Grid directory) to the
/src directory.
This file contains TypeScript declaration of all FastGrid API methods, properties and events.
If you use
isolatedModules (default in React),
import the
FastGrid.TypeScript.API.d.ts to all files where the FastGrid API is used.
Create FastGrid grid / sheet
4) Create FastGrid statically by HTML tag (<fast-grid>)
Create FastGrid statically somewhere in your page by adding
<fast-grid> tag to some html file or in some React component.
-
Include <fast-grid> tag in some <div> element that will be used as FastGrid container (called main tag). It can be included directly in html code in page or in html code in React component.
For example add such code <div style="height:500px;"><fast-grid src="['static/Layouts/StaticDef.js','static/Layouts/StaticData.js']"></fast-grid></div>.
-
If the React component with <fast-grid> tag cannot not be rendered on page start, add defef="0" attribute to the <fast-grid> and call FGrid.StartFastGrid() function to process the created <fast-grid> tags.
The StartFastGrid() must be called after the html code with the tags is rendered to the page. For example componentDidMount() { FGrid.StartFastGrid(); }
The StartFastGrid() can be called more times without any problem, it processes every tag only once.
-
If used TypeScript, you may need to add //@ts-ignore comment line before the <fast-grid> tag definition to suppress TypeScript warning or error for the custom tag.
For more information about <fast-grid> tag see
Create FastGrid.
5) Create FastGrid dynamically by script (FastGrid(...))
Or create FastGrid dynamically from JavaScript or TypeScript by
FGrid.FastGrid( ) function.
For example:
var grid = FGrid.FastGrid(["Layouts/StaticDef.js","Layouts/StaticData.js"],"MyTag");, where MyTag is an id of <div> tag where FastGrid will be created (it will be FastGrid main tag).
For more information about FastGrid( ) function see
Create FastGrid.
Existing grid can be deleted by
grid.Dispose( ) method. For more information see
Dispose().
To reload grid with new content use
grid.Reload( ) method. For more information see
Reload().
To access existing grid on page by API link the FastGrid with React component in point 6) or use FGrid.Grids object as
FGrid.Grids[grid_id] or for the only grid on page use
FGrid.Grids[0], for example
FGrid.Grids[0].Reload();.
For more information see
Access grid by API.
If FGrid is reported as error not defined (no-undef), access it as window.FGrid or declare it in global scope as var FGrid;
6) Link created FastGrid with React component (for API)
The simplest way is to assign a reference to the React component in FastGrid object and assign a reference to FastGrid object in the React component.
-
Define some property in the React component that will contain a reference to the created FastGrid.
Name it e.g. Grid. If required, initialize it to null or undefined.
-
If FastGrid is created statically by <fast-grid> tag or contains more sheets, do the assignment in React component constructor:
class App extends React.Component { ... Grid = null; constructor(){ super(); ... FGrid.OnTag = (grid) => { grid.Component = this; this.Grid = grid; } ... } ... } ...
In TypeScript do similarly:
class App extends React.Component { ... Grid : TGrid|null = null; constructor(props : any){ super(props); FGrid.OnTag = (grid:TGrid) => { grid.Component = this; this.Grid = grid; } ... } ... } ...
If the FastGrid is a book with more sheets, the OnTag assigns the actually displayed sheet and updates it whenever is displayed different sheet.
-
If FastGrid is created dynamically by FGrid.FastGrid() function, you can do the assignment directly on FastGrid() function call. But still can be used the assignment in OnTag.
For example: class App extends React.Component { ... Grid = null; ... this.Grid = FGrid.FastGrid(["Layouts/StaticDef.js","Layouts/StaticData.js"],"MyTag");.
-
After that, the FastGrid will be accessible from the React component as this.Grid
and the React component will be accessible from the FastGrid event handlers, formulas and actions as Grid.Component.
Create FastGrid data (structure and content)
7) FastGrid data format (JSON)
- Download data format
FastGrid creates the grid from data in JSON format. This format is proprietary for FastGrid. The JSON data contains all required definitions: configuration, columns, rows, cells, values, etc.
You need to create this JSON data and pass it to FastGrid. How this JSON data is created depends fully on you. It can be created statically in some file or dynamically by some server or client script.
Or the data can be also in XLSX or CSV format.
In this package there is NodeJS server with sample JavaScript code in Server/index.js that creates the JSON data for FastGrid from SQLLite database or serves static file.
For more information about the FastGrid JSON data format for download see Layout format and Data format.
- Upload data format
FastGrid uploads the changes to server in JSON format, similar to download format. See documentation Upload format
FastGrid can upload only changes (added/deleted/moved/changed rows and their cells) or the whole data (all rows or even all data), it is controlled SaveFlags.
The server should parse this uploaded data and save it to its data source (database, file, etc.). This server side code is created by you.
In this package there is NodeJS server with sample JavaScript code in Server/index.js that parses uploaded FastGrid JSON data and saves the changes to SQLLite database or to static file.
8) Defining FastGrid layout (columns and configuration)
FastGrid layout defines the grid structure: configuration, columns (types, formats, widths, ...), toolbars, control rows, Gantt definition, etc.
Simply it contains the whole FastGrid definition except body rows and their cells. See
Layout format.
FastGrid layout is usually static JSON file, usually located in
/public or similar directory accessible directly for browser.
But FastGrid layout can be also dynamically created on server or by API or merged to FastGrid data.
The layout definition is usually passed in the FastGrid / <fast-grid>
src array before data, but it is not required.
For more information about the FastGrid layouts see especially the
Tutorial examples in this package that describe individual features and how defined and use them.
9) Creating FastGrid data (rows and cells)
FastGrid data defines the grid data rows and their cells with values. see
Data format.
FastGrid data is usually created dynamically on server side from database or any other data source.
But FastGrid data can be also static JSON, XLSX or CSV file or it can be generated dynamically by API.
The data definition is usually passed in the FastGrid / <fast-grid>
src array after layout, but it is not required.
10) FastGrid data communication (AJAX / REST)
There are three usual ways of passing data to FastGrid.
- Built-in AJAX communication
By default FastGrid loads its data from server and uploads changes back to server by built-in AJAX.
You just specify the urls where to download and upload and their parameters and FastGrid communicates directly with server.
For example
or FastGrid(['Def.js',{Cfg:{SaveUrl:'Basic.js?func=set',PdfUrl:'../Pdf.js?func=getpdf'}},'Basic.js?func=get'],"MyTag");
For more information about the default AJAX communication see Create FastGrid.
- Custom communication
For custom communication (AJAX or another type) define the FastGrid data sources in the same way as in the previous point a.
And define API event OnDataSend. In this event you get all the required information for the communication. Start the custom communication and return true. And after the communication finished call the provided callback function with the result.
For example Grids.OnDataSend = function(G,source,func,index){ MyAjax(source.Url,source.Param.Data,function(result){ if(result<0) func("Error",result); else func(result); }); return true; }
For more information see OnDataSend.
- Direct data
It is possible to create FastGrid from already loaded or created data.
Pass the data directly as datasource string or JSON object or to Code parameter as JavaScript code run in global scope.
For example you can define MyObject = { MyData: {Cols:[{id:'A'},{id:'B'}]} };
and FastGrid([{Code:"MyObject.MyData"},{Body:[{id:1,V:{A:10,B:20}},{id:2,V:{A:20,B:40}}]}],"MyTag");
or <fast-grid src:"[{Code:'MyObject.MyData'},{Body:[{id:1,V:{A:10,B:20}},{id:2,V:{A:20,B:40}}]}]">
For more information see Code attribute.
FastGrid events and API
11) Catch FastGrid action events (Actions in data)
The default action event handlers are defined in FastGrid Defaults.js (located in /GridSrc directory) and they can be (re)defined in input JSON data.
The action events are mostly mouse and key events like OnClick or OnDel. 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 row, column, cell, toolbar and toolbar cell.
The handlers are defined as JavaScript code in string. For example
Actions: { ... OnClick:"alert('Clicked cell '+Row.id+','+Col.id);return 1;" ... } or
Body:[{... A:{... Col1:{... OnClick:"alert('Clicked cell '+Row.id+','+Col.id);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
FastGrid mouse events and
FastGrid key events.
12) Catch FastGrid API events (in script)
FastGrid API event handlers are JavaScript callbacks, they are defined as standard JavaScript / TypeScript functions that are called from FastGrid code when the API event happens.
The API events can be used to run some code after FastGrid 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 FastGrid is created, in input JSON data (Events tag) or e.g. in
constructor of React component that uses FastGrid.
For example:
class App extends React.Component { ... constructor(...){ ... FGrid.OnReady = function(G){ alert(G.id+" grid is ready to render"); } ... } ...
For more information about assigning API events see
FastGrid API events.
13) Using FastGrid API (API methods)
The most of FastGrid 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 FastGrid as described in point 6).
Or grid object can be got by global
FGrid.Grids object as
FGrid.Grids[grid_id] or for the only grid on page use
FGrid.Grids[0], for example
FGrid.Grids[0].Reload();.
For more information see
Accessing FastGrid by API.
Many FastGrid methods require (TRow) row, (TCol) col, (TToolbar) toolbar objects. These objects can be got by its id from
grid.Rows[id] /
grid.Cols[id] /
grid.Toolbars[id].
Rows and columns can be also iterated using
grid.Iter...() functions, see
Iter.