EmbeddedSpreadsheet

EmbeddedSpreadsheet class

embedded spreadsheet

Properties

active_sheet	convenience function returns the name of the active sheet.
can_revert	this flag indicates we can revert the document.
dirty	indicates the current revision of the document is not equal to the last-saved revision of the document.
document_name	document name (metadata)
headless	headless state
scale	current grid scale
sheet_names	returns the names of all sheets in the current document
state	state is the current revision of the document.
user_data	opaque user data (metadata).

Methods

About	Show the about dialog.
ActivateSheet	Activate sheet.
AddSheet	Add a sheet, optionally named.
ApplyBorders	Apply borders to range.
ApplyStyle	Apply style to range.
Batch	Use this function to batch multiple document changes.
Cancel	Cancel subscription
ClearName	Remove a named range (removes the name, not the range).
Copy	copy data.
Cut	cut data.
DefineFunction	Create a macro function.
DefineName	Create a named range or named expression.
DeleteColumns	Delete columns(s).
DeleteRows	Delete row(s).
DeleteSheet	Delete a sheet.
Evaluate	Evaluate an arbitrary expression in the spreadsheet.
Export	Export to XLSX file.
ExportDelimited	Export sheet as CSV/TSV.
ExternalEditor	set or remove an external editor.
FilterTable	filter a table.
Focus	Focus the grid.
FormatNumber	Format a number with an arbitrary formatter.
Freeze	set freeze area
FreezeSelection	freeze at current selection
GetFreeze	return current freeze area
GetRange
GetSelection	Returns the current selection, as a string address or range.
GetSheetID	Get sheet ID, by name (sheet name) or index.
GetStyle	returns the style from the target address or range.
HideSheet	Show or hide sheet.
InsertAnnotation	Insert an annotation node.
InsertColumns	Insert column(s).
InsertImage	Insert an image.
InsertRows	Insert row(s).
InsertTable	insert a table in the given range.
JavascriptDate	convert a spreadsheet date to a javascript date
LoadCSV	Load CSV from string.
LoadDocument	unserialize document from data.
LoadFromLocalStorage	load a document from from local storage, using the given key.
LoadLanguage	dynamically load language module
LoadLocalFile	Load a desktop file.
LoadNetworkDocument	load a network document by URI.
MergeCells	Merge cells in range.
ParseNumber	Parse a string and return a number (if possible).
Paste	override for paste method omits the data parameter.
Paste	standard paste method accepts data argument
Recalculate	Recalculate sheet.
RemoveConnectedChart
RemoveFunction	Delete a macro function.
RemoveTable
RenameSheet	Rename a sheet.
Reset	Clear/reset sheet.
Resize	Update layout and repaint if necessary.
Resolve	Resolve a string address/range to an address or area (range) object.
Revert	revert to the network version of this document, if `local_storage` is set and the create options had either `document` or `inline-document` set.
SaveLocalFile
SaveLocalStorage	Save document to local storage.
SaveToDesktop	Save the current document to a desktop file.
ScrollIntoView	scroll the given address into view.
ScrollOffset	get or set the current scroll offset.
ScrollTo	Scroll to the given address.
Select	Select a range.
SerializeDocument	Serialize document to a plain javascript object.
SetColumnWidth	Set width of column(s).
SetLink	Set or remove a link in a cell.
SetNote	Set note (comment) in cell.
SetRange	Set data in range.
SetRowHeight	Set height of row(s).
SetValidation	set or clear cell valiation.
ShowSheet	Show or hide sheet.
SortTable	sort a table.
SpreadsheetDate	convert a javascript date (or timestamp) to a spreadsheet date
Subscribe	Subscribe to spreadsheet events
Undo	Revert state one level from the undo stack.
UnmergeCells	Unmerge cells in range.
Unresolve	Convert an address/range object to a string.
UpdateConnectedChart
UpdateTableStyle
UpdateTheme	Update theme from CSS.

---

active_sheet

convenience function returns the name of the active sheet. if the sheet name has spaces or other characters that require quoting, it will be quoted using single quotes.

Declaration

public get active_sheet(): string;

