Class: Workbook

Defined in: packages/core/src/workbook.ts:375

Properties

pkg

readonly pkg: OoxmlPackage;

Defined in: packages/core/src/workbook.ts:380

workbookPart

readonly workbookPart: string;

Defined in: packages/core/src/workbook.ts:381

Methods

addSheet()

addSheet(name): Promise<WorkbookSheet>;

Defined in: packages/core/src/workbook.ts:1502

Parameters

name

string

Returns

Promise<WorkbookSheet>

appendRows()

appendRows(
   sheetName, 
   rows, 
   options?): Promise<void>;

Defined in: packages/core/src/workbook.ts:549

Parameters

sheetName

string

rows

CellInput[][]

options?

startColumn?

number

Returns

Promise<void>

appendTableColumn()

appendTableColumn(
   tableName, 
   columnName, 
   values?): Promise<WorkbookTable>;

Defined in: packages/core/src/workbook.ts:1476

Parameters

tableName

string

columnName

string

values?

CellInput[] = []

Returns

Promise<WorkbookTable>

autoFilters()

autoFilters(sheetName?): Promise<WorkbookAutoFilter[]>;

Defined in: packages/core/src/workbook.ts:955

Parameters

sheetName?

string

Returns

Promise<WorkbookAutoFilter[]>

charts()

charts(): Promise<WorkbookChart[]>;

Defined in: packages/core/src/workbook.ts:1847

Returns

Promise<WorkbookChart[]>

clearCell()

clearCell(
   sheetName, 
   address, 
   options?): Promise<void>;

Defined in: packages/core/src/workbook.ts:480

Parameters

sheetName

string

address

string

options?

keepStyles?

boolean

Returns

Promise<void>

clearRange()

clearRange(
   sheetName, 
   rangeRef, 
   options?): Promise<void>;

Defined in: packages/core/src/workbook.ts:488

Parameters

sheetName

string

rangeRef

string

options?

keepStyles?

boolean

Returns

Promise<void>

comments()

comments(sheetName?): Promise<WorkbookComment[]>;

Defined in: packages/core/src/workbook.ts:973

Parameters

sheetName?

string

Returns

Promise<WorkbookComment[]>

conditionalFormats()

conditionalFormats(sheetName?): Promise<WorkbookConditionalFormat[]>;

Defined in: packages/core/src/workbook.ts:937

Parameters

sheetName?

string

Returns

Promise<WorkbookConditionalFormat[]>

copySheet()

copySheet(sheetName, nextName): Promise<WorkbookSheet>;

Defined in: packages/core/src/workbook.ts:1515

Parameters

sheetName

string

nextName

string

Returns

Promise<WorkbookSheet>

dataValidations()

dataValidations(sheetName?): Promise<WorkbookDataValidation[]>;

Defined in: packages/core/src/workbook.ts:919

Parameters

sheetName?

string

Returns

Promise<WorkbookDataValidation[]>

definedNames()

definedNames(): Promise<WorkbookDefinedName[]>;

Defined in: packages/core/src/workbook.ts:1890

Returns

Promise<WorkbookDefinedName[]>

deleteAutoFilter()

deleteAutoFilter(sheetName): Promise<boolean>;

Defined in: packages/core/src/workbook.ts:1232

Parameters

sheetName

string

Returns

Promise<boolean>

deleteConditionalFormat()

deleteConditionalFormat(sheetName, sqref): Promise<boolean>;

Defined in: packages/core/src/workbook.ts:1243

Parameters

sheetName

string

sqref

string

Returns

Promise<boolean>

deleteDataValidation()

deleteDataValidation(sheetName, sqref): Promise<boolean>;

Defined in: packages/core/src/workbook.ts:1221

Parameters

sheetName

string

sqref

string

Returns

Promise<boolean>

deleteDefinedName()

deleteDefinedName(name, options?): Promise<boolean>;

Defined in: packages/core/src/workbook.ts:1919

Parameters

name

string

options?

sheetName?

string

Returns

Promise<boolean>

deleteHyperlink()

