Interface ITable

A Table is an embedded table that allows for advanced capabilities.

Filtering
Dynamic Styling
External data
Structured formulas

interface ITable {
    isIAnchored: true;
    isITable: true;
    addColumn(
        index?: number,
        values?: Scalar[],
        name?: string,
        options?: ITransaction.OperationOptions,
    ): IColumn;
    addListeners(
        listeners: ITable.IListeners,
        options?: IListener.Options,
    ): Remove;
    addRow(index?: number, options?: ITransaction.OperationOptions): this;
    addRows(
        index: number,
        count?: number,
        options?: ITransaction.OperationOptions,
    ): ITable;
    applyFilters(options?: ITransaction.OperationOptions): Promise<ITable>;
    applySorts(options?: ITransaction.OperationOptions): this;
    applySortsAndFilters(
        options?: ITransaction.OperationOptions,
    ): Promise<ITable>;
    close(): void;
    convertToRange(
        maxCells?: number,
        options?: ITransaction.OperationOptions,
    ): ICellRange;
    delete(options?: ITransaction.OperationOptions): void;
    deleteFilters(options?: ITransaction.OperationOptions): Promise<ITable>;
    deleteRowsAt(
        index: number,
        count?: number,
        options?: ITransaction.OperationOptions,
    ): ITable;
    deleteSorts(options?: ITransaction.OperationOptions): this;
    deleteSortsAndFilters(
        options?: ITransaction.OperationOptions,
    ): Promise<ITable>;
    filter(
        conditions?: ICondition.RangeOptions | Input<any>,
        options?: ITransaction.OperationOptions,
    ): Promise<ITable>;
    getActiveFilters(): readonly IFilter[];
    getActiveSorts(): readonly ISort[];
    getAnchorType?(): IAnchored.Type;
    getAutoExpand(): ITable.AutoExpand;
    getColumn(key: string): IColumn | null;
    getColumnAt(index: number): IColumn | null;
    getColumnById(id: string): IColumn | null;
    getColumnByName(name: string): IColumn | null;
    getColumns(): readonly IColumn[];
    getDataRange(): ICellRange;
    getDescription(): string;
    getFilterAt(index: number): IFilter | null;
    getFormulaBelow(): ITable.FormulaBelow;
    getHeaderRowRange(): ICellRange;
    getId(): string;
    getName(): string;
    getNamed(): INamed<any> | null;
    getRange(): ICellRange;
    getRangedStyle(): ICellRanged<IStyle.Properties<Serializable>>;
    getRanges(options?: ICellRange.GetRangeOptions): ICellRanges;
    getSheet(): ISheet | null;
    getSnapshot(options?: CopyOptions): ITable.ISnapshot;
    getSortAt(index: number): ISort | null;
    getStyle(): ITableStyle;
    getStyleAt(coords: CellCoords): IStyle;
    getStyleOptions(): StyleOptions;
    getTotalRowRange(): ICellRange;
    getVisibleCellCoords(coords: CellCoords): CellCoords;
    getVisibleRefRangeCoords(): Coords;
    isClosed(): boolean;
    isDeleted(): boolean;
    isDisabledColumnFill(): boolean;
    isFirstColumnVisible(): boolean;
    isHeaderVisible(): boolean;
    isHiddenButtonAt(index: number): boolean;
    isHiddenButtons(): boolean;
    isLastColumnVisible(): boolean;
    isProtected(): boolean;
    isShowBandedColumns(): boolean;
    isShowBandedRows(): boolean;
    isShowHeaders(): boolean;
    isShowHighlightFirstColumn(): boolean;
    isShowHighlightLastColumn(): boolean;
    isShowTotals(): boolean;
    isTotalVisible(): boolean;
    resize(
        address: ICellRange.Address,
        options?: ITransaction.OperationOptions,
    ): ICellRange;
    resizeTo(
        rowCount: number,
        colCount: number,
        options?: ITransaction.OperationOptions,
    ): ICellRange;
    select(options?: ICellRange.SelectOptions): Promise<ICellRange>;
    setAutoExpand(
        autoExpand: ITable.AutoExpand,
        options?: ITransaction.OperationOptions,
    ): this;
    setDescription(
        description: string | null,
        options?: ITransaction.OperationOptions,
    ): ITable;
    setDisabledColumnFill(
        disabledColumnFill: boolean,
        options?: ITransaction.OperationOptions,
    ): this;
    setFormulaBelow(
        formulaBelow: ITable.FormulaBelow,
        options?: ITransaction.OperationOptions,
    ): this;
    setHiddenButtonAt(index: number, hidden: boolean): this;
    setHiddenButtons(hidden: boolean): this;
    setName(name: string, options?: ITransaction.OperationOptions): ITable;
    setShowBandedColumns(
        showBandedColumns: boolean,
        options?: ITransaction.OperationOptions,
    ): this;
    setShowBandedRows(
        showBandedRows: boolean,
        options?: ITransaction.OperationOptions,
    ): this;
    setShowHeaders(
        showHeaders: boolean,
        options?: ITransaction.OperationOptions,
    ): this;
    setShowHighlightFirstColumn(
        showHighlightFirstColumn: boolean,
        options?: ITransaction.OperationOptions,
    ): this;
    setShowHighlightLastColumn(
        showHighlightLastColumn: boolean,
        options?: ITransaction.OperationOptions,
    ): this;
    setShowTotals(
        showTotals: boolean,
        options?: ITransaction.OperationOptions,
    ): this;
    sort(options?: ISort.RangeOptions & ITransaction.OperationOptions): this;
    toJSON(): ITable.JSON | null;
    updateStyleOptions(options: StyleOptions): ITable;
}