public get active_sheet(): string;

Type

---

can_revert

this flag indicates we can revert the document. what that means is we loaded a user-created version from localStorage, but there’s a backing network or inline document. or we did load the original version but the user has made some document changes.

it’s like dirty, but that uses the load source as the ground truth, which means if you load a modified document from localStorage it’s initially considered not-dirty (which is maybe just a bad design?)

the intent of this field is to support enabling/disabling revert logic, or to add a visual indicator that you are not looking at the canonical version.

Declaration

public get can_revert(): boolean;

public get can_revert(): boolean;

Type

---

dirty

indicates the current revision of the document is not equal to the last-saved revision of the document. explicitly set or clear the dirty flag. it’s intended for use by clients that have their own save routine.

Declaration

public get dirty(): boolean;
public set dirty(value: boolean): void;

public get dirty(): boolean;
public set dirty(value: boolean): void;

Type

---

document_name

document name (metadata)

Declaration

public get document_name(): string|undefined;
public set document_name(value: string|undefined): void;

public get document_name(): string|undefined;
public set document_name(value: string|undefined): void;

Type

---

headless

headless state

Declaration

public get headless(): boolean;
public set headless(value: boolean): void;

public get headless(): boolean;
public set headless(value: boolean): void;

Type

---

scale

current grid scale

Declaration

public get scale(): number;
public set scale(value: number): void;

public get scale(): number;
public set scale(value: number): void;

Type

---

sheet_names

returns the names of all sheets in the current document

Declaration

public get sheet_names(): string[];

public get sheet_names(): string[];

Type

---

state

state is the current revision of the document. it is preserved any time the document is saved. it should be a consistent indication of the document version and can be used to compare versions.

state is an atomically-incrementing integer but rolls over at 2^16.

Declaration

public get state(): number;

public get state(): number;

Type

---

user_data

opaque user data (metadata). USER_DATA_TYPE is a template parameter you can set when creating the spreadsheet.

Declaration

public get user_data(): USER_DATA_TYPE|undefined;
public set user_data(value: USER_DATA_TYPE|undefined): void;

public get user_data(): USER_DATA_TYPE|undefined;
public set user_data(value: USER_DATA_TYPE|undefined): void;

Type

---

About

Show the about dialog.

Signature

public About(): void;

public About(): void;

Returns

---

ActivateSheet

Activate sheet.

Signature

public ActivateSheet(index: number | string): void;

public ActivateSheet(index: number | string): void;

Returns

Parameters

index

number | string number | string

sheet name or index.

---

AddSheet

Add a sheet, optionally named.

Signature

public AddSheet(name?: string): number;

public AddSheet(name?: string): number;

Returns

Parameters

name

optional

string string

---

ApplyBorders

Apply borders to range.

Borders are part of style, but setting/removing borders is more complicated than setting other style properties. usually you want things to apply to ranges, rather than individual cells. removing borders needs to consider neighbor borders. and so on.

Signature

public ApplyBorders(range: RangeReference | undefined, borders: BorderConstants, width?: number): void;

public ApplyBorders(range: RangeReference | undefined, borders: BorderConstants, width?: number): void;

Returns

Parameters

range		RangeReference | undefined RangeReference | undefined	pass `undefined` as range to apply to current selection.
borders		BorderConstants BorderConstants
width	optional	number number

---

ApplyStyle

Apply style to range.

Don’t use this method to set borders, use ApplyBorders.

Signature

public ApplyStyle(range?: RangeReference, style?: CellStyle, delta?: boolean): void;

public ApplyStyle(range?: RangeReference, style?: CellStyle, delta?: boolean): void;

Returns

Parameters

range	optional	RangeReference RangeReference	pass `undefined` as range to apply to current selection.
style	optional	CellStyle CellStyle
delta	optional	boolean boolean	apply over existing properties. default true.

---

Batch

Use this function to batch multiple document changes. Essentially the grid stops broadcasting events for the duration of the function call, and collects them instead. After the function call we update as necessary.

Signature

public Batch(func: () => void, paint?: boolean): void;

public Batch(func: () => void, paint?: boolean): void;

Returns

