Default rows, columns, cells and toolbars

FastGrid documentation

Every item (row, column, cell, toolbar and toolbar cell) can have D attribute to specify default item.
From default item are read all attributes that are null in the referring item. Every item can refer only to one default item (of the same kind as referring item).
The default item can be changed (by API or on some conditions) for any referring item, it changes all default attributes in the referring item.

Every default item can also refer one (or more) other default items by their D attribute. The relations between default items are solved on loading, so after load every default item contains all its attributes read from all its default items and no D attribute.
Reference to default item (its id) of the same kind (Row can refer only to DefRow, etc.).
From default item are read all attributes that are null in the referring item. Every item can refer only to one default item.
The default item can be changed (by SetD or on apply DEmpty / DParent) for any referring item, it changes all default attributes in the referring item.
If the item is defined by number or string and not by object, it is set as D attribute if it is existing default object and also as id attribute, for example Head:[ "Header" ] is the same as Head:[ { D:"Header", id:"Header" } ] Reference to default item(s) of the same kind (DefRow can refer only to DefRow, etc.). The D can be:
a) string or number as id of the default,
b) comma separated string as list of the defaults id,
c) array of strings or numbers as list of the defaults id.
If more referred defaults have defined the same attribute, the first listed default is preferred.
If the same attributes are defined somewhere deep (in referred defaults of the referred defaults), preferred is the shallower definition.
The relations between default items are solved on loading, so after load every default item contains all its attributes read from all its default items and no D attribute.
Default cell attributes for all the row / column cells. Reference to DefCells.
It is used only if the cell has not set the default attribute in A or B.
If defined both Row.DA and Col.DA, it is taken as Row.DA + Col.DA. Called to get default cell id to DefCells if defined neither A[AIndex].D nor B[BIndex].
DA is predefined default cell id read from Row and Col DA. Return DA or another default cell id.
Returning null is the same as returning DA. Return "" to not use any cell default.
Low level API event called many times.
This event handler code should be very fast, otherwise it will slow down painting grid and cause choppy scrolling! Default toolbar cell attributes for all cells.
Default value is "Icon" for cells without Type set and "Cell" for all other cells with type Type set.
It is set to all toolbar cells without D attribute on loading.
Default toolbar cell attributes for active sheet cell on Sheets toolbar.
Value of default row / column D that is assigned to the row / column when it loses all its children (by moving or deleting).
It is not used on loading.
Value of default row / column D that is assigned to the row / column when it gets some child (by moving or adding).
It is not used on loading.
Reference to default item (its id) for all children that have not set their D explicitly.
It must be of the same kind as the referrer (Row can refer only to DefRow, etc.).
The row / column or toolbar can have the Kind attribute set special behavior and features.
The Kind attribute is usually not set explicitly, but it is set in default item and assigned by D attribute.
Auto generated id for items with Kind is set as Kind + index. If the Kind is defined in default row / column, the id is generated by the Kind only from this default, not from any its ancestor!

Header	Row, Col	D: Header, Index	Column / row captions
Panel	Row, Col	D: Panel	Panel with buttons
Filter	Row, Col	D: Filter	Controls filtering rows / columns
Sticky	Row	D: Sticky	Sticky row like CSS position: sticky
Group	Toolbar	D: Group	Controls grouping rows / columns
Hide	Toolbar	D: Hide	Controls showing / hiding columns / rows

Defined default rows that can be assigned to Row by its id to D attribute.
If row has not set D attribute, it has assigned DefRow according to its Kind attribute or if the Kind is not set, the "Row".
By default (in Defaults.js) there are defined these DefRow:

Base	Base default inherited by all default rows without explicitly set the D attribute. Except to Base DefRow itself.
Row	Default row assigned to every Row without explicitly set the Kind attribute and to Kind = "Row" rows.
Special	Default row inherited by the special defaults "Header", "Index", "Panel" and "Filter".
ReadOnly	Default row inherited by the special read only defaults "Header", "Index", "Panel".
Header	Default row assigned to every Header row (Kind = "Header", Index = 2).
HeaderFocus	Default row that inherits "Header" and attaches events for focusing whole columns instead of sorting and dragging.
Index	Default row assigned to every Index row (Kind = "Header", Index = 1). Inherits "Header" default.
IndexFocus	Default row that inherits "Index" and attaches events for focusing whole columns instead of sorting and dragging.
Panel	Default row assigned to every Panel row (Kind = "Panel").
Filter	Default row assigned to every Filter row (Kind = "Filter").
Sticky	Default row assigned to sticky row.
Group	Default row assigned to every group row created by grouping.

