@univerjs/engine-formula v0.1.17 • 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:57 (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:245 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

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

disposeWithMe()

protected 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:165 (opens in a new tab)

getArrayFormulaRange()

getArrayFormulaRange(): IArrayFormulaRangeType

Returns

IArrayFormulaRangeType

Defined in

packages/engine-formula/src/models/formula-data.model.ts:157 (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:322 (opens in a new tab)
`unitSheetNameMap`	`IUnitSheetNameMap`	packages/engine-formula/src/models/formula-data.model.ts:323 (opens in a new tab)

Defined in

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

getFormulaData()

getFormulaData(): IFormulaData

Returns

IFormulaData

Defined in

packages/engine-formula/src/models/formula-data.model.ts:149 (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:477 (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:481 (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:447 (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:510 (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:264 (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:100 (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:173 (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:200 (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:169 (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:161 (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:153 (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:421 (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:402 (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:327 (opens in a new tab)

Formulacurrentconfigservice Formularuntimeservice

Class: FormulaDataModel

Extends

Constructors

new FormulaDataModel()

Parameters

Returns

Overrides

Defined in

Properties

Methods

clearPreviousArrayFormulaCellData()

Parameters

Returns

Defined in

deleteArrayFormulaRange()

Parameters

Returns

Defined in

dispose()

Returns

Inherited from

Defined in

disposeWithMe()

Parameters

Returns

Inherited from

Defined in

ensureNotDisposed()

Returns

Inherited from

Defined in

getArrayFormulaCellData()

Returns

Defined in

getArrayFormulaRange()

Returns

Defined in

getCalculateData()

Returns

Defined in

getFormulaData()

Returns

Defined in

getFormulaDataItem()

Parameters

Returns

Defined in

getFormulaIdMap()

Parameters

Returns

Defined in

getFormulaItemBySId()

Parameters

Returns

Defined in

getFormulaStringByCell()

Parameters

Returns

Defined in

initFormulaData()

Returns

Defined in

mergeArrayFormulaCellData()

Parameters

Returns

Defined in

mergeArrayFormulaRange()

Parameters

Returns

Defined in

mergeFormulaData()

Parameters

Returns

Defined in

setArrayFormulaCellData()

Parameters

Returns

Defined in

setArrayFormulaRange()

Parameters