Parameters

func		() => void () => void
paint	optional	boolean boolean

---

Cancel

Cancel subscription

Signature

public Cancel(token: number): void;

public Cancel(token: number): void;

Returns

Parameters

token

number number

the token returned from `Subscribe`

---

ClearName

Remove a named range (removes the name, not the range).

Signature

public ClearName(name: string): void;

public ClearName(name: string): void;

Returns

Parameters

name

string string

---

Copy

copy data. this method returns the copied data. it does not put it on the system clipboard. this is for API access when the system clipboard might not be available.

Signature

public Copy(source?: RangeReference): ClipboardData;

public Copy(source?: RangeReference): ClipboardData;

Returns

Parameters

source

optional

RangeReference RangeReference

---

Cut

cut data. this method returns the cut data. it does not put it on the system clipboard. this method is similar to the Copy method, with two differences: (1) we remove the source data, effectively clearing the source range; and (2) the clipboard data retains references, meaning if you paste the data in a different location it will refer to the same cells.

Signature

public Cut(source?: RangeReference): ClipboardData;

public Cut(source?: RangeReference): ClipboardData;

Returns

Parameters

source

optional

RangeReference RangeReference

---

DefineFunction

Create a macro function.

FIXME: this needs a control for argument separator, like other functions that use formulas (@see SetRange)

Signature

public DefineFunction(name: string, argument_names?: string | string[], function_def?: string): void;

public DefineFunction(name: string, argument_names?: string | string[], function_def?: string): void;

Returns

Parameters

name		string string
argument_names	optional	string | string[] string | string[]
function_def	optional	string string

---

DefineName

Create a named range or named expression. A named range refers to an address or range. A named expression can be any value or formula. To set the value as a literal string, enclose the string in double-quotes (as you would when using a string as a function argument).

This function used to support passing undefined as the value, which meant “create a named range using current selection”. We don’t support that any more but you can accompilsh that with sheet.DefineName("Name", sheet.GetSelection()).

Signature

public DefineName(name: string, value: RangeReference | CellValue, scope?: string | number, overwrite?: boolean): void;

public DefineName(name: string, value: RangeReference | CellValue, scope?: string | number, overwrite?: boolean): void;

Returns

Parameters

name		string string
value		RangeReference | CellValue RangeReference | CellValue	range, value or expression
scope	optional	string | number string | number
overwrite	optional	boolean boolean

---

DeleteColumns

Delete columns(s).

Signature

public DeleteColumns(start_column?: number, count?: number): void;

public DeleteColumns(start_column?: number, count?: number): void;

Returns

Parameters

start_column	optional	number number	leave undefined to use current selection. in this case the `count` parameter will be ignored and all columns in the selection will be deleted.
count	optional	number number

---

DeleteRows

Delete row(s).

Signature

public DeleteRows(start_row?: number, count?: number): void;

public DeleteRows(start_row?: number, count?: number): void;

Returns

Parameters

start_row	optional	number number	leave undefined to use current selection. in this case the `count` parameter will be ignored and all rows in the selection will be deleted.
count	optional	number number

---

DeleteSheet

Delete a sheet.

Signature

public DeleteSheet(index?: string | number): void;

public DeleteSheet(index?: string | number): void;

Returns

Parameters

index

optional

string | number string | number

sheet name or index. Leave undefined to delete the active sheet.

---

Evaluate

Evaluate an arbitrary expression in the spreadsheet. You should generally use sheet names when referring to cells, to avoid ambiguity. Otherwise cell references will resolve to the active sheet.

Signature

public Evaluate(expression: string, options?: EvaluateOptions): CellValue | CellValue[][];

public Evaluate(expression: string, options?: EvaluateOptions): CellValue | CellValue[][];

Returns

Parameters

expression		string string	an expression in spreadsheet language
options	optional	EvaluateOptions EvaluateOptions	options for parsing the passed function

---

Export

Export to XLSX file.

this requires a bunch of processing — one, we do this in a worker, and two, it’s demand loaded so we don’t bloat up this embed script.

Signature

public Export(): void;

public Export(): void;

Returns

---

ExportDelimited