Defined default columns that can be assigned to Col by its id to D attribute.
If column has not set D attribute, it has assigned DefCol according to its Kind attribute or if the Kind is not set, the "Col".
By default (in Defaults.js) there are defined these DefCol:

Base	Base default inherited by all default rows without explicitly set the D attribute. Except to Base DefCol itself.
Col	Default column assigned to every Col without explicitly set the Kind attribute and to Kind = "Col" rows.
Special	Default column inherited by the special defaults "Header", "Index", "Panel" and "Filter".
ReadOnly	Default column inherited by the special read only defaults "Header", "Index", "Panel".
Header	Default column assigned to every Header column (Kind = "Header").
HeaderFocus	Default column that inherits "Header" and attaches events for focusing whole rows instead of sorting and dragging.
Index	Default column assigned to every Index column (Kind = "Index"). Inherits "Header" default.
IndexFocus	Default column that inherits "Index" and attaches events for focusing whole rows instead of sorting and dragging.
Panel	Default column assigned to every Panel column (Kind = "Panel").
Filter	Default column assigned to every Filter column (Kind = "Filter").
Group	Default column assigned to every group column created by grouping.
Empty	Default column that can be assigned to empty column to fill the rest space of the part.

Defined default cells that can be assigned to cells by its id into Row / Col A, B or DA attribute.
If the cell has not set DefCell via Row / Col A, B or DA attribute, it has no DefCell.
Only the DefCell can contain xxxFormula to calculate cell attribute xxx by formula. It is the only way to use calculated attributes.
By default (in Defaults.js) there are defined these DefCell:

Base	Base default inherited by all default cells without explicitly set the D attribute. Except the Base DefCell itself. It is not applied to cells without DefCell set, if not defined DefCell Cell!
Cell	Default cell, assigned to all cells without assigned DefCell. It is not defined by default! Defining it will slightly slow down the grid!

Defined default toolbars that can be assigned to Toolbar by its id to D attribute.
If toolbar has not set D attribute, it has set the "Toolbar".
By default (in Defaults.js) there are defined these DefToolbar:

Base default toolbars assigned automatically
Base	Base default inherited by all default toolbars without explicitly set the D attribute. Except to Base DefToolbar itself.
Toolbar	Default toolbar assigned to every Toolbar without explicitly set the D attribute.
Toolbars to drop columns or rows
Group	Toolbar with empty space as the last cell to drop columns or rows for grouping. It is possible to add Cells like GroupList and / or Group to show actual grouping.
Hide	Toolbar with empty space as the last cell to drop columns or rows to hide them.
PivotRows	Toolbar with empty space as the last cell to drop columns to add them to PivotRows.
PivotCols	Toolbar with empty space as the last cell to drop columns to add them to PivotCols.
PivotData	Toolbar with empty space as the last cell to drop columns to add them to PivotData.
Toolbars with icons
Data1	Toolbar showing base data cells: Import, Save, Reload, Print, Pdf, PrintPdf, Export, Copy, Paste, Undo, Redo.
Data2	Toolbar showing cells for row and column manipulation: Add, Delete, Hide, Select, Collapse, Indent, Span, Split, Fix
Data3	Toolbar showing the rest of data icons: AddImage, AddLink, AddTip, AddName, Names
Text1	Toolbar showing the text style icons: Bold, Italic, Underline, Strike, TextFont, TextSize, IncTextSize, ClearTextSize, DecTextSize, UpperCase, LowerCase
Text2	Toolbar showing the cell style and format icons: Format, AlignLeft, AlignCenter, AlignRight, AlignTop, AlignMiddle, AlignBottom, IndentLeft, IndentRight, WrapText, Rotate
Text3	Toolbar showing the rest of text icons: TextColor, TextShadow, TextLine, Color, Border, ClearStyle, ClearValue, NoEdit
Settings	Toolbar showing settings cells: FilterAction, ClearSort, Lock, Settings.
Layout	Toolbar showing layout cells: Layout, UpdateToolbars. This toolbar cannot be hidden when updating toolbars.
Other toolbars
Sheets	Toolbar showing all sheets in actual book.
Cookies	Toolbar showing cells to show and manipulate saved configurations.
Edit	Toolbar showing Focus and ExternalEdit text boxes like in Excel edit line.
Search	Toolbar showing SearchText text box and Search icon to provide search in grid.
Version	Toolbar showing FastGrid version. It must have id="Version" and no Cells defined. Or defined just as string "Version".

