@univerjs/engine-formula v0.5.0-beta.1 • Docs

Class: FormulaDataModel

Extends

Disposable

Constructors

new FormulaDataModel()

new FormulaDataModel(_univerInstanceService, _lexerTreeBuilder): FormulaDataModel

Parameters

Parameter	Type
`_univerInstanceService`	`IUniverInstanceService`
`_lexerTreeBuilder`	`LexerTreeBuilder`

Returns

FormulaDataModel

Overrides

Disposable.constructor

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:47

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93

Methods

clearPreviousArrayFormulaCellData()

clearPreviousArrayFormulaCellData(clearArrayFormulaCellData): void

Parameters

Parameter	Type
`clearArrayFormulaCellData`	`IRuntimeUnitDataType`

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:63

deleteArrayFormulaRange()

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

Parameters

Parameter	Type
`unitId`	`string`
`sheetId`	`string`
`row`	`number`
`column`	`number`

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:258

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:56

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100

getArrayFormulaCellData()

getArrayFormulaCellData(): IArrayFormulaUnitCellType

Returns

IArrayFormulaUnitCellType

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:176

getArrayFormulaRange()

getArrayFormulaRange(): IArrayFormulaRangeType

Returns

IArrayFormulaRangeType

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:168

getCalculateData()

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

Returns

{
  allUnitData: IUnitData;
  unitSheetNameMap: IUnitSheetNameMap;
}

Name	Type	Defined in
`allUnitData`	`IUnitData`	submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:337
`unitSheetNameMap`	`IUnitSheetNameMap`	submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:338

Defined in

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

getFormulaData()

getFormulaData(): IFormulaData

Returns

IFormulaData

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:160

getFormulaDataItem()

getFormulaDataItem(
   row, 
   column, 
   sheetId, 
unitId): Nullable<IFormulaDataItem>

Parameters

Parameter	Type
`row`	`number`
`column`	`number`
`sheetId`	`string`
`unitId`	`string`

Returns

Nullable<IFormulaDataItem>

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:492

getFormulaDirtyRanges()

getFormulaDirtyRanges(): IUnitRange[]

Function to get all formula ranges

Returns

IUnitRange[]

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:573

getFormulaIdMap()

getFormulaIdMap(unitId, sheetId): Map<string, IFormulaIdMap>

Parameters

Parameter	Type
`unitId`	`string`
`sheetId`	`string`

Returns

Map<string, IFormulaIdMap>

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:496

getFormulaItemBySId()

getFormulaItemBySId(
   sId, 
   sheetId, 
unitId): Nullable<IFormulaDataItem>

Parameters

Parameter	Type
`sId`	`string`
`sheetId`	`string`
`unitId`	`string`

Returns

Nullable<IFormulaDataItem>

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:462

getFormulaStringByCell()

getFormulaStringByCell(
   row, 
   column, 
   sheetId, 
   unitId): null | string

Parameters

Parameter	Type
`row`	`number`
`column`	`number`
`sheetId`	`string`
`unitId`	`string`

Returns

null | string

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:525

initFormulaData()

initFormulaData(): void

Cache all formulas on the snapshot to the formula model

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:277

mergeArrayFormulaCellData()

mergeArrayFormulaCellData(unitData): void

Parameters

Parameter	Type
`unitData`	`IRuntimeUnitDataType`

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:111

mergeArrayFormulaRange()

mergeArrayFormulaRange(formulaData): void

Parameters

Parameter	Type
`formulaData`	`IArrayFormulaRangeType`

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:184

mergeFormulaData()

mergeFormulaData(formulaData): void

Parameters

Parameter	Type
`formulaData`	`IFormulaData`

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:211

setArrayFormulaCellData()

setArrayFormulaCellData(value): void

Parameters

Parameter	Type
`value`	`IArrayFormulaUnitCellType`

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:180

setArrayFormulaRange()

setArrayFormulaRange(value): void

Parameters

Parameter	Type
`value`	`IArrayFormulaRangeType`

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:172

setFormulaData()

setFormulaData(value): void

Parameters

Parameter	Type
`value`	`IFormulaData`

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:164

updateArrayFormulaCellData()

updateArrayFormulaCellData(
   unitId, 
   sheetId, 
   cellValue): void

Parameters

Parameter	Type
`unitId`	`string`
`sheetId`	`string`
`cellValue`	`IObjectMatrixPrimitiveType`<`Nullable`<`ICellData`>>

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:436

updateArrayFormulaRange()

updateArrayFormulaRange(
   unitId, 
   sheetId, 
   cellValue): void

Parameters

Parameter	Type
`unitId`	`string`
`sheetId`	`string`
`cellValue`	`IObjectMatrixPrimitiveType`<`Nullable`<`ICellData`>>

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:417

updateFormulaData()

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

Parameters

Parameter	Type
`unitId`	`string`
`sheetId`	`string`
`cellValue`	`IObjectMatrixPrimitiveType`<`Nullable`<`ICellData`>>

Returns

IObjectMatrixPrimitiveType<null | IFormulaDataItem>

Defined in

submodules/univer/packages/engine-formula/src/models/formula-data.model.ts:342

Formulacurrentconfigservice Formuladependencygenerator