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, name?: string): Column;
    addListeners(listeners: IListeners, options?: IListener.Options): Remove;
    addRows(offset: number, count?: number): ITable;
    close(): void;
    convertToRange(maxCells?: number): ICellRange;
    delete(): void;
    deleteRowsAt(index: number, count?: number): ITable;
    getAnchorCoords(): IRange.Coords;
    getAnchorType(): IAnchored.Type;
    getColumnFilter(offset: number): IColumn;
    getColumns(): Column[];
    getDescription(): string;
    getFilter(): IAutoFilter;
    getFilter(): IAutoFilter;
    getHeaderRange(): ICellRange;
    getName(): string;
    getRange(): ICellRange;
    getShowFilterButton(): boolean;
    getShowHeaders(): boolean;
    getShowTotals(): boolean;
    getSnapshot(options?: ReferenceableClipboard.CopyOptions): ISnapshot;
    getSort(): IAutoSort;
    getStyle(): ITableStyle;
    getStyleAt(coords: IRange.CellCoords): IStyle;
    getStyleOptions(): StyleOptions;
    getTotalRange(): ICellRange;
    getUsedRange(): ICellRange;
    getVisibleCellCoords(coords: IRange.CellCoords): IRange.CellCoords;
    getVisibleRefRangeCoords(): IRange.Coords;
    insertFilter(): IAutoFilter;
    insertSort(): IAutoSort;
    isClosed(): boolean;
    isFirstColumnVisible(): boolean;
    isHeaderVisible(): boolean;
    isLastColumnVisible(): boolean;
    isProtected(): boolean;
    isTotalVisible(): boolean;
    resize(address: ICellRange.Address): ICellRange;
    select(options?: ICellRange.SelectOptions): Promise<ICellRange>;
    setDescription(description: string): ITable;
    setName(name: string): ITable;
    setShowFilterButton(showFilterButton: boolean): ITable;
    setShowHeaders(showHeaders: boolean): ITable;
    setShowTotals(showTotals: boolean): ITable;
    toJSON(): ITable.JSON;
    updateStyleOptions(options: StyleOptions): ITable;
}

Hierarchy (View Summary)

IAnchored
- ITable

Implemented by

Table

Properties

`Readonly`isIAnchored

isIAnchored: true

For runtime type checking.

`Readonly`isITable

isITable: true

For runtime type checking.

Methods

addColumn

addColumn(index: number, name?: string): Column
Add a single column.
Parameters
- index: number
- Optionalname: string
Returns Column
Remarks
Not implemented To remove columns use the resize

addListeners

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

Overrides IAnchored.addListeners

addRows

addRows(offset: number, count?: number): ITable
Add a number of rows to a table
Parameters
- offset: number
- Optionalcount: number
Returns ITable
Remarks
Not implemented

close

close(): void
Similar to delete but cleans resources and can't be undone.

Returns void
Inherited from IAnchored.close

convertToRange

convertToRange(maxCells?: number): 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.
Returns ICellRange
Remarks
This can be an expensive operation.

delete

delete(): void
Deletes the anchored item.

Returns void
Inherited from IAnchored.delete

deleteRowsAt

deleteRowsAt(index: number, count?: number): ITable
Delete the rows from the table.
Parameters
- index: number
  The index to clear from
- Optionalcount: number
Returns ITable
Remarks
Not implemented

getAnchorCoords

getAnchorCoords(): IRange.Coords
Returns the anchor.

Returns IRange.Coords
Inherited from IAnchored.getAnchorCoords

