TableCollection Class

A collection of the Table objects.

Declaration

export class TableCollection extends Collection<Table>

Inherited Members

count

getByIndex(index)

Inheritance

Collection<T>

TableCollection

TableCollectionBaseApi

Methods

create(position, columnCount, rowCount, availableWidth) Method

Creates a new Table object with the specified settings and adds it to the collection.

Declaration

create(
    position: number,
    columnCount: number,
    rowCount: number,
    availableWidth: number
): Table

Parameters

Name	Type	Description
position	number	The table position.
columnCount	number	The number of columns in the table.
rowCount	number	The number of rows in the table.
availableWidth	number	The table’s available width.

Returns

Type	Description
Table	The newly created table.

find(position) Method

Returns a list of tables that traverse the specified position or interval.

Declaration

find(
    position: number | IInterval
): Table[]

Parameters

Name	Type	Description
position	number | IInterval	A document position or interval.

Returns

Type	Description
Table[]	A list of tables.