Metadata of every function that formulas in store can call: the built-in
functions of the active engine, then the host functions of store in
registration order. Formula help reads this one list. The built-in table
loads on the first call, so the result is a promise.
Declaration
Referenced by
Workspace packages depending on @sheetwrite/core
@sheetwrite/benchdependency@sheetwrite/chartsdependency@sheetwrite/docs-startdependency@sheetwrite/reactdependency@sheetwrite/sveltedependency@sheetwrite/vuedependency@sheetwrite/xlsxdependency
Public exports naming listFunctions
interface Store {
getWorkbook(): Workbook;
getCell(addr: CellAddress): ResolvedCell;
getFormula(addr: CellAddress): string | null;
getSpillAnchor(addr: CellAddress): CellAddress | null;
getRefTarget(addr: CellAddress): CellAddress | null;
recalculateVolatile(now?: Date): void;
getVisibleWindow(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
): VisibleWindowView;
getDataWindow?(
sheet: SheetId,
rows: { start: number; end: number },
// … 27 more lines — see the API reference
}interface Store {
getWorkbook(): Workbook;
getCell(addr: CellAddress): ResolvedCell;
getFormula(addr: CellAddress): string | null;
getSpillAnchor(addr: CellAddress): CellAddress | null;
getRefTarget(addr: CellAddress): CellAddress | null;
recalculateVolatile(now?: Date): void;
getVisibleWindow(
sheet: SheetId,
rows: { start: number; end: number },
cols: readonly number[],
): VisibleWindowView;
getDataWindow?(
sheet: SheetId,
rows: { start: number; end: number },
// … 27 more lines — see the API reference
}interface Store {
getWorkbook(): Workbook;
getCell(
addr: CellAddress,
): ResolvedCell;
getFormula(
addr: CellAddress,
): string | null;
getSpillAnchor(
addr: CellAddress,
): CellAddress | null;
getRefTarget(
addr: CellAddress,
): CellAddress | null;
recalculateVolatile(
now?: Date,
): void;
getVisibleWindow(
sheet: SheetId,
// … 60 more lines — see the API reference
}Columnar workbook storage, query, transaction, and subscription contract.API reference →interface FormulaFunctionMetadata {
readonly name: string;
readonly description: string;
readonly arguments: readonly FormulaArgumentMetadata[];
readonly returnKind: string;
readonly examples?: readonly string[];
readonly volatile?: boolean;
}interface FormulaFunctionMetadata {
readonly name: string;
readonly description: string;
readonly arguments: readonly FormulaArgumentMetadata[];
readonly returnKind: string;
readonly examples?: readonly string[];
readonly volatile?: boolean;
}interface FormulaFunctionMetadata {
readonly name: string;
readonly description: string;
readonly arguments: readonly FormulaArgumentMetadata[];
readonly returnKind: string;
readonly examples?: readonly string[];
readonly volatile?: boolean;
}One metadata format for built-in and host functions.API reference →