Export sheet as CSV/TSV. This is an internal method called by the save document methods, but you can call it directly if you want the text as a string.

Signature

public ExportDelimited(options?: ExportOptions): string;

public ExportDelimited(options?: ExportOptions): string;

Returns

Parameters

options

optional

ExportOptions ExportOptions

---

ExternalEditor

set or remove an external editor. external editor is an interface used to support outside tooling by highlighting a list of arguments and responding to selection.

Signature

public ExternalEditor(config?: Partial<ExternalEditorConfig>): void;

public ExternalEditor(config?: Partial<ExternalEditorConfig>): void;

Returns

Parameters

config

optional

Partial<ExternalEditorConfig> Partial<ExternalEditorConfig>

---

FilterTable

filter a table. the reference can be the table name, or a cell in the table. if the reference is an area (range), we’re going to look at the top-left cell.

this method uses a function to filter rows based on cell values. leave the function undefined to show all rows. this is a shortcut for “unfilter”.

Signature

public FilterTable(reference: RangeReference, column?: number, filter?: TableFilterFunction): void;

public FilterTable(reference: RangeReference, column?: number, filter?: TableFilterFunction): void;

Returns

Parameters

reference		RangeReference RangeReference
column	optional	number number	the column to sort on. values from this column will be passed to the filter function.
filter	optional	TableFilterFunction TableFilterFunction	a callback function to filter based on cell values. this will be called with the cell value (formula), the calculated value (if any), and the cell style. return false to hide the row, and true to show the row. if the filter parameter is omitted, all values will be shown.

---

Focus

Focus the grid.

Signature

public Focus(): void;

public Focus(): void;

Returns

---

FormatNumber

Format a number with an arbitrary formatter.

Signature

public FormatNumber(value: number, format?: string): string;

public FormatNumber(value: number, format?: string): string;

Returns

Parameters

value		number number
format	optional	string string

---

Freeze

set freeze area

Signature

public Freeze(rows?: number, columns?: number): void;

public Freeze(rows?: number, columns?: number): void;

Returns

Parameters

rows	optional	number number
columns	optional	number number

---

FreezeSelection

freeze at current selection

Signature

public FreezeSelection(): void;

public FreezeSelection(): void;

Returns

---

GetFreeze

return current freeze area

Signature

public GetFreeze(): FreezePane;

public GetFreeze(): FreezePane;

Returns

---

GetRange

undefined

Signature

public GetRange(range?: RangeReference, options?: GetRangeOptions): CellValue | CellValue[][] | undefined;

public GetRange(range?: RangeReference, options?: GetRangeOptions): CellValue | CellValue[][] | undefined;

Returns

Parameters

range	optional	RangeReference RangeReference	target range. leave undefined to use current selection.
options	optional	GetRangeOptions GetRangeOptions

---

GetSelection

Returns the current selection, as a string address or range.

Signature

public GetSelection(qualified?: boolean): string;

public GetSelection(qualified?: boolean): string;

Returns

Parameters

qualified

optional

boolean boolean

include sheet name in result. default true.

---

GetSheetID

Get sheet ID, by name (sheet name) or index. This may be useful for constructing references programatically.

Sheet IDs are positive integers. IDs are ephemeral, they should not be retained after a document is closed or reloaded. They will likely (almost) always be the same, but that’s not guaranteed, so don’t rely on them.

Signature

public GetSheetID(sheet: string | number): number | undefined;

public GetSheetID(sheet: string | number): number | undefined;

Returns

Parameters

sheet

string | number string | number

sheet name or index. sheet names are matched case-insensitively.

---

GetStyle

returns the style from the target address or range.

Signature

public GetStyle(range?: RangeReference, apply_theme?: boolean): CellStyle | CellStyle[][] | undefined;

public GetStyle(range?: RangeReference, apply_theme?: boolean): CellStyle | CellStyle[][] | undefined;

Returns

Parameters

range	optional	RangeReference RangeReference	target range. leave undefined to use current selection
apply_theme	optional	boolean boolean	include theme defaults when returning style

---

HideSheet

