Class TableModel

Default TableModel

Implements

ITableModel

Constructors

constructor

new TableModel(options): TableModel
Parameters
- options: TableModelOptions
Returns TableModel

Accessors

autoFilter

get autoFilter(): AutoFilter
Returns AutoFilter
Implementation of ITableModel.autoFilter
set autoFilter(newValue): void
Parameters
- newValue: AutoFilter
Returns void
Implementation of ITableModel.autoFilter

columns

get columns(): TableColumn[]
Returns TableColumn[]
Implementation of ITableModel.columns
set columns(newValue): void
Parameters
- newValue: TableColumn[]
Returns void
Implementation of ITableModel.columns

displayName

get displayName(): string
A string representing the name of the table. This is the name that shall be used in formula references, and displayed in the UI to the spreadsheet user. This name shall not have any spaces in it, and it must be unique amongst all other displayNames and definedNames in the workbook. The character lengths and restrictions are the same as for definedNames.

See SpreadsheetML Reference - Workbook definedNames section for details.

Returns string
Implementation of ITableModel.displayName
set displayName(newValue): void
A string representing the name of the table. This is the name that shall be used in formula references, and displayed in the UI to the spreadsheet user. This name shall not have any spaces in it, and it must be unique amongst all other displayNames and definedNames in the workbook. The character lengths and restrictions are the same as for definedNames.

See SpreadsheetML Reference - Workbook definedNames section for details.
Parameters
- newValue: string
Returns void
Implementation of ITableModel.displayName

headerRowCount

get headerRowCount(): number
An integer representing the number of header rows showing at the top of the table. 0 means that the header row is not shown

Returns number
Default Value
```
1
```
Implementation of ITableModel.headerRowCount
set headerRowCount(newValue): void
An integer representing the number of header rows showing at the top of the table. 0 means that the header row is not shown
Parameters
- newValue: number
Returns void
Default Value
```
1
```
Implementation of ITableModel.headerRowCount

isModelTable

get isModelTable(): true
Purely for runtime inspection

Returns true
Implementation of ITableModel.isModelTable

name

get name(): string
The unique name of the table

Returns string
Implementation of ITableModel.name
set name(newValue): void
The unique name of the table
Parameters
- newValue: string
Returns void
Implementation of ITableModel.name

ref

get ref(): CellRangeCoords
The range on the relevant sheet that the table occupies expressed using A1 style referencing. The reference shall include the totals row if it is shown

Returns CellRangeCoords
Implementation of ITableModel.ref
set ref(newValue): void
The range on the relevant sheet that the table occupies expressed using A1 style referencing. The reference shall include the totals row if it is shown
Parameters
- newValue: CellRangeCoords
Returns void
Implementation of ITableModel.ref

sortState

get sortState(): any
Returns any
Implementation of ITableModel.sortState
set sortState(newValue): void
Parameters
- newValue: any
Returns void
Implementation of ITableModel.sortState

styleInfo

get styleInfo(): TableStyleInfo
If not specified than the default table style is used If the style name isn't valid then uses a 'none' style.

Returns TableStyleInfo
Implementation of ITableModel.styleInfo
set styleInfo(newValue): void
If not specified than the default table style is used If the style name isn't valid then uses a 'none' style.
Parameters
- newValue: TableStyleInfo
Returns void
Implementation of ITableModel.styleInfo

totalsRowCount

get totalsRowCount(): number
An integer representing the number of totals rows that shall be shown at the bottom of the table.

Returns number
Default Value
```
0
```
Implementation of ITableModel.totalsRowCount
set totalsRowCount(newValue): void
An integer representing the number of totals rows that shall be shown at the bottom of the table.
Parameters
- newValue: number
Returns void
Default Value
```
0
```
Implementation of ITableModel.totalsRowCount

Methods

addListener

addListener(listener): RemoveListener
Register for updates
Parameters
- listener: ITableModelListener
Returns RemoveListener
Implementation of ITableModel.addListener

close

close(): void
Free all resources associated with the sheet and mark as read-only.

Returns void
Remarks
This is called by workbooks when the sheet is closed

See
addListener for closeEvent

Implementation of ITableModel.close

getTableStyle

getTableStyle(): ITableStyle
Returns the current style used.

Returns ITableStyle
Implementation of ITableModel.getTableStyle

insertColumns

insertColumns(offset, count): void
Parameters
- offset: number
- count: number
Returns void
Implementation of ITableModel.insertColumns

