Interface ITableCollection

Holds a collection of ITables.

interface ITableCollection {
    add(
        address: ICellRange.Address,
        options?: ITableCollection.AddOptions,
    ): ITable;
    getByName(name: string): ITable;
    getCount(): number;
    search(options?: SearchOptions): ITable[];
}

Hierarchy (View Summary)

ICollection
- ITableCollection

Index

Methods

add getByName getCount search

Methods

add

add(address: ICellRange.Address, options?: ITableCollection.AddOptions): ITable
Add an ITable to the container.
Parameters
- address: ICellRange.Address
  The address of the table.
- Optionaloptions: ITableCollection.AddOptions
  Additional options available when adding a table.
Returns ITable

getByName

getByName(name: string): ITable
Convenience method for searching by name. This is functionally equivalent to search({ name });
Parameters
- name: string
  The name to search for This is case insensitive.
Returns ITable

getCount

getCount(): number
Returns the total items available.

Returns number
Remarks
Useful as a quick escape for search.

Inherited from ICollection.getCount

search

search(options?: SearchOptions): ITable[]
Returns items that match the search criteria.

If no search criteria is provided, all items will be returned.
Parameters
- Optionaloptions: SearchOptions
  ITableCollection.SearchOptions
Returns ITable[]