SheetSet

SheetSet class

Describes a set of sheets.

class SheetSet;

Constructors

NameDescription
constructor(number[])Creates a sheet set based on exact sheet indexes.

Methods

MethodDescription
isNull()Checks whether the implementation object is null.
static getActive()Gets a set with active sheet of the workbook.
static getVisible()Gets a set with visible sheets of the workbook in their original order.
static getAll()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(sheets: number[]);

Parameters:

ParameterTypeDescription
sheetsnumber[]zero based sheet indexes.

Remarks

If a sheet is encountered that is not in the workbook, an exception will be thrown during rendering.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getActive()

Gets a set with active sheet of the workbook.

static getActive() : SheetSet;

Returns

SheetSet

getVisible()

Gets a set with visible sheets of the workbook in their original order.

static getVisible() : SheetSet;

Returns

SheetSet

getAll()

Gets a set with all sheets of the workbook in their original order.

static getAll() : SheetSet;

Returns

SheetSet