Hierarchy (View Summary)

IAnchored
- ITable

Implemented by

Table

Index

Properties

isIAnchored isITable

Methods

addColumn addListeners addRow addRows applyFilters applySorts applySortsAndFilters close convertToRange delete deleteFilters deleteRowsAt deleteSorts deleteSortsAndFilters filter getActiveFilters getActiveSorts getAnchorType? getAutoExpand getColumn getColumnAt getColumnById getColumnByName getColumns getDataRange getDescription getFilterAt getFormulaBelow getHeaderRowRange getId getName getNamed getRange getRangedStyle getRanges getSheet getSnapshot getSortAt getStyle getStyleAt getStyleOptions getTotalRowRange getVisibleCellCoords getVisibleRefRangeCoords isClosed isDeleted isDisabledColumnFill isFirstColumnVisible isHeaderVisible isHiddenButtonAt isHiddenButtons isLastColumnVisible isProtected isShowBandedColumns isShowBandedRows isShowHeaders isShowHighlightFirstColumn isShowHighlightLastColumn isShowTotals isTotalVisible resize resizeTo select setAutoExpand setDescription setDisabledColumnFill setFormulaBelow setHiddenButtonAt setHiddenButtons setName setShowBandedColumns setShowBandedRows setShowHeaders setShowHighlightFirstColumn setShowHighlightLastColumn setShowTotals sort toJSON updateStyleOptions

Properties

`Readonly`isIAnchored

isIAnchored: true

For runtime type checking.

`Readonly`isITable

isITable: true

For runtime type checking.

Methods

addColumn

addColumn(
    index?: number,
    values?: Scalar[],
    name?: string,
    options?: ITransaction.OperationOptions,
): IColumn
Add a single column.
Parameters
- Optionalindex: number
- Optionalvalues: Scalar[]
- Optionalname: string
- Optionaloptions: ITransaction.OperationOptions
Returns IColumn

Remarks
Not implemented To remove columns use the resize

addListeners

addListeners(listeners: ITable.IListeners, options?: IListener.Options): Remove
Add Listeners.
Parameters
- listeners: ITable.IListeners
- Optionaloptions: IListener.Options
Returns Remove

See
IListener.ISource.addListeners

Overrides IAnchored.addListeners

