Readonly bodyProtected columnProtected contentProtected contentReadonly defaultReadonly fixedReadonly fixedReadonly footerProtected footerfalse: the footer is hidden (height 0), see setFooterVisible.
Readonly headerProtected headerfalse: the header is hidden (height 0), see setHeaderVisible.
Protected overridingProtected paddingProtected parentReadonly rowProtected rowReadonly sheetProtected xStatic Protected Readonly DEFAULT_Width in px of a column without ColumnDef and without columnSizes (like the default of ColumnDef).
Sorts the items using the given sortItems array.
An array of sort items to sort the items.
This method is called when an external filter is changed.
The function used to predict whether an element should be filtered or not.
Calculates the height of the area identified by the given area identifier – the height of the rows the table draws (since 1.1.107 the same source as the rendering):
getConstantRowHeight() of the area model (> 0): row count × that height – O(1), also for millions of rows,getRowHeight(i) of all rows (variable heights; O(n), like the row layout of the body),getRowHeight(i) is 0): row count ×
defaultRowHeights[area].Before 1.1.107 defaultRowHeights[area] came first: an area model with other heights got a wrong scroll height
(a scroll bar without overflow, a wrong thumb). The built-in area models take their row height from
defaultRowHeights anyway, so nothing changes for them.
The identifier of the area.
// an own body with 20 px rows: 3000 rows are 60,000 px high – also if defaultRowHeights.body is 34
const height = (tableModel as TableModel).getAreaHeight("body");
Retrieves the area model (header, body or footer) based on the area identification.
The identifier of the area.
The area model corresponding to the given area identification.
If the area identification is invalid.
Returns the body area model.
The body area model.
Returns the column definition at the specified index.
The index of the column definition to retrieve.
Returns an array of ColumnDefIf objects or undefined.
An array of ColumnDefIf objects or undefined.
Retrieves the property key of the table row business object associated with the specified column index. It's only available when columnDefs are specified.
The index of the column to retrieve the property from.
The property associated with the specified column index.
Retrieves the model for the given row area identifier.
The identifier of the row area.
Returns the height of the specified row in the given row area identifier.
The row area identifier.
The index of the row.
Returns the total width of the side area identified by sideIdent.
The identifier of the side area ("west" | "center" | "east").
Retrieves the start and end column indices based on the given side identifier.
The side identifier, which can be "west", "east", or "center".
Whether a column is shown (ColumnDefIf.isVisible). Columns without a column definition are always shown.
column index, property or column definition
false for hidden and for unknown columns
const hidden = tableModel.isColumnVisible?.("category") === false;
Checks if the footer is visible: it has rows and is not hidden with setFooterVisible.
True if the footer is visible, false otherwise.
Checks if the header area is visible: it has rows and is not hidden with setHeaderVisible.
Returns true if the header area is visible, otherwise false.
Recalculates the height and padding for the body area.
This method retrieves the area model for the "body" area, and updates the rowCount property with the row count of the model.
The contentHeightInPx property is then updated with the height of the "body" area.
The method calls the recalcContentWidthInPx() method to recalculate the content width.
Finally, the method calls the recalcPadding() method to recalculate the padding.
Shows or hides a column. The column keeps its definition, position and width – a hidden column has the width 0 (getColumnWidth), is not rendered, copied or exported; showing it again restores its width.
Works through ColumnDefIf.isVisible: it is replaced by TrueFn / FalseFn (an own
isVisible function of the column is replaced, too). Columns without a column definition can't be hidden.
With header groups (AreaModelCellGroups) the column is shown only if neither this method nor a collapsed
group hides it – expanding the group does not bring back a column hidden here, and vice versa.
Weight widths (new Size(1, "weight")) are shared among the shown columns.
Recalculates the content width, the padding (fixed columns) and the x positions. Only changes the model –
TableApi.setColumnVisible also repaints the table.
column index (fixed columns included), property or column definition
false hides the column
false if there is no such column definition
tableModel.setColumnVisible?.("category", false);
Sets the width in pixel of a column (by columnIndex) in a table.
The width is also stored in the column's ColumnDef (width = the new px size), so it survives a host resize
(the widths are recalculated from the ColumnDefs then).
The index of the column.
The desired width of the column.
Shows or hides the footer. A hidden footer takes no space; its area model and rows stay unchanged. Only changes the model – TableApi.setFooterVisible also repaints the table.
false hides the footer
tableModel.setFooterVisible?.(false);
Shows or hides the header. A hidden header takes no space (the body moves up); its area model and rows stay unchanged, so showing it again restores it. Only changes the model – TableApi.setHeaderVisible also repaints the table.
false hides the header
tableModel.setHeaderVisible?.(false);
The table model of a spreadsheet (SpreadsheetFactory): its data columns can be inserted and deleted (
TableApi.insertColumns).Since
1.1.99