WorkbookDescription
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WorkbookDescription(wb, options?): WorkbookDescription;Parameters
Section titled “Parameters”options?
Section titled “options?”Partial<DescriptionOptions>
Returns
Section titled “Returns”WorkbookDescription
Properties
Section titled “Properties”calculated
Section titled “calculated”calculated: ChunkNode[] = [];cellR1C1formula
Section titled “cellR1C1formula”cellR1C1formula: DefaultMap<CellItem, string | null>;chunkedGraph
Section titled “chunkedGraph”chunkedGraph: DependencyGraph<ChunkNode, KnownVertexId>;formulaRangeRTrees
Section titled “formulaRangeRTrees”formulaRangeRTrees: DefaultMap<number, RTree<RangeFormulaNode>>;labels
Section titled “labels”labels: Label[];names: DefinedNameDescription[];options
Section titled “options”options: DescriptionOptions;parameters
Section titled “parameters”parameters: Parameter[];sheets
Section titled “sheets”sheets: SheetDescription[];summary
Section titled “summary”summary: | { calculated: object[]; description: string; parameters: object[]; wbId: string;} | null;totalFormulas
Section titled “totalFormulas”totalFormulas: number;workbook
Section titled “workbook”workbook: Workbook;Methods
Section titled “Methods”cellReference()
Section titled “cellReference()”cellReference(vertexId): Reference | undefined;Parameters
Section titled “Parameters”vertexId
Section titled “vertexId”CellVertexId | NameVertexId
Returns
Section titled “Returns”Reference | undefined
describeValues()
Section titled “describeValues()”describeValues(lab): string | undefined;Parameters
Section titled “Parameters”Labeled
Returns
Section titled “Returns”string | undefined
extractAllText()
Section titled “extractAllText()”extractAllText(): Set<string>;Returns
Section titled “Returns”Set<string>
getCalculated()
Section titled “getCalculated()”getCalculated(cellOrRef): ChunkNode | undefined;Parameters
Section titled “Parameters”cellOrRef
Section titled “cellOrRef”Returns
Section titled “Returns”ChunkNode | undefined
getCellLabel()
Section titled “getCellLabel()”getCellLabel(cellOrRef): string;Parameters
Section titled “Parameters”cellOrRef
Section titled “cellOrRef”Returns
Section titled “Returns”string
getParameter()
Section titled “getParameter()”getParameter(cellOrRef): Parameter | undefined;Parameters
Section titled “Parameters”cellOrRef
Section titled “cellOrRef”Returns
Section titled “Returns”Parameter | undefined
isParameter()
Section titled “isParameter()”isParameter(vertexId, sheetIndex): boolean;Parameters
Section titled “Parameters”vertexId
Section titled “vertexId”CellVertexId
sheetIndex
Section titled “sheetIndex”number
Returns
Section titled “Returns”boolean
labelString()
Section titled “labelString()”labelString(label): string;Parameters
Section titled “Parameters”Label
Returns
Section titled “Returns”string
likelyLabels()
Section titled “likelyLabels()”likelyLabels(vertexId): readonly Label[];Parameters
Section titled “Parameters”vertexId
Section titled “vertexId”KnownVertexId
Returns
Section titled “Returns”readonly Label[]
setSummary()
Section titled “setSummary()”setSummary(): | { calculated: object[]; description: string; parameters: object[]; wbId: string;} | null;Returns
Section titled “Returns”| {
calculated: object[];
description: string;
parameters: object[];
wbId: string;
}
| null
toString()
Section titled “toString()”toString(): string;Returns
Section titled “Returns”string