addRow

addRow(index?: number, options?: ITransaction.OperationOptions): this
Add a single row to the table.
Parameters
- Optionalindex: number
  The body row the new row goes in before, 0 being the first. Omitted, the row is added at the end.
- Optionaloptions: ITransaction.OperationOptions
Returns this

Remarks
This is a convenience method for (index, 1)

addRows

addRows(
    index: number,
    count?: number,
    options?: ITransaction.OperationOptions,
): ITable
Add a number of rows to a table.
Parameters
- index: number
  The body row the new rows go in before, 0 being the first. An index at or past the number of body rows adds them at the end, above the totals row if there is one.
- Optionalcount: number
  The number of rows to add. Defaults to 1.
- Optionaloptions: ITransaction.OperationOptions
Returns ITable
Remarks
The rows are inserted across the table's columns only: cells below the table move down, and cells beside it stay where they are. A calculated column gives the new rows its formula.
Example
```
table.addRows(0, 2); // two rows at the top of the body
table.addRow();      // one at the end
```

applyFilters

applyFilters(options?: ITransaction.OperationOptions): Promise<ITable>
Applies all filters using the existing criteria.
Parameters
- Optionaloptions: ITransaction.OperationOptions
Returns Promise<ITable>
Resolves once the rows are hidden; one transaction, one undo step.

Remarks
Does not change criteria; only recomputes which rows are visible.

applySorts

applySorts(options?: ITransaction.OperationOptions): this
Applies all sorts using the existing criteria.
Parameters
- Optionaloptions: ITransaction.OperationOptions
Returns this

Remarks
Does not change criteria; only recomputes order.

applySortsAndFilters

applySortsAndFilters(options?: ITransaction.OperationOptions): Promise<ITable>
Applies both applyFilters and applySorts, in that order, as one transaction.
Parameters
- Optionaloptions: ITransaction.OperationOptions
Returns Promise<ITable>

close

close(): void

Similar to delete but cleans resources and can't be undone.

Returns void

Inherited from IAnchored.close

convertToRange

convertToRange(
maxCells?: number,
options?: ITransaction.OperationOptions,
): ICellRange
Convert the existing table to a range. This will remove the table but preserve the original data and formatting.
Parameters
- OptionalmaxCells: number
  The maximum number of convert.
- Optionaloptions: ITransaction.OperationOptions
Returns ICellRange

Remarks
This can be an expensive operation.

A formula that references the table has each reference replaced by the absolute address it designated (Sheet1!$A$2:$C$4).

delete

delete(options?: ITransaction.OperationOptions): void
Deletes the table and clears its cells.
Parameters
- Optionaloptions: ITransaction.OperationOptions
Returns void

Remarks
A formula that references the table has each reference replaced by #REF!.

See
ITable.convertToRange to remove the table and keep its cells.

Overrides IAnchored.delete

deleteFilters

deleteFilters(options?: ITransaction.OperationOptions): Promise<ITable>
Clears all filters and shows every row of the table, as Excel's Clear does — a row hidden by hand inside the table comes back too. The header and totals rows are never touched.
Parameters
- Optionaloptions: ITransaction.OperationOptions
Returns Promise<ITable>

deleteRowsAt

deleteRowsAt(
    index: number,
    count?: number,
    options?: ITransaction.OperationOptions,
): ITable
Delete the rows from the table.
Parameters
- index: number
  The index to clear from
- Optionalcount: number
- Optionaloptions: ITransaction.OperationOptions
Returns ITable

Remarks
Not implemented

deleteSorts

deleteSorts(options?: ITransaction.OperationOptions): this
Deletes all sorts.
Parameters
- Optionaloptions: ITransaction.OperationOptions
Returns this

deleteSortsAndFilters

deleteSortsAndFilters(options?: ITransaction.OperationOptions): Promise<ITable>
Deletes both sorts and filters as one transaction.
Parameters
- Optionaloptions: ITransaction.OperationOptions
Returns Promise<ITable>

