WorkbookEditorElement

The element: what hosts can set, call and listen to.

Extends

• HTMLElement

Properties

Property	Modifier	Type	Description
editedCount	readonly	number	-
fileName	readonly	string	-
options	public	EditorOptions	Editor options. Changing the theme, language, user or schemas of a connected element applies them as it is; changing anything else re-creates the editor, closing the workbook.
status	readonly	"error" | "empty" | "loading" | "ready"	-
unsaved	readonly	boolean	-

Methods

addEventListener()

Call Signature

addEventListener<K>(
   type,
   listener,
   options?
): void;

Type Parameters

Type Parameter
K extends keyof WorkbookEditorEventMap

Parameters

Parameter	Type
type	K
listener	(this, ev) => unknown
options?	boolean | AddEventListenerOptions

Returns

void

Overrides

HTMLElement.addEventListener

Call Signature

addEventListener(
   type,
   listener,
   options?
): void;

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | AddEventListenerOptions

Returns

void

Overrides

HTMLElement.addEventListener

---

downloadCopy()

downloadCopy(): Promise<void>;

Downloads a copy as .xlsx without saving it to the host.

Returns

Promise<void>

---

downloadCsv()

downloadCsv(options?): Promise<void>;

Downloads the sheet shown as a CSV file, with values that would run as formulas escaped unless escapeFormulas is false.

Parameters

Parameter	Type
options?	CsvOptions

Returns

Promise<void>

---

getCsv()

getCsv(options?): Promise<string | undefined>;

The sheet shown as CSV text; undefined when it isn’t a worksheet.

Parameters

Parameter	Type
options?	CsvOptions

Returns

Promise<string | undefined>

---

getWorkbook()

getWorkbook(): Promise<
  | SavedWorkbook
| undefined>;

The workbook as it is now, as a save would hand it over, without the save checks.

Returns

Promise< | SavedWorkbook | undefined>

---

goTo()

goTo(ref): void;

Selects a cell or range, such as “B4” or “Prices!A1:C3”, and shows it.

Parameters

Parameter	Type
ref	string

Returns

void

---

open()

open(bytes, fileName): Promise<boolean>;

Opens a workbook or CSV file: true once open, false when the user kept the one already open; rejects saying why it can’t.

Parameters

Parameter	Type
bytes	ArrayBuffer | Uint8Array<ArrayBufferLike>
fileName	string

Returns

Promise<boolean>

---

registerSchema()

registerSchema(schema): void;

Parameters

Parameter	Type
schema	WorkbookSchema

Returns

void

---

removeEventListener()

Call Signature

removeEventListener<K>(
   type,
   listener,
   options?
): void;

Type Parameters

Type Parameter
K extends keyof WorkbookEditorEventMap

Parameters

Parameter	Type
type	K
listener	(this, ev) => unknown
options?	boolean | EventListenerOptions

Returns

void

Overrides

HTMLElement.removeEventListener

Call Signature

removeEventListener(
   type,
   listener,
   options?
): void;

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | EventListenerOptions

Returns

void

Overrides

HTMLElement.removeEventListener

---

removeSchema()

removeSchema(id): void;

Parameters

Parameter	Type
id	string

Returns

void

---

save()

save(): Promise<SaveResult>;

Runs the save flow (schema checks, then the save event or a download), resolving with what happened.

Returns

Promise<SaveResult>

---

setCustomLists()

setCustomLists(lists): void;

Parameters

Parameter	Type
lists	string[][] | undefined

Returns

void

---

setLanguage()

setLanguage(language): void;

Parameters

Parameter	Type
language	string

Returns

void

---

setTheme()

setTheme(theme): void;

Parameters

Parameter

Type

theme

| Partial<Record< | "warning" | "text" | "colorScheme" | "accent" | "accentStrong" | "accentSoft" | "accentBorder" | "accentTint" | "onAccent" | "surface" | "surfaceAlt" | "surfaceSunken" | "backdrop" | "focusRing" | "textMuted" | "textSubtle" | "border" | "borderStrong" | "neutral" | "success" | "successSoft" | "successBorder" | "successText" | "warningSoft" | "warningBorder" | "warningText" | "warningAccent" | "danger" | "dangerSoft" | "dangerBorder" | "onDanger" | "infoSoft" | "infoText" | "infoAccent" | "infoBannerBg" | "infoBannerBorder" | "infoBannerText" | "fieldSoft" | "fieldText" | "noteSoft" | "noteText" | "noteBorder" | "noteTipBg" | "noteTipBorder" | "placeholderBg" | "placeholderBorder" | "placeholderText" | "placeholderTextMuted" | "dropzoneBorder" | "dropzoneHoverBg" | "gridBg" | "gridText" | "gridTextOnFill" | "gridLine" | "gridBorderAuto" | "gridFreezeLine" | "gridHeaderBg" | "gridHeaderText" | "gridHeaderLine" | "gridHeaderHoverBg" | "gridHeaderSelectedBg" | "gridHeaderSelectedText" | "gridRowHeaderText" | "gridTextMuted" | "gridTextLight" | "gridBgAlt" | "gridCutFill" | "gridSelection" | "gridSelectionFill" | "gridEditedFill" | "gridEditedMark" | "gridLockedFill" | "gridLabelFill" | "gridErrorMark" | "gridWarningMark" | "gridPendingMark" | "gridNoteMark" | "gridStaleMark" | "gridUnsupportedMark" | "gridSpillLine" | "gridDropdownArrow" | "gridLink" | "gridFont" | "gridHeaderFont" | "gridHeaderFontSize" | "gridHeaderFontWeight" | "formulaRef1" | "formulaRef2" | "formulaRef3" | "formulaRef4" | "formulaRef5" | "formulaRef6" | "formulaRef7" | "chartColors" | "font" | "fontMono" | "fontSize" | "fontSizeXs" | "fontSizeSm" | "fontSizeMd" | "fontSizeLg" | "fontSizeXl" | "iconStrokeWidth" | "radius" | "radiusSm" | "radiusLg" | "shadow" | "shadowSm", string>> | undefined

Returns

void

---

setUser()

setUser(user): void;

Parameters

Parameter	Type
user	string | undefined

Returns

void