Defined default toolbar cells that can be assigned to Tool by its id to D attribute.
If toolbar cell has not set D attribute, it has set the "Icon" if its Type is not set or "Icon", in other case has set "Cell".
By default (in Defaults.js) there are defined these DefTool:

Base default cells assigned automatically
Base	Base default inherited by all default toolbar cells without explicitly set the D attribute. Except to Base DefTool itself.
Cell	Default toolbar cell assigned to all cells with Type set to anything except empty string. Without any special setting.
Icon	Default toolbar cell assigned to all cells with Type not set. Shows icon according to the cell id, it it has not set Icon.
Button	Default toolbar cell assigned to buttons in FastGrid dialogs. Shows cell border as button.
Custom cells
Switch	Shows Bool type without the icon. Highlights the text when on. Set Text attribute to display the text and OnChange to catch the change.
Cells for editing, with CellBorder
List	Shows popup list in List. Textbox with cell border around text. Uses String type.
ListSmall	Like List, but with wide and high cell border.
ListFirst	Like List, with padding to use as the first cell from adjacent edits.
ListNext	Like List, with padding to use as the middle cell from adjacent edits.
ListLast	Like List, with padding to use as the last cell from adjacent edits.
ListSingle	Like List, with padding to use as single cell in the same spaces as adjacent edits.
Edit	Shows editable textbox. Textbox with cell border around text. Uses String type.
EditSmall	Like Edit, but with wide and high cell border.
EditFirst	Like Edit, with padding to use as the first cell from adjacent edits.
EditNext	Like Edit, with padding to use as the middle cell from adjacent edits.
EditLast	Like Edit, with padding to use as the last cell from adjacent edits.
EditSingle	Like Edit, with padding to use as single cell in the same spaces as adjacent edits.
EditList	Default toolbar cell showing editable textbox with popup list in List. Textbox with cell border around text. Uses String type.
Empty cells
Space	Shows inactive empty space of fixed width.
Empty	Shows inactive empty space of relative width to fill the rest of part width.
Label	Shows inactive text of type String.
MenuCaption	Shows inactive text of type String used for menu captions.
Separator	Shows vertical line as separator between toolbars or tools. The line as high as the toolbar.
Layout
UpdateToolbars	Icon to switch DraggingToolbars on and off to permit / restrict users dragging and hiding toolbars.
Layout	Icon to show layout menu to choose the rows and columns visibility.
DragHide	Default cell as column / row actually hidden.
DropHide	Drop area for dropping columns / rows to hide them.
Sorting, grouping & filtering
Sort	Icon with popup to clear actual sorting or to show sorting options.
ClearSort	Icon to clear actual sorting.
Group	Icon with popup to switch the grouping on / off or to show grouping options.
GroupList	Shows popup list from List with predefined group choices.
DragGroup	Default cell as column / row actually used for group by.
DropGroup	Drop area for dropping columns / rows to group by them.
Filter	Icon with popup to switch the FilterAction and / or / off or to show filter options.
FilterAction	Icon to switch the FilterAction and / or / off.
FilterTree	Combo box with popup list to choose FilterTree.
Copy & paste and search
Copy	Icon with popup to copy selected cells to clipboard or to show list with copy to clipboard options.
CopyOnly	Icon to copy selected cells to clipboard.
Paste	Icon with popup to paste cells or rows from clipboard or to show list with paste from clipboard options. On some systems pasting can be done only by Ctrl+V or from browser menu
PasteOnly	Icon to paste cells or rows from clipboard. On some systems pasting can be done only by Ctrl+V or from browser menu
Search	Icon with popup to run search in grid or to show list with search options.
SearchText	Textbox to enter text to search in grid.
Base data controls
Import	Icon to import local xlsx or json file to grid.
Save	Icon to send changes or whole data from grid server.
Reload	Icon to reload data from server and discard all changes.
Print	Icon to print the grid data to printer.
Pdf	Icon to export data to pdf. Requires server side code to print grid to html and convert it to pdf.
PrintPdf	Icon to print data to printer or to export to pdf. PDF export requires server side code to print grid to html and convert it to pdf.
Export	Icon to export the grid data to xlsx, csv or html.
Undo	Icon to undo the last action done in grid.
Redo	Icon to redo the last undone action done in grid.
Data manipulation - both rows and columns
Select	Icon to show popup menu to choose action to select row(s) or column(s).
Delete	Icon to show popup menu to choose action to delete or undelete row(s) or column(s).
Hide	Icon to show popup menu to choose action to hide or show row(s) or column(s).
Add	Icon to show popup menu to choose action to add new or copy existing row(s) or column(s).
Indent	Icon to show popup menu to choose action to indent or outdent row(s) or column(s).
Collapse	Icon to show popup menu to choose action to collapse or expand row(s) or column(s).
Data manipulation - rows
SelectRows	Icon to select or unselect all rows.
DeleteRows	Icon to delete or undelete selected or focused row(s).
HideRows	Icon to hide selected or focused row(s).
AddRows	Icon to add new row(s) above focused row.
CopyRows	Icon to copy selected or focused row(s) above focused row.
AddRowEnd	Icon to add new row to the end of the default row part.
IndentRows	Icon to indent selected or focused row(s).
OutdentRows	Icon to outdent selected or focused row(s).
ExpandRows	Icon to expand all row(s).
CollapseRows	Icon to collapse all row(s).
Data manipulation - columns
SelectCols	Icon to select or unselect all columns.
DeleteCols	Icon to delete or undelete selected or focused column(s).
HideCols	Icon to hide selected or focused column(s).
AddCols	Icon to add new column(s) left to the focused column.
CopyCols	Icon to copy selected or focused column(s) left to the focused column.
AddColEnd	Icon to add new column to the end of default column part.
IndentCols	Icon to indent selected or focused column(s).
OutdentCols	Icon to outdent selected or focused column(s).
ExpandCol	Icon to expand all column(s).
CollapseCols	Icon to collapse all column(s).
Text controls
Bold	Icon to switch bold text on / off actually focused cell(s) or edited text.
Italic	Icon to switch italic style on / off actually focused cell(s) or edited text.
Underline	Icon to switch text underling on / off actually focused cell(s) or edited text.
Strike	Icon to switch text strike on / off actually focused cell(s) or edited text.
TextFont	Combo box with popup list to choose font family of actually focused cell(s) or edited text.
TextSize	Combo box with popup list to choose font size of actually focused cell(s) or edited text.
IncTextSize	Icon to increase text size of actually focused cell(s) or edited text.
DecTextSize	Icon to decrease text size of actually focused cell(s) or edited text.
ClearTextSize	Icon to set default text size of actually focused cell(s) or edited text.
UpperCase	Icon to convert to upper case the actually focused cell(s) or edited text.
LowerCase	Icon to convert to lower case the actually focused cell(s) or edited text.
Format	Combo box with popup list to choose number or date format in actually focused Auto cell(s).
AlignLeft	Icon to align left the text in actually focused cell(s).
AlignCenter	Icon to center the text in actually focused cell(s).
AlignRight	Icon to align right the text in actually focused cell(s).
AlignTop	Icon to align top the text in actually focused cell(s) or make the edited text super.
AlignMiddle	Icon to vertically center the text in actually focused cell(s) or make the edited text normal (clear super / sub).
AlignBottom	Icon to align bottom the text in actually focused cell(s) or make the edited text sub.
IndentLeft	Icon to decrease indent in actually focused cell(s).
IndentRight	Icon to increase indent in actually focused cell(s).
Wrap	Icon to switch wrapping text on / off in actually focused cells(s).
Rotate	Icon to set or choose text rotation in actually focused cell(s). Not applicable for toolbar cells.
TextColor	Icon to set or choose text color of actually focused cell(s) or edited text.
TextShadow	Icon to set or choose text shadow style and color of actually focused cell(s) or edited text.
TextLine	Icon to set or choose text line (underline / strike / overline), its style, width and color in actually focused cell(s) or edited text.
Color	Icon to set or choose cell background color, pattern or gradient in actually focused cell(s).
Border	Icon to set or choose border color, style and width of actually focused cell(s). Not applicable for toolbar cells.
ClearStyle	Icon to clear all style settings in actually focused cell(s) or in edited text.
ClearValue	Icon to clear all values in actually focused cell(s) or in edited text.
NoEdit	Icon to choose editing permissions in actually focused cell(s).
Other icons
AddImage	Icon to show system dialog to choose local image file to add to grid into Images for focused cell. On tablets it is replaced by Image tool by Media.
Image	Icon to show menu with options to choose image actions and to show system dialog to choose local image file to add to grid into Images for focused cell.
AddLink	Icon to show prompt to enter link in focused cell(s) or edited text.
Span	Icon to span together focused range of cells.
Split	Icon to split spanned focused cell(s).
Fix	Icon to move all rows above focused row to above part and all columns left to the focused column to left part.
AddTip	Icon to show prompt to enter tip for focused cell(s).
AddName	Icon to show prompt to enter name containing focused cell or cells range. To be used in editable formulas.
Names	Icon to show dialog with all defined names in grid to manipulate them.
Lock	Icon to show list of acual and available locks in grid to change them.
Layout	Icon to show dialog with rows, columns, toolbars and scrollbars to hide or show them.
Settings	Icon to show dialog with FastGrid configuration settings.
Cookies
Cookies	List box with available saved configurations of the grid.
LoadCookie	Icon to load configuration selected in Cookies.
SaveCookie	Icon to save actual configuration to under name selected in Cookies.
DeleteCookie	Icon to delete configuration selected in Cookies.
AddCookie	Icon to show prompt to enter name for new configuration to save, to add it to Cookies.
Pivot
PivotList	Shows popup list from List with predefined pivot choices.
Pivot	Icon with popup to switch the pivot on / off or to show pivot options.
DragPivot	Default cell as column / row actually used for pivot (PivotRows, PivotCols, PivotData).
DragSource	Default cell as column / row actually used as available source to drag to pivot.
DropPivotRows	Drop area for dropping columns / rows to create pivot grid from them.
DropPivotCols	Drop area for dropping columns / rows to create pivot grid from them.
DropPivotData	Drop area for dropping columns / rows to create pivot grid from them.
PivotLabel	Inactive text label for pivot toolbars.
Sheets
Sheet	One sheet in sheet list on Sheets toolbar.
SheetActive	Highlighted sheet (shown in actual grid) in sheet list on Sheets toolbar.
Sheets	Icon to show menu with all sheets in actual book.
AddSheet	Icon to add new empty sheet.
Special cells
Focus	Special combo cell showing actually focused cell or cell range in grid. Editable to change the focus.
ExternalEdit	Special combo cell showing value of actually focused cell in grid. Editable to change the value.
DragToolbar	Special icon cell that is shown as the first cell in every toolbar when DraggingToolbars is on.