filter

filter(
conditions?: ICondition.RangeOptions | Input<any>,
options?: ITransaction.OperationOptions,
): Promise<ITable>
Replaces the filter levels and hides the rows that fail them.
Parameters
- Optionalconditions: ICondition.RangeOptions | Input<any>
  undefined or { conditions: [] } → clears every filter, as deleteFilters.
  
  a bare ICondition.Input → one filter on the first column, as ICellRange.filter.
  
  { conditions: [...] } → one level per condition, on the column each index names (its position in the array when omitted), in that order.
- Optionaloptions: ITransaction.OperationOptions
Returns Promise<ITable>
Resolves once the rows are hidden; one transaction, one undo step.

Remarks
Every row the table holds is judged, whatever hid it before (includeHidden defaults to true for a filter); the header and totals rows are never evaluated or hidden.

getActiveFilters

getActiveFilters(): readonly IFilter[]

Returns the active filter entries as handle objects,

Returns readonly IFilter[]

getActiveSorts

getActiveSorts(): readonly ISort[]

Returns the active sorts ordered by priority.

Returns readonly ISort[]

Remarks
These are ordered by priority (primary → secondary → ...).

`Optional`getAnchorType

getAnchorType?(): IAnchored.Type
Returns how the anchorBounds adjust when inserting/removing rows/columns.

Returns IAnchored.Type
Default Value
```
IAnchored.Type.TwoCell
```
Inherited from IAnchored.getAnchorType

getAutoExpand

getAutoExpand(): ITable.AutoExpand

Returns which edges of the table grow when something is entered just beside it.

Returns ITable.AutoExpand

getColumn

getColumn(key: string): IColumn | null
Returns a column for the given name or ID.
Parameters
- key: string
  The name of the column.
Returns IColumn | null
The column or null if not found.

getColumnAt

getColumnAt(index: number): IColumn | null
Returns an column for the given index.
Parameters
- index: number
  The index of the column.
Returns IColumn | null
The column or null if not found.

getColumnById

getColumnById(id: string): IColumn | null
Returns a column for the given ID.
Parameters
- id: string
  The id of the column.
Returns IColumn | null
The column or null if not found.

getColumnByName

getColumnByName(name: string): IColumn | null
Returns a column for the given name.
Parameters
- name: string
  The name of the column.
Returns IColumn | null
The column or null if not found.

getColumns

getColumns(): readonly IColumn[]

Returns the columns for this table.

Returns readonly IColumn[]

getDataRange

getDataRange(): ICellRange

Get the range between the header and the total.

Returns ICellRange

Remarks
Excel calls this the getRangeBetweenHeaderAndTotal()

getDescription

getDescription(): string

Returns string

See
setDescription

getFilterAt

getFilterAt(index: number): IFilter | null
Returns the filter at the specified index, or null if none.
Parameters
- index: number
Returns IFilter | null

getFormulaBelow

getFormulaBelow(): ITable.FormulaBelow

Returns where a formula entered in the row just below the table goes.

Returns ITable.FormulaBelow

getHeaderRowRange

getHeaderRowRange(): ICellRange

Get the header row range.

Returns ICellRange

getId

getId(): string

The unique id of the table.

Returns string

Remarks
This will not change during the lifetime of the table.

getName

getName(): string

Returns string

See
setName

Overrides IAnchored.getName

getNamed

getNamed(): INamed<any> | null

The table's entry in the workbook's names, or null if it is not named.

Returns INamed<any> | null

Remarks
A table's name is derived — it exists because the table does. The name collection reads this rather than being handed a copy, so a deleted table stops being named without anything having to remove it.

getRange

getRange(): ICellRange

Returns the range for the entire table.

Returns ICellRange

Remarks
A table occupies exactly one rectangle, which is why the singular is declared here rather than on IAnchored. Invalid, never null, once the table is no longer anchored.

getRangedStyle

getRangedStyle(): ICellRanged<IStyle.Properties<Serializable>>

