Represents a region of cells formatted as a table.

Constructors

Section titled "Constructors"

WorksheetTable

new WorksheetTable(a: string, b: number, c: number, d: number, e: number, f: number): WorksheetTable

Returns WorksheetTable

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

comment

Section titled "comment"

Inherited from: NamedReferenceBase 

comment: string

displayBandedColumns

Section titled "displayBandedColumns" 
displayBandedColumns: boolean

displayBandedRows

Section titled "displayBandedRows" 
displayBandedRows: boolean

displayFirstColumnFormatting

Section titled "displayFirstColumnFormatting" 
displayFirstColumnFormatting: boolean

displayLastColumnFormatting

Section titled "displayLastColumnFormatting" 
displayLastColumnFormatting: boolean

isFilterUIVisible

Section titled "isFilterUIVisible" 
isFilterUIVisible: boolean

isHeaderRowVisible

Section titled "isHeaderRowVisible" 
isHeaderRowVisible: boolean

isTotalsRowVisible

Section titled "isTotalsRowVisible" 
isTotalsRowVisible: boolean

name

Section titled "name"

Inherited from: NamedReferenceBase 

name: string

style

Section titled "style" 
style: WorksheetTableStyle

Accessors

Section titled "Accessors"

dataAreaRegion

Section titled "dataAreaRegion"

Gets the [[WorksheetRegion]] which represents the region of cells in the data area of the table.

get dataAreaRegion(): WorksheetRegion

Returns WorksheetRegion

headerRowRegion

Section titled "headerRowRegion"

Gets the [[WorksheetRegion]] which represents the region of cells in the header row of the table. A WorksheetRegion which represents the region of cells in the header row of the table or null if the header row is not visible.

get headerRowRegion(): WorksheetRegion

Returns WorksheetRegion

scope

Section titled "scope"

Inherited from: NamedReferenceBase

Gets the scope of the named reference.

get scope(): any

Returns any

sortSettings

Section titled "sortSettings"

Gets the settings which determine how the data within the table should be sorted.

get sortSettings(): SortSettings$1<WorksheetTableColumn>

Returns SortSettings$1<WorksheetTableColumn>

totalsRowRegion

Section titled "totalsRowRegion"

Gets the [[WorksheetRegion]] which represents the region of cells in the totals row of the table. A WorksheetRegion which represents the region of cells in the totals row of the table or null if the totals row is not visible.

get totalsRowRegion(): WorksheetRegion

Returns WorksheetRegion

wholeTableRegion

Section titled "wholeTableRegion"

Gets the [[WorksheetRegion]] which represents the region of cells in the whole table, including the header and totals rows, if visible.

get wholeTableRegion(): WorksheetRegion

Returns WorksheetRegion

worksheet

Section titled "worksheet"

Gets the [[worksheet]] to which the table belongs. The Worksheet to which the table belongs or null if the table has been removed from the Worksheet.

get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

areaFormats

Section titled "areaFormats"

Gets the format for the specified area. An [[IWorksheetCellFormat]] instance describing the appearance of the specified area.

areaFormats(area: WorksheetTableArea): IWorksheetCellFormat

Parameters

Returns IWorksheetCellFormat

clearFilters

Section titled "clearFilters"

Clears all filters from the columns in the table.

clearFilters(): void

Returns void

clearSortConditions

Section titled "clearSortConditions"

Clears all sort conditions from the columns in the table.

clearSortConditions(): void

Returns void

columns

Section titled "columns"

Gets the [[WorksheetTableColumn]] at the specified index.

columns(index: number): WorksheetTableColumn

Parameters

  • index: number

    The 0-based index of the column to get.

Returns WorksheetTableColumn

deleteColumns

Section titled "deleteColumns"

Deletes one or more columns from the table

deleteColumns(tableColumnIndex: number, count: number): void

Parameters

  • tableColumnIndex: number

    The deletion start relative to the first column in the table.
  • count: number

    The number of columns to delete.

Returns void

deleteDataRows

Section titled "deleteDataRows"

Deletes one or more data rows from the table

deleteDataRows(dataRowIndex: number, count: number): void

Parameters

  • dataRowIndex: number

    The deletion start relative to the first row in the [[dataAreaRegion]].
  • count: number

    The number of rows to delete.

Returns void

insertColumns

Section titled "insertColumns"

Inserts one or more columns into the table

insertColumns(tableColumnIndex: number, count: number): void

Parameters

  • tableColumnIndex: number

    The insertion point relative to the first column in the table.
  • count: number

    The number of columns to insert

Returns void

insertDataRows

Section titled "insertDataRows"

Inserts one or more data rows into the table

insertDataRows(dataRowIndex: number, count: number): void

Parameters

  • dataRowIndex: number

    The insertion point relative to the first row in the [[dataAreaRegion]].
  • count: number

    The number of columns to insert

Returns void

reapplyFilters

Section titled "reapplyFilters"

Re-filters all data cells in the table based on the filters from the columns in the table.

reapplyFilters(): void

Returns void

reapplySortConditions

Section titled "reapplySortConditions"

Re-sorts all data cells in the table based on the sort conditions from the columns in the table.

reapplySortConditions(): void

Returns void

resize

Section titled "resize"

Resizes the table to a new range of data on the worksheet.

resize(headerAndDataRegion: WorksheetRegion): void

Parameters

  • headerAndDataRegion: WorksheetRegion

    The new region of headers (if currently visible) and data for the table, which must contain at least one data row, and overlap and have the same top as the current table region.

Returns void

toString

Section titled "toString"

Gets the string representation of the table.

toString(): string

Returns string

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void