Unique identification of the default item. The id must be unique only among defaults of the same kind.
By this id is the default item referred by the D attribute.
By default all default items (without D attribute set) refer to "Base" default item of the same kind.
It is faster but less universal and safe than Get.
Returns D id. If row is null, returns column D, if col is null returns row D, otherwise returns cell D.
row, col can be also Toolbar cell.
It is faster but less universal and safe than Set.
Sets def to the D. If row is null, sets column D, if col is null sets row D, otherwise sets cell D.
Returns true if the attribute value was changed, false if the def is the same as actual D (no change was done) and null for error.
def must be existing default item id of the same kind as the item that is assigned to. def must not be null (except changes = 2).

changes controls how the cell is marked as changed:
0 - simple set - fast, does not mark or clear changes, does not store or change original value, does not test if the value is the same.
1 - set and mark - marks changes, stores original value before the first change, tests if the value is the same. If the value is the same as original value, clears the marked changes.
2 - set, mark and restore - like 2, value can be null to restore original value and clears the marked changes.
3 - set and clear - clears marked changes and clears original value, the new cell value is taken as original unchanged value. Returns false if the value is the same as actual value and no original value is stored.
4 - set and test - like 0 but tests if the value is the same.

changes=1/2/3 is forced to 4 if not set second bit of CellChanges (cell) / ToolChanges (tool) or 7th bit of RowChanges (row) / ColChanges (column)
row, col can be also Toolbar cell.
Creates new default D derived from all defaults in defs list and returns its id.
Def can be object DefRows / DefCols / DefCells / DefTools / DefToolbars. If the Def set null, it is set to DefRows.
id is id of the newly created D. If the id already exists in Def, it is just returned and nothing is created. If the id is null, is create from defs separated by comma.
If more of the merged defaults define the same attribute, the attribute from the first default in defs is used.
It is faster but less universal and safe than Get.
Returns attribute value of given default item.
type can be "Row" to read from DefRows, "Col" to read from DefCols, "Cell" to read from DefCells, "Toolbar" to read from DefToolbars and "Tool" to read from DefTools.
id is the default item id. attr is the attribute name.
Returns null for not existing type, id or attr.
It is faster but less universal and safe than Set.
Sets value to attribute value of given default item.
type can be "Row" to read from DefRows, "Col" to read from DefCols, "Cell" to read from DefCells, "Toolbar" to read from DefToolbars and "Tool" to read from DefTools.
id is the default item id. attr is the attribute name.
Returns true for change, false for the same value (not changed) and null for error. Does not mark changes.