Show or hide sheet. This is a replacement for the ShowSheet method, because that name is somewhat ambiguous.

Signature

public HideSheet(index?: number | string, hide?: boolean): void;

public HideSheet(index?: number | string, hide?: boolean): void;

Returns

Parameters

index	optional	number | string number | string	sheet name or index.
hide	optional	boolean boolean

---

InsertAnnotation

Insert an annotation node. Usually this means inserting a chart. Regarding the argument separator, see the Evaluate function.

Signature

public InsertAnnotation(formula: string, type?: AnnotationType, rect?: IRectangle | RangeReference, options?: EvaluateOptions | "," | ";"): void;

public InsertAnnotation(formula: string, type?: AnnotationType, rect?: IRectangle | RangeReference, options?: EvaluateOptions | "," | ";"): void;

Returns

Parameters

formula		string string	annotation formula. For charts, the chart formula.
type	optional	AnnotationType AnnotationType	annotation type. Defaults to `treb-chart`.
rect	optional	IRectangle | RangeReference IRectangle | RangeReference	coordinates, or a range reference for layout.
options	optional	EvaluateOptions | ',' | ';' EvaluateOptions | ',' | ';'	evaluate options. because this function used to take the argument separator, we allow that to be passed directly, but this is deprecated. new code should use the options object.

---

InsertColumns

Insert column(s).

Signature

public InsertColumns(before_column?: number, count?: number): void;

public InsertColumns(before_column?: number, count?: number): void;

Returns

Parameters

before_column	optional	number number	leave undefined to use current selection.
count	optional	number number

---

InsertImage

Insert an image. This method will open a file chooser and (if an image is selected) insert the image into the document.

Signature

public InsertImage(): void;

public InsertImage(): void;

Returns

---

InsertRows

Insert row(s).

Signature

public InsertRows(before_row?: number, count?: number): void;

public InsertRows(before_row?: number, count?: number): void;

Returns

Parameters

before_row	optional	number number	leave undefined to use current selection.
count	optional	number number

---

InsertTable

insert a table in the given range. optionally include a totals row. this method does not make any changes to content or layout. it just converts the range to a table.

Signature

public InsertTable(range?: RangeReference, options?: InsertTableOptions): void;

public InsertTable(range?: RangeReference, options?: InsertTableOptions): void;

Returns

Parameters

range	optional	RangeReference RangeReference
options	optional	InsertTableOptions InsertTableOptions

---

JavascriptDate

convert a spreadsheet date to a javascript date

Signature

public JavascriptDate(spreadsheet_date: number): number;

public JavascriptDate(spreadsheet_date: number): number;

Returns

Parameters

spreadsheet_date

number number

---

LoadCSV

Load CSV from string. This is used internally when loading network documents and local files, but you can call it directly if you have a CSV file as text.

Signature

public LoadCSV(csv: string, source?: LoadSource): void;

public LoadCSV(csv: string, source?: LoadSource): void;

Returns

Parameters

csv		string string
source	optional	LoadSource LoadSource

---

LoadDocument

unserialize document from data.

Signature

public LoadDocument(data: TREBDocument, options?: LoadDocumentOptions): void;

public LoadDocument(data: TREBDocument, options?: LoadDocumentOptions): void;

Returns

Parameters

data		TREBDocument TREBDocument
options	optional	LoadDocumentOptions LoadDocumentOptions

---

LoadFromLocalStorage

load a document from from local storage, using the given key. this method will also set the local option for the storage key, so the document will potentially be saved on modification.

Signature

public LoadFromLocalStorage(key: string): boolean;

public LoadFromLocalStorage(key: string): boolean;

Returns

Parameters

key

string string

---

LoadLanguage

dynamically load language module

Signature

public LoadLanguage(language?: string): Promise<void>;

public LoadLanguage(language?: string): Promise<void>;

Returns

Parameters

language

optional

string string

---

LoadLocalFile

Load a desktop file. This method will show a file chooser and open the selected file (if any).

Signature

public LoadLocalFile(): Promise<void>;

public LoadLocalFile(): Promise<void>;

Returns

---

LoadNetworkDocument