deleteHyperlink(sheetName, ref): Promise<boolean>;

Defined in: packages/core/src/workbook.ts:1320

Parameters

sheetName

string

ref

string

Returns

Promise<boolean>

deleteRows()

deleteRows(
   sheetName, 
   startRow, 
   count?): Promise<void>;

Defined in: packages/core/src/workbook.ts:584

Parameters

sheetName

string

startRow

number

count?

number = 1

Returns

Promise<void>

deleteSheet()

deleteSheet(sheetName): Promise<void>;

Defined in: packages/core/src/workbook.ts:1562

Parameters

sheetName

string

Returns

Promise<void>

diagnostics()

diagnostics(): Diagnostic[];

Defined in: packages/core/src/workbook.ts:2216

Returns

Diagnostic[]

ensureCellStyle()

ensureCellStyle(style): Promise<string>;

Defined in: packages/core/src/workbook.ts:1335

Parameters

style

WorkbookCellStyleInput

Returns

Promise<string>

formulas()

formulas(): Promise<WorkbookFormula[]>;

Defined in: packages/core/src/workbook.ts:2169

Returns

Promise<WorkbookFormula[]>

hideSheet()

hideSheet(sheetName, state?): Promise<WorkbookSheet>;

Defined in: packages/core/src/workbook.ts:1831

Parameters

sheetName

string

state?

WorkbookSheetState = "hidden"

Returns

Promise<WorkbookSheet>

hyperlinks()

hyperlinks(sheetName?): Promise<WorkbookHyperlink[]>;

Defined in: packages/core/src/workbook.ts:862

Parameters

sheetName?

string

Returns

Promise<WorkbookHyperlink[]>

images()

images(sheetName?): Promise<WorkbookImage[]>;

Defined in: packages/core/src/workbook.ts:1004

Parameters

sheetName?

string

Returns

Promise<WorkbookImage[]>

insertImage()

insertImage(
   sheetName, 
   data, 
   options?): Promise<WorkbookImage>;

Defined in: packages/core/src/workbook.ts:1099

Parameters

sheetName

string

data

Uint8Array

options?

WorkbookInsertImageOptions = {}

Returns

Promise<WorkbookImage>

insertRows()

insertRows(
   sheetName, 
   beforeRow, 
   count?): Promise<void>;

Defined in: packages/core/src/workbook.ts:575

Parameters

sheetName

string

beforeRow

number

count?

number = 1

Returns

Promise<void>

inspect()

inspect(): Promise<WorkbookInspectResult>;

Defined in: packages/core/src/workbook.ts:1859

Returns

Promise<WorkbookInspectResult>

mergeCells()

mergeCells(sheetName, ref): Promise<WorkbookMergedCell>;

Defined in: packages/core/src/workbook.ts:1254

Parameters

sheetName

string

ref

string

Returns

Promise<WorkbookMergedCell>

mergedCells()

mergedCells(sheetName?): Promise<WorkbookMergedCell[]>;

Defined in: packages/core/src/workbook.ts:901

Parameters

sheetName?

string

Returns

Promise<WorkbookMergedCell[]>

namedRanges()

namedRanges(name?): Promise<WorkbookNamedRange[]>;

Defined in: packages/core/src/workbook.ts:803

Parameters

name?

string

Returns

Promise<WorkbookNamedRange[]>

patchCell()

patchCell(
   sheetName, 
   address, 
   value): Promise<void>;

Defined in: packages/core/src/workbook.ts:407

Parameters

sheetName

string

address

string

value

CellInput

Returns

Promise<void>

patchCells()

patchCells(sheetName, patches): Promise<void>;

Defined in: packages/core/src/workbook.ts:429

Parameters

sheetName

string

patches

CellPatch[]

Returns

Promise<void>

patchNamedRange()

patchNamedRange(
   name, 
   values, 
   options?): Promise<WorkbookNamedRange>;

Defined in: packages/core/src/workbook.ts:841

Parameters

name

string

patchRange()

patchRange(
   sheetName, 
   startAddress, 
   values): Promise<void>;

Defined in: packages/core/src/workbook.ts:451

