@univerjs/engine-formula v0.5.4


Class: FormulaDataModel

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:39

Extends

Constructors

new FormulaDataModel()

new FormulaDataModel(_univerInstanceService, _lexerTreeBuilder): FormulaDataModel

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:44

Parameters

ParameterType
_univerInstanceServiceIUniverInstanceService
_lexerTreeBuilderLexerTreeBuilder

Returns

FormulaDataModel

Overrides

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96

Methods

clearPreviousArrayFormulaCellData()

clearPreviousArrayFormulaCellData(clearArrayFormulaCellData): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:57

Parameters

ParameterType
clearArrayFormulaCellDataIRuntimeUnitDataType

Returns

void


deleteArrayFormulaRange()

deleteArrayFormulaRange(
   unitId, 
   sheetId, 
   row, 
   column): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:241

Parameters

ParameterType
unitIdstring
sheetIdstring
rownumber
columnnumber

Returns

void


dispose()

dispose(): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:51

Returns

void

Overrides

Disposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed


getArrayFormulaCellData()

getArrayFormulaCellData(): IArrayFormulaUnitCellType

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:206

Returns

IArrayFormulaUnitCellType


getArrayFormulaRange()

getArrayFormulaRange(): IArrayFormulaRangeType

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:198

Returns

IArrayFormulaRangeType


getCalculateData()

getCalculateData(): {
  allUnitData: IUnitData;
  unitSheetNameMap: IUnitSheetNameMap;
}

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:256

Returns

{
  allUnitData: IUnitData;
  unitSheetNameMap: IUnitSheetNameMap;
}
NameTypeDefined in
allUnitDataIUnitDatasubmodules/univer/packages/engine-formula/src/models/formula-data.model.ts:294
unitSheetNameMapIUnitSheetNameMapsubmodules/univer/packages/engine-formula/src/models/formula-data.model.ts:295

getFormulaData()

getFormulaData(): IFormulaData

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:154

Returns

IFormulaData


getFormulaDirtyRanges()

getFormulaDirtyRanges(): IUnitRange[]

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:465

Function to get all formula ranges

Returns

IUnitRange[]


getFormulaStringByCell()

getFormulaStringByCell(
   row, 
   column, 
   sheetId, 
unitId): Nullable<string>

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:408

Parameters

ParameterType
rownumber
columnnumber
sheetIdstring
unitIdstring

Returns

Nullable<string>


getSheetFormulaData()

getSheetFormulaData(unitId, sheetId): Nullable<IObjectMatrixPrimitiveType<Nullable<IFormulaDataItem>>>

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:177

Parameters

ParameterType
unitIdstring
sheetIdstring

Returns

Nullable<IObjectMatrixPrimitiveType<Nullable<IFormulaDataItem>>>


mergeArrayFormulaCellData()

mergeArrayFormulaCellData(unitData): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:105

Parameters

ParameterType
unitDataIRuntimeUnitDataType

Returns

void


mergeArrayFormulaRange()

mergeArrayFormulaRange(formulaData): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:214

Parameters

ParameterType
formulaDataIArrayFormulaRangeType

Returns

void


setArrayFormulaCellData()

setArrayFormulaCellData(value): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:210

Parameters

ParameterType
valueIArrayFormulaUnitCellType

Returns

void


setArrayFormulaRange()

setArrayFormulaRange(value): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:202

Parameters

ParameterType
valueIArrayFormulaRangeType

Returns

void


updateArrayFormulaCellData()

updateArrayFormulaCellData(
   unitId, 
   sheetId, 
   cellValue): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:382

Parameters

ParameterType
unitIdstring
sheetIdstring
cellValueIObjectMatrixPrimitiveType<Nullable<ICellData>>

Returns

void


updateArrayFormulaRange()

updateArrayFormulaRange(
   unitId, 
   sheetId, 
   cellValue): void

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:363

Parameters

ParameterType
unitIdstring
sheetIdstring
cellValueIObjectMatrixPrimitiveType<Nullable<ICellData>>

Returns

void


updateFormulaData()

updateFormulaData(
   unitId, 
   sheetId, 
cellValue): IObjectMatrixPrimitiveType<null | IFormulaDataItem>

Defined in: submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:299

Parameters

ParameterType
unitIdstring
sheetIdstring
cellValueIObjectMatrixPrimitiveType<Nullable<ICellData>>

Returns

IObjectMatrixPrimitiveType<null | IFormulaDataItem>