SheetSet
SheetSet class
Describes a set of sheets.
class SheetSet;
Constructors
| Constructor | Description |
|---|---|
| constructor(number[]) | Creates a sheet set based on exact sheet indexes. |
| constructor(string[]) | Creates a sheet set based on exact sheet names. |
Properties
| Property | Type | Description |
|---|---|---|
| static active | SheetSet | Readonly. Gets a set with active sheet of the workbook. |
| static visible | SheetSet | Readonly. Gets a set with visible sheets of the workbook in their original order. |
| static all | SheetSet | Readonly. Gets a set with all sheets of the workbook in their original order. |
Methods
| Method | Description |
|---|---|
| isNull() | Checks whether the implementation object is null. |
| static getActive() | @deprecated. Please use the ‘active’ property instead. Gets a set with active sheet of the workbook. |
| static getVisible() | @deprecated. Please use the ‘visible’ property instead. Gets a set with visible sheets of the workbook in their original order. |
| static getAll() | @deprecated. Please use the ‘all’ property instead. Gets a set with all sheets of the workbook in their original order. |
constructor(number[])
Creates a sheet set based on exact sheet indexes.
constructor(sheetIndexes: number[]);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sheetIndexes | number[] | zero based sheet indexes. |
Remarks
If a sheet is encountered that is not in the workbook, an exception will be thrown during rendering.
constructor(string[])
Creates a sheet set based on exact sheet names.
constructor(sheetNames: string[]);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sheetNames | string[] | sheet names. |
Remarks
If a sheet is encountered that is not in the workbook, an exception will be thrown during rendering.
active
Readonly. Gets a set with active sheet of the workbook.
static active : SheetSet;
visible
Readonly. Gets a set with visible sheets of the workbook in their original order.
static visible : SheetSet;
all
Readonly. Gets a set with all sheets of the workbook in their original order.
static all : SheetSet;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getActive()
@deprecated. Please use the ‘active’ property instead. Gets a set with active sheet of the workbook.
static getActive() : SheetSet;
Returns
getVisible()
@deprecated. Please use the ‘visible’ property instead. Gets a set with visible sheets of the workbook in their original order.
static getVisible() : SheetSet;
Returns
getAll()
@deprecated. Please use the ‘all’ property instead. Gets a set with all sheets of the workbook in their original order.
static getAll() : SheetSet;
Returns