Parameters

sheetName

string

startAddress

string

values

CellInput[][]

Returns

Promise<void>

pivotCacheSources()

pivotCacheSources(): Promise<WorkbookPivotCacheSource[]>;

Defined in: packages/core/src/workbook.ts:1851

Returns

Promise<WorkbookPivotCacheSource[]>

preflightTemplatePatch()

preflightTemplatePatch(patch): Promise<WorkbookTemplatePreflightResult>;

Defined in: packages/core/src/workbook.ts:2061

Parameters

patch

WorkbookTemplatePatch

Returns

Promise<WorkbookTemplatePreflightResult>

readCell()

readCell(sheetName, address): Promise<ReadCellResult | undefined>;

Defined in: packages/core/src/workbook.ts:791

Parameters

sheetName

string

address

string

Returns

Promise<ReadCellResult | undefined>

readNamedRange()

readNamedRange(name, options?): Promise<ReadRangeResult>;

Defined in: packages/core/src/workbook.ts:833

Parameters

name

string

options?

sheetName?

string

Returns

Promise<ReadRangeResult>

readRange()

readRange(sheetName, rangeRef): Promise<ReadRangeResult>;

Defined in: packages/core/src/workbook.ts:797

Parameters

sheetName

string

rangeRef

string

Returns

Promise<ReadRangeResult>

readSheetCells()

readSheetCells(sheetName): Promise<ReadCellResult[]>;

Defined in: packages/core/src/workbook.ts:473

Parameters

sheetName

string

Returns

Promise<ReadCellResult[]>

removeRightmostTableColumn()

removeRightmostTableColumn(tableName, columnName): Promise<WorkbookTable>;

Defined in: packages/core/src/workbook.ts:1491

Parameters

tableName

string

columnName

string

Returns

Promise<WorkbookTable>

renameSheet()

renameSheet(sheetName, nextName): Promise<WorkbookSheet>;

Defined in: packages/core/src/workbook.ts:1746

Parameters

sheetName

string

nextName

string

Returns

Promise<WorkbookSheet>

renameTable()

renameTable(tableName, nextName): Promise<WorkbookTable>;

Defined in: packages/core/src/workbook.ts:1450

Parameters

tableName

string

nextName

string

Returns

Promise<WorkbookTable>

renameTableColumn()

renameTableColumn(
   tableName, 
   columnName, 
   nextName): Promise<WorkbookTable>;

Defined in: packages/core/src/workbook.ts:1461

Parameters

tableName

string

columnName

string

nextName

string

Returns

Promise<WorkbookTable>

renderTemplate()

renderTemplate(patch): Promise<WorkbookTemplateRenderResult>;

Defined in: packages/core/src/workbook.ts:740

Parameters

patch

WorkbookTemplatePatch

Returns

Promise<WorkbookTemplateRenderResult>

replaceImage()

replaceImage(imagePartName, data): Promise<WorkbookImage>;

Defined in: packages/core/src/workbook.ts:1075

Parameters

imagePartName

string

data

Uint8Array

Returns

Promise<WorkbookImage>

replaceTableRows()

replaceTableRows(tableName, rows): Promise<WorkbookTable>;

Defined in: packages/core/src/workbook.ts:1438

Parameters

tableName

string

rows

CellInput[][]

Returns

Promise<WorkbookTable>

resolveNamedRange()

resolveNamedRange(name, options?): Promise<WorkbookNamedRange>;

Defined in: packages/core/src/workbook.ts:820

Parameters

name

string

options?

sheetName?

string

Returns

Promise<WorkbookNamedRange>

retargetChartFormulas()

retargetChartFormulas(retargets): Promise<number>;

Defined in: packages/core/src/workbook.ts:1839

Parameters

retargets

ChartFormulaRetarget[]

Returns

Promise<number>

retargetPivotCacheSources()

retargetPivotCacheSources(retargets): Promise<number>;

Defined in: packages/core/src/workbook.ts:1843

Parameters

retargets

PivotCacheSourceRetarget[]

Returns

Promise<number>

setAutoFilter()

