Changes log (txt file) Compare FastGrid 1.0 & TreeGrid 17.1
Angular Ember Express React Svelte Vue Other frameworks NodeJS server SalesForce LWC
Simple examples of creating FastGrid Create FastGrid Display grid Access grid by API Sheets, more grids switched in one place Layout and configuration Data rows, columns, toolbars, images Changes in data rows, columns, toolbars Saving changes to server Mark changes Loading children on expand parent Short format
Parts - ColParts and RowParts Part size Part scroll position Sets Column sets Row sets
Toolbar Cells Icon Height Width Toolbar position Dragging and manipulating cells Special toolbars
Row / column id Row / column index Row / column name
API to get grid objects Auto added columns & rows on scroll Blocks of rows / columns Adding / copying / moving Deleting Showing and hiding Layout menu Selecting rows and columns Fill cell values by dragging Locking grid against changes Undo & redo
Row and column tree Row tree Column tree Expand & collapse
Read and write any values by API Cell value Cell attributes Cell value & attributes in UTF8 Store
Editing During editing Validation and errors
Row cell side icons Icons definition Mark icons and charts Mark icons list Row cell floating images
Row height Column width Resizing rows and columns Padding Margin Cell span
Grid style and look Cell style permissions Cell style Cell outer border Cell inner border Alternate row & column background
Cell hyperlink Cell tooltip Static cells Other cell attributes Row & column attributes to speed up
Bool type Check side icon Bool type & Check side icon
JavaScript formulas Aggregate functions String aggregate functions Other functions
Formula rules Formula attributes Defined names for editable formulas 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
Dialog Dialog Place Dialog API Menu definition in Script Cell menu List Suggest
Sorting Sorting settings Comparing strings
Grouping Grouping settings Comparing strings Pivot grid
Filtering Filter settings Comparing strings
Search in cells Import files to gridExport files Export and copy to clipboard CSV data
Copy & paste Copy to clipboard Paste from clipboard
Grid size Grid scrollbars Paging and view Media rules - responsive design
Saving settings in storage or cookiesFocus cell and cell ranges Mouse hover cells Highlight cells, rows and columns
Mouse events Key events API events
API for iterating rows and columns Paint and repaint Various API methods
Basic description Main advantages Basic usage License Download Documentation
Bits - small integers or enums Integers or enums with strings Date and time Floating point numbers Special strings
Integer 1 char String 1 char Date 1 char Bits 1 char Integer 2 chars String 2 chars Date 2 chars Float 2 chars Integer 3 chars String 3 chars Date 3 chars Integer and double float 5 chars String 5 chars Date 5 chars Fixed length string Separated strings Adjacent strings Prefix for escaping string Fixed length data Unused custom codes Prefix for stored separator or length Prefix for stored base number Unused basic ucodes
chars signed decimals multiple limits varstrings escape base chars2 signed2 decimals2 multiple2 limits2
Internal coding Profiling times for ucode options Function referenceFastGrid documentation glossary
Here is full online documentation for FastGrid.
Choose desired document in left side tree or find it in documentation search.
In this documentation glossary is described how to use the documentation.
| !? |
Using the item can slow down the grid. It is usually more explained in the item description. "?" - slightly slows down on some conditions, "??" - remarkably slows down on some conditions, "!" - slightly slows down, "!!" - remarkably slows down. |
| version | FastGrid version(s) where the attribute was changed. See the versions. |
| object | A list JSON objects where the attribute can be used. See all possible objects. |
| type | Informational attribute type according to the attribute meaning. See all possible types. The JSON and API should always use number for "bool", "int" and "number" type and string for "string", string[] and strings[id] types. Especially setting string "0" into "bool" or "int" type can cause incorrect behavior! |
| default value | Initial attribute value. The default values are preset usually in Defaults.js, but some of them are also set directly in FastGrid code. If the default value is not defined, the item has initially null or 0 or empty string according to its type. If Sheet.js defines different default value, it is listed as the second [...]. |
| specialty | Information that the attribute is saved to and loaded from cookies (therefore can be ignored in JSON data) and information how to avoid it. Or information that the attribute is uploaded to server. Or information that the attribute can be undone (supports Undo), when set <Cfg Undo='1'/>. |
| getter | JavaScript Grid method used to read the attribute value for API. The most attributes can be read also by universal Get method. |
| setter | JavaScript Grid method used to write the attribute value for API. The most attributes can be written also by universal Set method. |
| version | FastGrid version(s) where the attribute was changed. See the versions. |
| object | API method always belongs to Grid object. |
| type | Informational type the function returns, according to the item meaning. The real JavaScript type can be different. See all possible types. |
| parameters | Parameters of the JavaScript function. Note, the parameter types and names are just informational, the only exact thing is the parameters order. |
| version | FastGrid version(s) where the attribute was changed. See the versions. |
| type | Informational type the function is expected to return, according to the item meaning. The real JavaScript type can be different. See all possible types. |
| parameters | Parameters that are passed to the function call. Note, the parameter types and names are just informational, the only exact thing is the parameters order. |
| version | FastGrid version(s) where the attribute was changed. See the versions. |
| attached to | Information where the action is attached by default (in Defaults.js) and restrictions to which events can be attached. |
| version | FastGrid version(s) where the attribute was changed. See the versions. |
| object | A list JSON objects where the attribute can be used. See all possible objects. |
| parameters | The JSON mouse or key event has always these parameters: (Grid Grid, Row Row, Col Col, Event Event) where Row, Col is cell under mouse for mouse event or focused cell for key event. The Grid, Row, Col and Event variables can be used in the event handler code as JavaScript objects; e.g. Actions: { OnClickCell: "alert('clicked cell '+Row.id+','+Col.id)" } |
| getter | JavaScript Grid method used to read the attribute value for API. The most attributes can be read also by universal Get method. |
| setter | JavaScript Grid method used to write the attribute value for API. The most attributes can be written also by universal Set method. |
| version | FastGrid version(s) where the attribute was changed. See the versions. |
| parameters | Are shown as for JavaScript function. Note, the parameters types and names are just informational, the only exact thing is the parameters order. |
Last update done to the item
| new 10.0 | Item was released in the given version (the item did not exist in previous versions). |
| chg 10.0 | Major update to item was done in the given version (the usage of the item was changed). |
| upd 10.0 | Minor update to item was done in the given version (like new parameter added to function or new value added to bit array or flags). |
| renamed 10.0 | The item has been renamed in the given version (the old name is usually still usable, but deprecated). |
| deleted 10.0 | The item has been removed since the given version (the item name is usually still usable, but deprecated). |
Where the item can be used
There can be listed more places like Cfg, Row, Col - item is an attribute of Cfg or row or column.| HTML | ||||
| HTML | The only FastGrid HTML attribute is <fast-grid> | FastGrid definition in HTML | ||
| <fast-grid> | Attribute in <fast-grid> tag on HTML page | defines FastGrid data sources and communication with server | ||
| JSON data, mostly accessible also by JavaScript API | ||||
| Grid | Attribute in root JSON object | all base JSON objects | ||
| Cfg | Attribute in Cfg object | basic grid configuration | ||
| Cell | Attribute in Row A[] item, DefCell, Row, DefRow, Col or DefCol object | attributes of row cells | ||
| Row | Attribute in Row or DefRow object | attributes of rows | ||
| Col | Attribute in Col or DefCol object | attributes of columns | ||
| Tool | Attribute in Toolbar Cells[] item, DefTool, Toolbar and DefToolbar object | attributes of toolbar cells | ||
| Toolbar | Attribute in Toolbar or DefToolbar object | attributes of toolbars | ||
| Image | Attribute in Image or DefImage object | attributes of floating images | ||
| DefCell | Attribute in DefCell object | attributes of default row cells | ||
| DefRow | Attribute in DefRow object | attributes of default rows | ||
| DefCol | Attribute in DefCol object | attributes of default columns | ||
| DefTool | Attribute in DefTool object | attributes of default toolbar cells | ||
| DefToolbar | Attribute in DefToolbar object | attributes of default toolbars | ||
| DefImage | Attribute in DefImage object | attributes of default floating images | ||
| RowPart | Attribute in row Part object or in RowParts | attributes of the whole row part | ||
| ColPart | Attribute in column Part object or in ColParts | attributes of the whole column part | ||
| Part | Attribute in row or column Part object or in RowParts / ColParts | attributes of the whole row part and column part | ||
| JSON data, mostly inaccessible by JavaScript API | ||||
| Dialog | Attribute in Dialog object | attributes of the predefined dialogs | ||
| CellBorder | Attribute in CellBorder object | attributes of the predefined cell borders for use in cells | ||
| Font | Attribute in Font object | attributes of the FastGrid font definition | ||
| Format | Attribute in Format object | attributes of the language dependent number and date formats | ||
| Language | Attribute in Language object | attributes of the language settings | ||
| Cookie | Attribute in Cookie object | attributes for saving configuration | ||
| IO | Attribute in temporary IO object | attributes for server communication | ||
| Source | Attribute in Source object | attributes of one data source for server communication | ||
| Sources | Attribute in Sources object | attributes of all data sources for server communication | ||
| Message | Attribute in Message object | attributes of the predefined messages | ||
| MessageStyle | Attribute in MessageStyle object | attributes of the individual parts of the predefined messages | ||
| Style | Attribute in Style object | attributes of one style definition | ||
| Custom JSON items used for menu and calendar | ||||
| Script | Custom attribute in Script object | attributes of menu or calendar | ||
| Script method | Custom API method in Script object | API methods of menu or calendar | ||
| Item | Custom attribute in Item / Items object | attributes of menu item | ||
| Place | Custom attribute in Place object | attributes of menu or calendar setting its position | ||
| JavaScript API | ||||
| global variable | The only FastGrid global variable is FGrid object. | All other FastGrid items are accessible by FGrid. | ||
| FGrid function | JavaScript static function set in FGrid object | Helper static functions without access to Grid object. | ||
| FGrid variable | JavaScript static variable set in FGrid object | Global variables affecting all grids. | ||
| API event | JavaScript method of FGrid object called as callback for defined event. | API event handlers can be defined in three ways. | ||
| Grid method | JavaScript method of Grid object | The most FastGrid API methods are here | ||
| Grid variable | JavaScript object variable of Grid object | A few variables are accessibles directly from the Grid object. | ||
| F function | JavaScript function that can be used only in JavaScript formula | The functions are used as global functions | ||
| formula | JavaScript function that can be used only in Editable formula | The functions are used as global functions | ||
| Actions | JavaScript method of Grid object | Used usually in JSON event handlers. In JavaScript API it can be used with Action prefix. | ||
| Other | ||||
| file | FastGrid source file | Accessible only with FastGrid sources. | ||
Standard (like TypeScript) item type, not JavaScript type
The type is not JavaScript variable type, but it is similar to standard type in languages like TypeScript, C#, Java or C++.| void | API method does not return value or API event does not expect return value |
| any | Any type, the type can be different per value. |
| bool | Boolean value 0 or 1 (or false or true). Never set it to string, "0" is true! |
| Basically it can be any expression that can be converted to true or false | |
| int | Integer value. It should be JavaScript number like 345, never string like "345" |
| bits | Integer value as bit array – every bit in the number has its own meaning and the value is sum of the bits, similarly to flags. (1.bit = 1, 2. bit = 2, 3.bit = 4, 4.bit = 8, 5.bit = 16, 6.bit = 32, 7.bit = 64, 8.bit = 128, 9.bit = 256, ...) Examples of bit array: to set first, third and sixth bit set 1+4+32 = 37, to set second, third, fifth and tenth bit set 2+4+16+512 = 534 |
| flags | String with comma separated keywords. Every keyword in the string has its own meaning, similarly to bits. It is case insensitive. If the first keyword is asterisk "*", it adds all possible keywords, if the keyword starts by minus "-", it is removed instead of added (use when the first keyword is asterisk "*"). |
| number | Floating point number value. It should be JavaScript number like 3.45, never string like "3.45" |
| string | String value. It should be JavaScript string, not number or boolean |
| string[] | Array of strings like ["One","Two","Tree"], in JSON it can be also one string with comma separated values: "One,Two,Three". |
| string[*] | Array of strings like ["One","Two","Tree"], in JSON it can be also one string with values separated by the first character: "|One|Two|Three". The separator can be any Unicode character not included in any of the separated items. |
| string[id] | Object with attributes as ids with string values. |
| string[][id] | Object with attributes as ids with value of array of strings or comma separated string, e.g. {id1:["a","b","c"],XX:"x,y,z"} |
| char | One character length string value. It should be JavaScript string, not number or boolean |
| range | String with specific format for cell range like "A1:C3" |
| object | Any JSON / JavaScript object. |
| function | JavaScript function passed as callback. |
| HTMLElement | DOM element object. |
| HTMLEvent | DOM Event object. |
| Row | Row object (not string id). It can be often also Toolbar object. |
| Col | Column object (not string id). It can be often also Toolbar cell object. |
| Grid | Grid object, all API events get it as the first parameter. It can be also got by its id or index from FGrid.Grids array |
| Type | Other specific FastGrid object, taken as standard JavaScript object. |
| type[], type[][], type[][][] | One, two or three dimensional array of given type. |
| type[id] | Object with attributes as ids with values of given type. |