load a network document by URI. CORS headers must be set appropriately on documents originating from different hosts.

Signature

public LoadNetworkDocument(uri: string, options?: EmbeddedSpreadsheetOptions): Promise<void>;

public LoadNetworkDocument(uri: string, options?: EmbeddedSpreadsheetOptions): Promise<void>;

Returns

Parameters

uri		string string
options	optional	EmbeddedSpreadsheetOptions EmbeddedSpreadsheetOptions

---

MergeCells

Merge cells in range.

Signature

public MergeCells(range?: RangeReference): void;

public MergeCells(range?: RangeReference): void;

Returns

Parameters

range

optional

RangeReference RangeReference

target range. leave undefined to use current selection.

---

ParseNumber

Parse a string and return a number (if possible).

Signature

public ParseNumber(text: string): number | Complex | boolean | string | undefined;

public ParseNumber(text: string): number | Complex | boolean | string | undefined;

Returns

Parameters

text

string string

---

Paste

override for paste method omits the data parameter.

Signature

public Paste(target?: RangeReference, options?: PasteOptions): void;

public Paste(target?: RangeReference, options?: PasteOptions): void;

Returns

Parameters

target	optional	RangeReference RangeReference
options	optional	PasteOptions PasteOptions

---

Paste

standard paste method accepts data argument

Signature

public Paste(target?: RangeReference, data?: ClipboardData, options?: PasteOptions): void;

public Paste(target?: RangeReference, data?: ClipboardData, options?: PasteOptions): void;

Returns

Parameters

target	optional	RangeReference RangeReference
data	optional	ClipboardData ClipboardData
options	optional	PasteOptions PasteOptions

---

Recalculate

Recalculate sheet.

Signature

public Recalculate(): void;

public Recalculate(): void;

Returns

---

RemoveConnectedChart

undefined

Signature

public RemoveConnectedChart(id: number): void;

public RemoveConnectedChart(id: number): void;

Returns

Parameters

id

number number

---

RemoveFunction

Delete a macro function.

Signature

public RemoveFunction(name: string): void;

public RemoveFunction(name: string): void;

Returns

Parameters

name

string string

---

RemoveTable

undefined

Signature

public RemoveTable(range?: RangeReference): void;

public RemoveTable(range?: RangeReference): void;

Returns

Parameters

range

optional

RangeReference RangeReference

---

RenameSheet

Rename a sheet.

Signature

public RenameSheet(index: string | number | undefined, new_name: string): void;

public RenameSheet(index: string | number | undefined, new_name: string): void;

Returns

Parameters

index		string | number | undefined string | number | undefined	old name or index of sheet. leave undefined to use current active sheet.
new_name		string string

---

Reset

Clear/reset sheet. This will reset the undo stack as well, so it cannot be undone.

Signature

public Reset(): void;

public Reset(): void;

Returns

---

Resize

Update layout and repaint if necessary.

This method should be called when the container is resized, to trigger an update to layout. It should be called automatically by a resize observer set in the containing tag class, but you can call it manually if necessary.

Signature

public Resize(): void;

public Resize(): void;

Returns

---

Resolve

Resolve a string address/range to an address or area (range) object.

Signature

public Resolve(reference: string): ICellAddress | IArea | undefined;

public Resolve(reference: string): ICellAddress | IArea | undefined;

Returns

Parameters

reference

string string

A string like "A1" or "Sheet1!B2:C3". If a sheet name is not included, the current active sheet is used. You can also pass a named range as reference.

---

Revert

revert to the network version of this document, if local_storage is set and the create options had either document or inline-document set.

FIXME: we should adjust for documents that fail to load.

Signature

public Revert(): void;

public Revert(): void;

Returns

---

SaveLocalFile

undefined

Signature

public SaveLocalFile(filename?: string, additional_options?: SaveOptions): void;

public SaveLocalFile(filename?: string, additional_options?: SaveOptions): void;

Returns

Parameters

filename	optional	string string
additional_options	optional	SaveOptions SaveOptions

---

SaveLocalStorage

Save document to local storage.

Signature

public SaveLocalStorage(key?: string | undefined): void;