insertRows

insertRows(_offset, count): void
Parameters
- _offset: number
- count: number
Returns void
Implementation of ITableModel.insertRows

isClosed

isClosed(): boolean
Returns true if the table has been closed.

Returns boolean
Implementation of ITableModel.isClosed

notifyOnClose

notifyOnClose(): void
Returns void

notifyOnTableChange

notifyOnTableChange(): void
Returns void

pushTransaction

pushTransaction(description?): ITransaction
Parameters
- Optional description: string
Returns ITransaction

removeColumns

removeColumns(offset, count): void
Parameters
- offset: number
- count: number
Returns void
Implementation of ITableModel.removeColumns

removeRows

removeRows(_offset, count): void
Parameters
- _offset: number
- count: number
Returns void
Implementation of ITableModel.removeRows

toJSON

toJSON(): Partial<{
    autoFilter?: string | AutoFilter | Partial<{
        filterColumns?: any;
        ref?: string;
        sortState?: any;
    }>;
    columns?: string | TableColumn[] | (string | TableColumn | Partial<{
        name: string;
    }>)[];
    displayName?: string;
    headerRowCount?: string | number;
    isModelTable: string | true;
    name: string;
    ref: string | CellRangeCoords | Partial<{
        colEnd: string | number;
        colStart: string | number;
        rowEnd: string | number;
        rowStart: string | number;
    }>;
    sortState?: any;
    styleInfo?: string | TableStyleInfo | Partial<{
        name: string;
        showColumnStripes?: string | Partial<boolean>;
        showFirstColumn?: string | Partial<boolean>;
        showLastColumn?: string | Partial<boolean>;
        showRowStripes?: string | Partial<boolean>;
    }>;
    totalsRowCount?: string | number;
    addListener: any;
    close: any;
    getTableStyle: any;
    insertColumns: any;
    insertRows: any;
    isClosed: any;
    removeColumns: any;
    removeRows: any;
    toJSON: any;
    update: any;
}>
Saves the current state of the table to a JSON object.

Returns Partial<{
    autoFilter?: string | AutoFilter | Partial<{
        filterColumns?: any;
        ref?: string;
        sortState?: any;
    }>;
    columns?: string | TableColumn[] | (string | TableColumn | Partial<{
        name: string;
    }>)[];
    displayName?: string;
    headerRowCount?: string | number;
    isModelTable: string | true;
    name: string;
    ref: string | CellRangeCoords | Partial<{
        colEnd: string | number;
        colStart: string | number;
        rowEnd: string | number;
        rowStart: string | number;
    }>;
    sortState?: any;
    styleInfo?: string | TableStyleInfo | Partial<{
        name: string;
        showColumnStripes?: string | Partial<boolean>;
        showFirstColumn?: string | Partial<boolean>;
        showLastColumn?: string | Partial<boolean>;
        showRowStripes?: string | Partial<boolean>;
    }>;
    totalsRowCount?: string | number;
    addListener: any;
    close: any;
    getTableStyle: any;
    insertColumns: any;
    insertRows: any;
    isClosed: any;
    removeColumns: any;
    removeRows: any;
    toJSON: any;
    update: any;
}>
Implementation of ITableModel.toJSON

update

update(values, options?): void
Update the table with the new values.
Parameters
- values: TableModelValues
- Optional options: UpdateTableModelOptions
Returns void
Implementation of ITableModel.update

Class TableModel

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TableModel

Accessors

autoFilter

Returns AutoFilter

Parameters

Returns void

columns

Returns TableColumn[]

Parameters

Returns void

displayName

Returns string

Parameters

Returns void

headerRowCount

Returns number

Default Value

Parameters

Returns void

Default Value

isModelTable

Returns true

name

Returns string

Parameters

Returns void

ref

Returns CellRangeCoords

Parameters

Returns void

sortState

Returns any

Parameters

Returns void

styleInfo

Returns TableStyleInfo

Parameters

Returns void

totalsRowCount

Returns number

Default Value

Parameters

Returns void

Default Value

Methods

addListener

Parameters

Returns RemoveListener

close

Returns void

Remarks

See

getTableStyle

Returns ITableStyle

insertColumns

Parameters

Returns void

insertRows

Parameters

Returns void

isClosed

Returns boolean

notifyOnClose

Returns void

notifyOnTableChange

Returns void

pushTransaction

Parameters

Returns ITransaction

removeColumns

Parameters