Returns the table style resolved against this table's geometry, as a per-cell properties provider.

Returns ICellRanged<IStyle.Properties<Serializable>>

Remarks
The instance is memoized per table (and invalidated on any table or table-styles change), so it can cache per-cell resolutions. Prefer this over getStyle().getRanged(table), which allocates a fresh uncached instance.

getRanges

getRanges(options?: ICellRange.GetRangeOptions): ICellRanges
Returns the ranges this object is anchored to, in authored order.
Parameters
- Optionaloptions: ICellRange.GetRangeOptions
Returns ICellRanges
Remarks
- Never null. An item whose last range was removed by a row/column delete returns an invalid ranges — ask ICellRanges.isInvalid, the same contract as ITable.getDataRange.
- This is the general accessor. Most anchored types hold exactly one range and declare their own getRange() for it, but data validations, conditional formats and protected ranges are authored as several, and any single range can become several when a delete splits it.
Inherited from IAnchored.getRanges

getSheet

getSheet(): ISheet | null

Returns the sheet the table is associated with.

Returns ISheet | null

getSnapshot

getSnapshot(options?: CopyOptions): ITable.ISnapshot
Returns a snapshot of the table that can be used for copying and archiving.
Parameters
- Optionaloptions: CopyOptions
Returns ITable.ISnapshot

getSortAt

getSortAt(index: number): ISort | null
Returns the sort at the specified index.
Parameters
- index: number
Returns ISort | null
A sort object (which may have a null criteria) or null if the index is invalid or the table is closed.

getStyle

getStyle(): ITableStyle

Returns the current ITableStyle used.

Returns ITableStyle

getStyleAt

getStyleAt(coords: CellCoords): IStyle
Returns a cell style for the given coords.
Parameters
- coords: CellCoords
  The absolute coords.
Returns IStyle
Remarks
This will return a CellStyle rendered with the table styling but not any other styling.
- This is used by the preview.

getStyleOptions

getStyleOptions(): StyleOptions

Get the style info.

Returns StyleOptions

getTotalRowRange

getTotalRowRange(): ICellRange

Get the total row range.

Returns ICellRange

getVisibleCellCoords

getVisibleCellCoords(coords: CellCoords): CellCoords
Returns the coords after any hidden values are applied.
Parameters
- coords: CellCoords
  The absolute coords
Returns CellCoords

getVisibleRefRangeCoords

getVisibleRefRangeCoords(): Coords

Returns the bounds for the ref accounting for hidden headers.

Returns Coords

Remarks
This is used for borders and drag areas that are based on visible edges. excluding hidden rows/columns (headers).

isClosed

isClosed(): boolean

Returns if the model has been closed

Returns boolean

Inherited from IAnchored.isClosed

isDeleted

isDeleted(): boolean

Returns if the model has been deleted

Returns boolean

Inherited from IAnchored.isDeleted

isDisabledColumnFill

isDisabledColumnFill(): boolean

Returns if the table is set to not fill a formula down its column.

Returns boolean

isFirstColumnVisible

isFirstColumnVisible(): boolean

Returns a flag indicating if the first column is visible due to hidden headers.

Returns boolean

isHeaderVisible

isHeaderVisible(): boolean

Returns a flag indicating if the header is visible due to hidden headers.

Returns boolean

Remarks
To know if the header flag is set use isShowHeaders

isHiddenButtonAt

isHiddenButtonAt(index: number): boolean
Returns whether the filter/sort button at the specified index is hidden.
Parameters
- index: number
Returns boolean

isHiddenButtons

isHiddenButtons(): boolean

This will only return true if all buttons are hidden.

Returns boolean

isLastColumnVisible

isLastColumnVisible(): boolean

Returns a flag indicating if the first column is visible due to hidden headers.

Returns boolean

isProtected

isProtected(): boolean

If the anchor is unable to be modified.

Returns boolean

Inherited from IAnchored.isProtected

isShowBandedColumns

isShowBandedColumns(): boolean

Specifies if banded columns is being applied.

