Interface ISheetCollection

Holds a collection of ISheets.

interface ISheetCollection {
    add(options?: ISheetCollection.AddOptions): ISheet;
    getByName(name: string): ISheet;
    getCount(): number;
    search(options?: SearchOptions): ISheet[];
}

Hierarchy (View Summary)

ICollection
- ISheetCollection

Index

Methods

add getByName getCount search

Methods

add

add(options?: ISheetCollection.AddOptions): ISheet
Add an ISheet to the collection.
Parameters
- Optionaloptions: ISheetCollection.AddOptions
Returns ISheet

getByName

getByName(name: string): ISheet
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 ISheet

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): ISheet[]
Returns sheets that match the search criteria.

If no search criteria is provided, all sheets will be returned.
Parameters
- Optionaloptions: SearchOptions
  ISheetCollection.SearchOptions
Returns ISheet[]