`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

getColumnFilter

getColumnFilter(offset: number): IColumn
Returns an column for the given offset.
Parameters
- offset: number
Returns IColumn

getColumns

getColumns(): Column[]
Returns the columns for this table.

Returns Column[]

getDescription

getDescription(): string
Returns string
See
setDescription

getFilter

getFilter(): IAutoFilter
Returns the AutoFilter used for this table.

Returns IAutoFilter
getFilter(): IAutoFilter
Returns an IAutoFilter associated with this Table.

Returns IAutoFilter

getHeaderRange

getHeaderRange(): ICellRange
Get the header range.

Returns ICellRange

getName

getName(): string
Returns string
See
setName

getRange

getRange(): ICellRange
Returns the range for the entire table.

Returns ICellRange

getShowFilterButton

getShowFilterButton(): boolean
Specifies if filter buttons are being shown.

Returns boolean

getShowHeaders

getShowHeaders(): boolean
Specifies if headers are being shown for the table.

Returns boolean

getShowTotals

getShowTotals(): boolean
Specifies if totals are being shown for the table.

Returns boolean

getSnapshot

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

getSort

getSort(): IAutoSort
Returns the current sort or null if there is no IAutoSort.

Returns IAutoSort
See
insertSort

getStyle

getStyle(): ITableStyle
Returns the current ITableStyle used.

Returns ITableStyle

getStyleAt

getStyleAt(coords: IRange.CellCoords): IStyle
Returns a cell style for the given coords.
Parameters
- coords: IRange.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

getTotalRange

getTotalRange(): ICellRange
Get the total range.

Returns ICellRange

getUsedRange

getUsedRange(): ICellRange
Get the range between the header and the total.

Returns ICellRange

getVisibleCellCoords

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

getVisibleRefRangeCoords

getVisibleRefRangeCoords(): IRange.Coords
Returns the bounds for the ref accounting for hidden headers.

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

insertFilter

insertFilter(): IAutoFilter
Enabled and returns an IAutoFilter. Only one AutoFilter per table is supported so this will return the same instance if it has already been created.

Returns IAutoFilter

insertSort

insertSort(): IAutoSort
Only one sort per table is supported so this will. return the same instance if it has already been created.

Returns IAutoSort

isClosed

isClosed(): boolean
Returns if the model has been closed

Returns boolean
Inherited from IAnchored.isClosed

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

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

isTotalVisible

isTotalVisible(): boolean
Returns a flag indicating if the footer is visible due to hidden headers.

Returns boolean

resize

resize(address: ICellRange.Address): ICellRange
Resize the table.
Parameters
- address: ICellRange.Address
  The new size of the table.
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).

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.

setDescription

setDescription(description: string): ITable
This is the alternative text use for assistive technologies.
Parameters
- description: string
  A short human readable text. Default value null.
Returns ITable

setName

setName(name: string): ITable
Set the name for a table object.
Parameters
- name: string
  A unique name.
Returns ITable

setShowFilterButton

setShowFilterButton(showFilterButton: boolean): ITable
Specifies if filter buttons are being shown.
Parameters
- showFilterButton: boolean
Returns ITable
Remarks
If the autoFilter is not enabled this will have no effect.

setShowHeaders

setShowHeaders(showHeaders: boolean): ITable
Specifies if headers are being shown for the table.
Parameters
- showHeaders: boolean
Returns ITable

setShowTotals

setShowTotals(showTotals: boolean): ITable
Specifies if totals are being shown for the table.
Parameters
- showTotals: boolean
Returns ITable

toJSON

toJSON(): ITable.JSON
Returns ITable.JSON
The current state as a JSON object.

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.

Interface ITable

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

ReadonlyisIAnchored

ReadonlyisITable

Methods

addColumn

Parameters

Returns Column

Remarks

addListeners

Parameters

Returns Remove

See

addRows

Parameters

Returns ITable

Remarks

close

Returns void

convertToRange

Parameters

Returns ICellRange

Remarks

delete

Returns void

deleteRowsAt

Parameters

Returns ITable

Remarks

getAnchorCoords

Returns IRange.Coords

OptionalgetAnchorType

Returns IAnchored.Type

Default Value

getColumnFilter

Parameters

Returns IColumn

getColumns

Returns Column[]

getDescription

Returns string

See

getFilter

Returns IAutoFilter

Returns IAutoFilter

getHeaderRange

Returns ICellRange

getName

Returns string

See

getRange

Returns ICellRange

getShowFilterButton

Returns boolean

getShowHeaders

Returns boolean

getShowTotals

Returns boolean

getSnapshot

Parameters

Returns ISnapshot

getSort

Returns IAutoSort

See

getStyle

Returns ITableStyle

getStyleAt

Parameters

Returns IStyle

Remarks

getStyleOptions

Returns StyleOptions

getTotalRange

Returns ICellRange

getUsedRange

`Readonly`isIAnchored

`Readonly`isITable

`Optional`getAnchorType