public SaveLocalStorage(key?: string | undefined): void;

Returns

Parameters

key

optional

string | undefined string | undefined

optional storage key. if omitted, the method will use the key from local options (set at create time).

---

SaveToDesktop

Save the current document to a desktop file. This is the new version of the method, renamed from SaveLocalFile.

Signature

public SaveToDesktop(filename?: string, additional_options?: SaveOptions): void;

public SaveToDesktop(filename?: string, additional_options?: SaveOptions): void;

Returns

Parameters

filename	optional	string string	Filename or extension to use the document name.
additional_options	optional	SaveOptions SaveOptions

---

ScrollIntoView

scroll the given address into view. it could be at either side of the window. optionally use smooth scrolling.

Signature

public ScrollIntoView(address: AddressReference, smooth?: boolean): void;

public ScrollIntoView(address: AddressReference, smooth?: boolean): void;

Returns

Parameters

address		AddressReference AddressReference
smooth	optional	boolean boolean

---

ScrollOffset

get or set the current scroll offset. scroll offset is automatically saved if you save the document or switch tabs; this is for saving/ restoring scroll if you cache the containing element.

Signature

public ScrollOffset(offset?: Point): Point | undefined;

public ScrollOffset(offset?: Point): Point | undefined;

Returns

Parameters

offset

optional

Point Point

---

ScrollTo

Scroll to the given address. In the current implementation this method will not change sheets, although it probably should if the reference is to a different sheet.

Signature

public ScrollTo(address: AddressReference, options?: SheetScrollOptions): void;

public ScrollTo(address: AddressReference, options?: SheetScrollOptions): void;

Returns

Parameters

address		AddressReference AddressReference
options	optional	SheetScrollOptions SheetScrollOptions

---

Select

Select a range. This function will change sheets if your reference refers to a different sheet. if the argument is undefined or falsy it will remove the selection (set to no selection).

Signature

public Select(range?: RangeReference): void;

public Select(range?: RangeReference): void;

Returns

Parameters

range

optional

RangeReference RangeReference

---

SerializeDocument

Serialize document to a plain javascript object. The result is suitable for converting to JSON. This method is used by the SaveLocalFile and SaveLocalStorage methods, but you can call it directly if you want to save the document some other way.

Signature

public SerializeDocument(options?: SerializeOptions): TREBDocument;

public SerializeDocument(options?: SerializeOptions): TREBDocument;

Returns

Parameters

options

optional

SerializeOptions SerializeOptions

---

SetColumnWidth

Set width of column(s).

Signature

public SetColumnWidth(column?: number | number[], width?: number): void;

public SetColumnWidth(column?: number | number[], width?: number): void;

Returns

Parameters

column	optional	number | number[] number | number[]	column, or columns (array), or undefined means all columns
width	optional	number number	desired width (can be 0) or undefined means 'auto-size'

---

SetLink

Set or remove a link in a cell.

Signature

public SetLink(address?: AddressReference, target?: string): void;

public SetLink(address?: AddressReference, target?: string): void;

Returns

Parameters

address	optional	AddressReference AddressReference
target	optional	string string	http/https URL or a spreadsheet reference (as text). set blank to remove link.

---

SetNote

Set note (comment) in cell.

Signature

public SetNote(address: AddressReference | undefined, note?: string): void;

public SetNote(address: AddressReference | undefined, note?: string): void;

Returns

Parameters

address		AddressReference | undefined AddressReference | undefined	target address, or leave undefined to use current selection.
note	optional	string string	note text, or leave undefined to clear existing note.

---

SetRange

Set data in range.

Signature

public SetRange(range?: RangeReference, data?: CellValue | CellValue[][], options?: SetRangeOptions): void;

public SetRange(range?: RangeReference, data?: CellValue | CellValue[][], options?: SetRangeOptions): void;

Returns

Parameters

range	optional	RangeReference RangeReference	target range. leave undefined to use current selection.
data	optional	CellValue | CellValue[][] CellValue | CellValue[][]
options	optional	SetRangeOptions SetRangeOptions

---

SetRowHeight

Set height of row(s).

Signature

