@univerjs/engine-formula v0.4.2 • Docs

Class: FormulaDataModel

Extends

Disposable

Constructors

new FormulaDataModel()

new FormulaDataModel(_univerInstanceService, _lexerTreeBuilder): FormulaDataModel

Parameters

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

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)

Methods

clearPreviousArrayFormulaCellData()

clearPreviousArrayFormulaCellData(clearArrayFormulaCellData): void

Parameters

Parameter	Type
`clearArrayFormulaCellData`	`IRuntimeUnitDataType`

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:63 (opens in a new tab)

deleteArrayFormulaRange()

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

Parameters

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

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:256 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

packages/engine-formula/src/models/formula-data.model.ts:56 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

getArrayFormulaCellData()

getArrayFormulaCellData(): IArrayFormulaUnitCellType

Returns

IArrayFormulaUnitCellType

Defined in

packages/engine-formula/src/models/formula-data.model.ts:176 (opens in a new tab)

getArrayFormulaRange()

getArrayFormulaRange(): IArrayFormulaRangeType

Returns

IArrayFormulaRangeType

Defined in

packages/engine-formula/src/models/formula-data.model.ts:168 (opens in a new tab)

getCalculateData()

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

Returns

{
  allUnitData: IUnitData;
  unitSheetNameMap: IUnitSheetNameMap;
}

Name	Type	Defined in
`allUnitData`	`IUnitData`	packages/engine-formula/src/models/formula-data.model.ts:335 (opens in a new tab)
`unitSheetNameMap`	`IUnitSheetNameMap`	packages/engine-formula/src/models/formula-data.model.ts:336 (opens in a new tab)

Defined in

packages/engine-formula/src/models/formula-data.model.ts:297 (opens in a new tab)

getFormulaData()

getFormulaData(): IFormulaData

Returns

IFormulaData

Defined in

packages/engine-formula/src/models/formula-data.model.ts:160 (opens in a new tab)

getFormulaDataItem()

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

Parameters

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

Returns

Nullable<IFormulaDataItem>

Defined in

packages/engine-formula/src/models/formula-data.model.ts:490 (opens in a new tab)

getFormulaIdMap()

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

Parameters

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

Returns

Map<string, IFormulaIdMap>

Defined in

packages/engine-formula/src/models/formula-data.model.ts:494 (opens in a new tab)

getFormulaItemBySId()

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

Parameters

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

Returns

Nullable<IFormulaDataItem>

Defined in

packages/engine-formula/src/models/formula-data.model.ts:460 (opens in a new tab)

getFormulaStringByCell()

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

Parameters

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

Returns

null | string

Defined in

packages/engine-formula/src/models/formula-data.model.ts:523 (opens in a new tab)

initFormulaData()

initFormulaData(): void

Cache all formulas on the snapshot to the formula model

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:275 (opens in a new tab)

mergeArrayFormulaCellData()

mergeArrayFormulaCellData(unitData): void

Parameters

Parameter	Type
`unitData`	`IRuntimeUnitDataType`

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:111 (opens in a new tab)

mergeArrayFormulaRange()

mergeArrayFormulaRange(formulaData): void

Parameters

Parameter	Type
`formulaData`	`IArrayFormulaRangeType`

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:184 (opens in a new tab)

mergeFormulaData()

mergeFormulaData(formulaData): void

Parameters

Parameter	Type
`formulaData`	`IFormulaData`

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:211 (opens in a new tab)

setArrayFormulaCellData()

setArrayFormulaCellData(value): void

Parameters

Parameter	Type
`value`	`IArrayFormulaUnitCellType`

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:180 (opens in a new tab)

setArrayFormulaRange()

setArrayFormulaRange(value): void

Parameters

Parameter	Type
`value`	`IArrayFormulaRangeType`

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:172 (opens in a new tab)

setFormulaData()

setFormulaData(value): void

Parameters

Parameter	Type
`value`	`IFormulaData`

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:164 (opens in a new tab)

updateArrayFormulaCellData()

updateArrayFormulaCellData(
   unitId, 
   sheetId, 
   cellValue): void

Parameters

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

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:434 (opens in a new tab)

updateArrayFormulaRange()

updateArrayFormulaRange(
   unitId, 
   sheetId, 
   cellValue): void

Parameters

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

Returns

void

Defined in

packages/engine-formula/src/models/formula-data.model.ts:415 (opens in a new tab)

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

packages/engine-formula/src/models/formula-data.model.ts:340 (opens in a new tab)

Formulacurrentconfigservice Formuladependencygenerator