SplitPartInfo
SplitPartInfo class
Represents the information of one input/output for multiple inputs/outputs, such as current page to be rendered when converting spreadsheet to image.
class SplitPartInfo;
Properties
| Property | Type | Description |
|---|---|---|
| partIndex | number | Readonly. Index of current part in sequence(0 based). -1 means there are no multiple parts so the result is single. |
| sheetIndex | number | Readonly. Index of the sheet where current part is in. -1 denotes there is only one sheet. |
| sheetName | string | Readonly. Name of the sheet where current part is in. |
Methods
| Method | Description |
|---|---|
| getPartIndex() | @deprecated. Please use the ‘partIndex’ property instead. Index of current part in sequence(0 based). -1 means there are no multiple parts so the result is single. |
| getSheetIndex() | @deprecated. Please use the ‘sheetIndex’ property instead. Index of the sheet where current part is in. -1 denotes there is only one sheet. |
| getSheetName() | @deprecated. Please use the ‘sheetName’ property instead. Name of the sheet where current part is in. |
| isNull() | Checks whether the implementation object is null. |
partIndex
Readonly. Index of current part in sequence(0 based). -1 means there are no multiple parts so the result is single.
partIndex : number;
Remarks
If multiple sheets need to be processed and every sheet is processed(split) separately, the part index always starts from 0 for every sheet. For example, when converting workbook to images, it represents the output page index of currently processed sheet. And -1 denotes there is only one page for current sheet.
sheetIndex
Readonly. Index of the sheet where current part is in. -1 denotes there is only one sheet.
sheetIndex : number;
sheetName
Readonly. Name of the sheet where current part is in.
sheetName : string;
Remarks
May be null for some situations, such as when rendering the whole workbook to tiff image.
getPartIndex()
@deprecated. Please use the ‘partIndex’ property instead. Index of current part in sequence(0 based). -1 means there are no multiple parts so the result is single.
getPartIndex() : number;
Remarks
If multiple sheets need to be processed and every sheet is processed(split) separately, the part index always starts from 0 for every sheet. For example, when converting workbook to images, it represents the output page index of currently processed sheet. And -1 denotes there is only one page for current sheet.
getSheetIndex()
@deprecated. Please use the ‘sheetIndex’ property instead. Index of the sheet where current part is in. -1 denotes there is only one sheet.
getSheetIndex() : number;
getSheetName()
@deprecated. Please use the ‘sheetName’ property instead. Name of the sheet where current part is in.
getSheetName() : string;
Remarks
May be null for some situations, such as when rendering the whole workbook to tiff image.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;