public SetRowHeight(row?: number | number[], height?: number): void;

public SetRowHeight(row?: number | number[], height?: number): void;

Returns

Parameters

row	optional	number | number[] number | number[]	row, or rows (array), or undefined means all rows
height	optional	number number	desired height (can be 0) or undefined means 'auto-size'

---

SetValidation

set or clear cell valiation.

Signature

public SetValidation(target: RangeReference, validation?: RangeReference | CellValue[], error?: boolean): void;

public SetValidation(target: RangeReference, validation?: RangeReference | CellValue[], error?: boolean): void;

Returns

Parameters

target		RangeReference RangeReference	target cell/area
validation	optional	RangeReference | CellValue[] RangeReference | CellValue[]	a spreadsheet range, list of data, or undefined. pass undefined to remove existing cell validation.
error	optional	boolean boolean	setting an invalid value in the target cell is an error (and is blocked). defaults to false.

---

ShowSheet

Show or hide sheet. This method is deprecated because it’s ambiguous. To set a sheet’s visibility, use HideSheet. To activate a sheet, use ActivateSheet.

Signature

public ShowSheet(index?: number | string, show?: boolean): void;

public ShowSheet(index?: number | string, show?: boolean): void;

Returns

Parameters

index	optional	number | string number | string	sheet name or index.
show	optional	boolean boolean

---

SortTable

sort a table. the reference can be the table name, or a cell in the table. if the reference is an area (range), we’re going to look at the top-left cell.

Signature

public SortTable(reference: RangeReference, options?: Partial<TableSortOptions>): void;

public SortTable(reference: RangeReference, options?: Partial<TableSortOptions>): void;

Returns

Parameters

reference		RangeReference RangeReference
options	optional	Partial<TableSortOptions> Partial<TableSortOptions>

---

SpreadsheetDate

convert a javascript date (or timestamp) to a spreadsheet date

Signature

public SpreadsheetDate(javascript_date: number | Date): number;

public SpreadsheetDate(javascript_date: number | Date): number;

Returns

Parameters

javascript_date

number | Date number | Date

---

Subscribe

Subscribe to spreadsheet events

Signature

public Subscribe(subscriber: (event: EmbeddedSheetEvent) => void): number;

public Subscribe(subscriber: (event: EmbeddedSheetEvent) => void): number;

Returns

Parameters

subscriber

(event: EmbeddedSheetEvent) => void (event: EmbeddedSheetEvent) => void

callback function

---

Undo

Revert state one level from the undo stack.

Signature

public Undo(): void;

public Undo(): void;

Returns

---

UnmergeCells

Unmerge cells in range.

Signature

public UnmergeCells(range?: RangeReference): void;

public UnmergeCells(range?: RangeReference): void;

Returns

Parameters

range

optional

RangeReference RangeReference

target range. leave undefined to use current selection.

---

Unresolve

Convert an address/range object to a string. this is a convenience function for composing formulas.

Signature

public Unresolve(ref: RangeReference, qualified?: boolean, named?: boolean): string;

public Unresolve(ref: RangeReference, qualified?: boolean, named?: boolean): string;

Returns

Parameters

ref		RangeReference RangeReference	sheet reference as a string or structured object
qualified	optional	boolean boolean	include sheet names
named	optional	boolean boolean	resolve to named ranges, where applicable

---

UpdateConnectedChart

undefined

Signature

public UpdateConnectedChart(id: number, formula: string): void;

public UpdateConnectedChart(id: number, formula: string): void;

Returns

Parameters

id		number number
formula		string string

---

UpdateTableStyle

undefined

Signature

public UpdateTableStyle(range?: RangeReference, theme?: TableTheme | number): void;

public UpdateTableStyle(range?: RangeReference, theme?: TableTheme | number): void;

Returns

Parameters

range	optional	RangeReference RangeReference
theme	optional	TableTheme | number TableTheme | number

---

UpdateTheme

Update theme from CSS. Because the spreadsheet is painted, not rendered, you need to notifiy us if external style (CSS) properties have changed. We will update and repaint.

Signature

public UpdateTheme(): void;

public UpdateTheme(): void;

Returns