@univerjs/engine-formula v0.4.2 • Docs

Class: CalculateFormulaService

Extends

• Disposable

Constructors

new CalculateFormulaService()

new CalculateFormulaService(
   _configService, 
   _lexer, 
   _currentConfigService, 
   _runtimeService, 
   _formulaDependencyGenerator, 
   _interpreter, 
   _astTreeBuilder): CalculateFormulaService

Parameters

Returns

CalculateFormulaService

Overrides

Disposable.constructor

Defined in

packages/engine-formula/src/services/calculate-formula.service.ts:66 (opens in a new tab)

Properties

Methods

calculate()

calculate(formulaString, transformSuffix): undefined | ErrorNode

Parameters

Returns

undefined | ErrorNode

Defined in

packages/engine-formula/src/services/calculate-formula.service.ts:339 (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()

disposeWithMe(disposable): IDisposable

Parameters

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)

execute()

execute(formulaDatasetConfig): Promise<void>

Parameters

Returns

Promise<void>

Defined in

packages/engine-formula/src/services/calculate-formula.service.ts:100 (opens in a new tab)

setRuntimeFeatureCellData()

setRuntimeFeatureCellData(featureId, featureData): void

When the feature is loading, the pre-calculated content needs to be input to the formula engine in advance, so that the formula can read the correct values.

Parameters

Returns

void

Defined in

packages/engine-formula/src/services/calculate-formula.service.ts:92 (opens in a new tab)

setRuntimeFeatureRange()

setRuntimeFeatureRange(featureId, featureRange): void

Parameters

Returns

void

Defined in

packages/engine-formula/src/services/calculate-formula.service.ts:96 (opens in a new tab)

stopFormulaExecution()

stopFormulaExecution(): void

Stop the execution of the formula.

Returns

void

Defined in

packages/engine-formula/src/services/calculate-formula.service.ts:81 (opens in a new tab)