setAutoFilter(sheetName, autoFilter): Promise<WorkbookAutoFilter>;

Defined in: packages/core/src/workbook.ts:1188

Parameters

sheetName

string

autoFilter

WorksheetAutoFilter

Returns

Promise<WorkbookAutoFilter>

setConditionalFormat()

setConditionalFormat(sheetName, conditionalFormat): Promise<WorkbookConditionalFormat>;

Defined in: packages/core/src/workbook.ts:1203

Parameters

sheetName

string

conditionalFormat

WorksheetConditionalFormat

Returns

Promise<WorkbookConditionalFormat>

setDataValidation()

setDataValidation(sheetName, dataValidation): Promise<WorkbookDataValidation>;

Defined in: packages/core/src/workbook.ts:1170

Parameters

sheetName

string

dataValidation

WorksheetDataValidation

Returns

Promise<WorkbookDataValidation>

setDefinedName()

setDefinedName(
   name, 
   text, 
   options?): Promise<WorkbookDefinedName>;

Defined in: packages/core/src/workbook.ts:1894

Parameters

name

string

text

string

options?

comment?

string

hidden?

boolean

sheetName?

string

Returns

Promise<WorkbookDefinedName>

setHyperlink()

setHyperlink(
   sheetName, 
   ref, 
   target, 
   options?): Promise<WorkbookHyperlink>;

Defined in: packages/core/src/workbook.ts:1279

Parameters

sheetName

string

ref

string

target

string

options?

display?

string

Returns

Promise<WorkbookHyperlink>

setSheetState()

setSheetState(sheetName, state): Promise<WorkbookSheet>;

Defined in: packages/core/src/workbook.ts:1787

Parameters

sheetName

string

state

| WorkbookSheetState | undefined

Returns

Promise<WorkbookSheet>

sheet()

sheet(name): WorkbookSheet;

Defined in: packages/core/src/workbook.ts:398

Parameters

name

string

Returns

WorkbookSheet

sheets()

sheets(): WorkbookSheet[];

Defined in: packages/core/src/workbook.ts:394

Returns

WorkbookSheet[]

showSheet()

showSheet(sheetName): Promise<WorkbookSheet>;

Defined in: packages/core/src/workbook.ts:1835

Parameters

sheetName

string

Returns

Promise<WorkbookSheet>

styleCell()

styleCell(
   sheetName, 
   address, 
   style): Promise<string>;

Defined in: packages/core/src/workbook.ts:1354

Parameters

sheetName

string

address

string

style

WorkbookCellStyleInput

Returns

Promise<string>

styleRange()

styleRange(
   sheetName, 
   rangeRef, 
   style): Promise<string[]>;

Defined in: packages/core/src/workbook.ts:1372

Parameters

sheetName

string

rangeRef

string

style

WorkbookCellStyleInput

Returns

Promise<string[]>

styles()

styles(): Promise<WorkbookStyles>;

Defined in: packages/core/src/workbook.ts:1935

Returns

Promise<WorkbookStyles>

tables()

tables(): Promise<WorkbookTable[]>;

Defined in: packages/core/src/workbook.ts:1855

Returns

Promise<WorkbookTable[]>

templateManifest()

templateManifest(): Promise<WorkbookTemplateManifest>;

Defined in: packages/core/src/workbook.ts:1871

Returns

Promise<WorkbookTemplateManifest>

unmergeCells()

unmergeCells(sheetName, ref): Promise<boolean>;

Defined in: packages/core/src/workbook.ts:1268

Parameters

sheetName

string

ref

string

Returns

Promise<boolean>

validate()

validate(): Promise<ValidationReport>;

Defined in: packages/core/src/workbook.ts:1886

Returns

Promise<ValidationReport>

write()

write(): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: packages/core/src/workbook.ts:2220

Returns

Promise<Uint8Array<ArrayBufferLike>>

fromPackage()

static fromPackage(pkg): Promise<Workbook>;

Defined in: packages/core/src/workbook.ts:385

Parameters

pkg

OoxmlPackage

Returns

Promise<Workbook>