Skip to main content

TableCollection

Excel.TableCollection: every table of the workbook, or of one worksheet. Import from @reductoai/xlsx/officejs.

TableCollection properties

TableCollection.add()

A table over address; without headers Excel inserts a header row above the cells.

TableCollection.getCount()

TableCollection.getItem()

By name (case-insensitive) or id.

TableCollection.getItemAt()

TableCollection.getItemOrNullObject()

ExcelTable

Excel.Table. Edits apply at once and keep every formula that names the table in step. Import from @reductoai/xlsx/officejs.

ExcelTable properties

ExcelTable.clearFilters()

Shows every row and drops every column’s filter.

ExcelTable.convertToRange()

Removes the table and keeps its cells and look; formulas that named it get plain ranges.

ExcelTable.delete()

Removes the table with its values and formats, as Office.js does.

ExcelTable.getDataBodyRange()

ExcelTable.getHeaderRowRange()

ExcelTable.getRange()

ExcelTable.getTotalRowRange()

ExcelTable.reapplyFilters()

Hides and shows rows again by the filters in force.

ExcelTable.resize()

Puts the table over newRange; its top row stays where it is and the ranges overlap.

ExcelTable.set()

Sets several properties at once; a navigation member takes a nested batch.

TableColumn

Excel.TableColumn, keyed by its id in the table part. Import from @reductoai/xlsx/officejs.

TableColumn properties

TableColumn.delete()

Deletes the column’s cells, shifting the table’s cells to its right left.

TableColumn.getDataBodyRange()

TableColumn.getHeaderRowRange()

TableColumn.getRange()

TableColumn.getTotalRowRange()

TableColumn.set()

Sets several properties at once; a navigation member takes a nested batch.

TableRow

Excel.TableRow: a data row by position, as Office.js keys it. Import from @reductoai/xlsx/officejs.

TableRow properties

TableRow.delete()

Deletes the row’s cells, shifting the table’s rows below it up.

TableRow.getRange()

TableRow.set()

Sets several properties at once; a navigation member takes a nested batch.

ExcelFilter

Excel.Filter of one filter column; scope finds the table’s or the sheet’s filter. Import from @reductoai/xlsx/officejs.

ExcelFilter properties

ExcelFilter.apply()

ExcelFilter.applyBottomItemsFilter()

ExcelFilter.applyBottomPercentFilter()

ExcelFilter.applyCellColorFilter()

"" shows the cells with no fill.

ExcelFilter.applyCustomFilter()

Criteria such as ”>=5”, “=ap*” or ”<>” (not blank); two join with oper, And by default.

ExcelFilter.applyDynamicFilter()

ExcelFilter.applyFontColorFilter()

"" shows the cells in the automatic font colour.

ExcelFilter.applyIconFilter()

Written for Excel; rows keep their state here, as icon state is a view matter.

ExcelFilter.applyTopItemsFilter()

ExcelFilter.applyTopPercentFilter()

ExcelFilter.applyValuesFilter()

ExcelFilter.clear()

AutoFilter

Excel.AutoFilter of a worksheet (its own filter buttons) or of one table. Import from @reductoai/xlsx/officejs.

AutoFilter properties

AutoFilter.apply()

Turns the filter on over range (one cell takes its current region, as Excel does) and, with columnIndex and criteria, filters that column. A new range drops the old criteria.

AutoFilter.clearColumnCriteria()

AutoFilter.clearCriteria()

AutoFilter.getRange()

AutoFilter.getRangeOrNullObject()

AutoFilter.reapply()

AutoFilter.remove()

Shows every row and removes the filter buttons.