Returns boolean

isShowBandedRows

isShowBandedRows(): boolean

Specifies if banded rows is being applied.

Returns boolean

isShowHeaders

isShowHeaders(): boolean

Specifies if headers are being shown for the table.

Returns boolean

isShowHighlightFirstColumn

isShowHighlightFirstColumn(): boolean

Specifies if first column is being highlighted.

Returns boolean

isShowHighlightLastColumn

isShowHighlightLastColumn(): boolean

Specifies if last column is being highlighted.

Returns boolean

isShowTotals

isShowTotals(): boolean

Specifies if totals are being shown for the table.

Returns boolean

isTotalVisible

isTotalVisible(): boolean

Returns a flag indicating if the footer is visible due to hidden headers.

Returns boolean

resize

resize(
address: ICellRange.Address,
options?: ITransaction.OperationOptions,
): ICellRange
Resize the table.
Parameters
- address: ICellRange.Address
  The new size of the table.
- Optionaloptions: ITransaction.OperationOptions
Returns ICellRange
Remarks
This will throw an exception if:
1. The top row changes.
2. If doesn't overlap with the original table.
3. If overlaps with another non-overlapping object (e.g. another table or a merge).

resizeTo

resizeTo(
    rowCount: number,
    colCount: number,
    options?: ITransaction.OperationOptions,
): ICellRange
Resizes the current range to the specified ending row and column indices.
Parameters
- rowCount: number
  The new row count.
- colCount: number
  The new column count.
- Optionaloptions: ITransaction.OperationOptions
Returns ICellRange
ICellRange with the resized range.

Remarks
This is slightly different that ICellRange.getSizeTo in that it is relative.

select

select(options?: ICellRange.SelectOptions): Promise<ICellRange>
Selects the current table.
Parameters
- Optionaloptions: ICellRange.SelectOptions
Returns Promise<ICellRange>
An async boolean indicating the table was selected.

setAutoExpand

setAutoExpand(
autoExpand: ITable.AutoExpand,
options?: ITransaction.OperationOptions,
): this
Set which edges of the table grow when something is entered just beside it.
Parameters
- autoExpand: ITable.AutoExpand
- Optionaloptions: ITransaction.OperationOptions
Returns this

Remarks
The growth is its own step, so the first undo takes back the growth and keeps what was entered.

setDescription

setDescription(
description: string | null,
options?: ITransaction.OperationOptions,
): ITable
This is the alternative text use for assistive technologies.
Parameters
- description: string | null
  A short human readable text. Default value null.
- Optionaloptions: ITransaction.OperationOptions
Returns ITable

setDisabledColumnFill

setDisabledColumnFill(
disabledColumnFill: boolean,
options?: ITransaction.OperationOptions,
): this
If true a formula entered into one cell of an empty column is not filled down the column.
Parameters
- disabledColumnFill: boolean
- Optionaloptions: ITransaction.OperationOptions
Returns this

Remarks
A column that is already calculated keeps its formula, and rows added to the table are still given it.

setFormulaBelow

setFormulaBelow(
formulaBelow: ITable.FormulaBelow,
options?: ITransaction.OperationOptions,
): this
Set where a formula entered in the row just below the table goes.
Parameters
- formulaBelow: ITable.FormulaBelow
- Optionaloptions: ITransaction.OperationOptions
Returns this
Example
```
// formulas typed under the table become new rows, as values do
table.setFormulaBelow(ITable.FormulaBelow.InsideTable);
```

setHiddenButtonAt

setHiddenButtonAt(index: number, hidden: boolean): this
Sets whether the filter/sort button at the specified index is hidden.
Parameters
- index: number
- hidden: boolean
Returns this

setHiddenButtons

setHiddenButtons(hidden: boolean): this
If hidden is true then all filter/sort buttons are hidden.
Parameters
- hidden: boolean
Returns this

setName

setName(name: string, options?: ITransaction.OperationOptions): ITable
Set the name for a table object.
Parameters
- name: string
  A unique name.
- Optionaloptions: ITransaction.OperationOptions
Returns ITable

setShowBandedColumns

setShowBandedColumns(
showBandedColumns: boolean,
options?: ITransaction.OperationOptions,
): this
Specifies if banded columns is being applied.
Parameters
- showBandedColumns: boolean
- Optionaloptions: ITransaction.OperationOptions
Returns this

setShowBandedRows

setShowBandedRows(
showBandedRows: boolean,
options?: ITransaction.OperationOptions,
): this
Specifies if banded rows is being applied.
Parameters
- showBandedRows: boolean
- Optionaloptions: ITransaction.OperationOptions
Returns this

setShowHeaders

setShowHeaders(
showHeaders: boolean,
options?: ITransaction.OperationOptions,
): this
Specifies if headers are being shown for the table.
Parameters
- showHeaders: boolean
- Optionaloptions: ITransaction.OperationOptions
Returns this

setShowHighlightFirstColumn

setShowHighlightFirstColumn(
showHighlightFirstColumn: boolean,
options?: ITransaction.OperationOptions,
): this
Specifies if first column is being highlighted.
Parameters
- showHighlightFirstColumn: boolean
- Optionaloptions: ITransaction.OperationOptions
Returns this

setShowHighlightLastColumn

setShowHighlightLastColumn(
showHighlightLastColumn: boolean,
options?: ITransaction.OperationOptions,
): this
Specifies if last column is being highlighted.
Parameters
- showHighlightLastColumn: boolean
- Optionaloptions: ITransaction.OperationOptions
Returns this

setShowTotals

setShowTotals(
showTotals: boolean,
options?: ITransaction.OperationOptions,
): this
Specifies if totals are being shown for the table.
Parameters
- showTotals: boolean
- Optionaloptions: ITransaction.OperationOptions
Returns this

sort

sort(options?: ISort.RangeOptions & ITransaction.OperationOptions): this
Replaces the sort chain.
Parameters
- Optionaloptions: ISort.RangeOptions & ITransaction.OperationOptions
  undefined or no sorts → clears existing sort levels.
  
  sorts: [] → explicitly clears all sort levels.
  
  sorts: [...] → replaces the sort levels (primary → secondary → ...).
Returns this

toJSON

toJSON(): ITable.JSON | null

Returns ITable.JSON | null
The current state as a JSON object or null if the table is closed.

updateStyleOptions

updateStyleOptions(options: StyleOptions): ITable
Updates the table StyleInfo.
Parameters
- options: StyleOptions
  Style options unique to the table.
Returns ITable

Remarks
This will merge with the existing values.

Deprecated

Interface ITable

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

ReadonlyisIAnchored

ReadonlyisITable

Methods

addColumn

Parameters

Returns IColumn

Remarks

addListeners

Parameters

Returns Remove

See

addRow

Parameters

Returns this

Remarks

addRows

Parameters

Returns ITable

Remarks

Example

applyFilters

Parameters

Returns Promise<ITable>

Remarks

applySorts

Parameters

Returns this

Remarks

applySortsAndFilters

Parameters

Returns Promise<ITable>

close

Returns void

convertToRange

Parameters

Returns ICellRange

Remarks

delete

Parameters

Returns void

Remarks

See

deleteFilters

Parameters

Returns Promise<ITable>

deleteRowsAt

Parameters

Returns ITable

Remarks

deleteSorts

Parameters

Returns this

deleteSortsAndFilters

Parameters

Returns Promise<ITable>

filter

Parameters

Returns Promise<ITable>

Remarks

getActiveFilters

Returns readonly IFilter[]

getActiveSorts

Returns readonly ISort[]

Remarks

OptionalgetAnchorType

Returns IAnchored.Type

Default Value

getAutoExpand

Returns ITable.AutoExpand

getColumn

Parameters

Returns IColumn | null

getColumnAt

`Readonly`isIAnchored

`Readonly`isITable

`Optional`getAnchorType