@univerjs/engine-formula v0.4.2 • Docs

Class: FormulaRuntimeService

Extends

• Disposable

Implements

• IFormulaRuntimeService

Constructors

new FormulaRuntimeService()

new FormulaRuntimeService(_currentConfigService): FormulaRuntimeService

Parameters

Returns

FormulaRuntimeService

Overrides

Disposable.constructor

Defined in

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

Properties

Accessors

currentColumn

get currentColumn(): number

Returns

number

Implementation of

IFormulaRuntimeService.currentColumn

Defined in

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

currentColumnCount

get currentColumnCount(): number

Returns

number

Defined in

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

currentRow

get currentRow(): number

Returns

number

Implementation of

IFormulaRuntimeService.currentRow

Defined in

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

currentRowCount

get currentRowCount(): number

Returns

number

Defined in

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

currentSubUnitId

get currentSubUnitId(): string

Returns

string

Implementation of

IFormulaRuntimeService.currentSubUnitId

Defined in

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

currentUnitId

get currentUnitId(): string

Returns

string

Implementation of

IFormulaRuntimeService.currentUnitId

Defined in

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

Methods

clearFunctionDefinitionPrivacyVar()

clearFunctionDefinitionPrivacyVar(): void

Returns

void

Defined in

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

clearReferenceAndNumberformatCache()

clearReferenceAndNumberformatCache(): void

Returns

void

Implementation of

IFormulaRuntimeService.clearReferenceAndNumberformatCache

Defined in

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

disableCycleDependency()

disableCycleDependency(): void

Returns

void

Implementation of

IFormulaRuntimeService.disableCycleDependency

Defined in

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

dispose()

dispose(): void

Returns

void

Implementation of

IFormulaRuntimeService.dispose

Overrides

Disposable.dispose

Defined in

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

enableCycleDependency()

enableCycleDependency(): void

Returns

void

Implementation of

IFormulaRuntimeService.enableCycleDependency

Defined in

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

getAllRuntimeData()

getAllRuntimeData(): IAllRuntimeData

Returns

IAllRuntimeData

Implementation of

IFormulaRuntimeService.getAllRuntimeData

Defined in

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

getCompletedArrayFormulasCount()

getCompletedArrayFormulasCount(): number

Returns

number

Implementation of

IFormulaRuntimeService.getCompletedArrayFormulasCount

Defined in

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

getCompletedFormulasCount()

getCompletedFormulasCount(): number

Returns

number

Implementation of

IFormulaRuntimeService.getCompletedFormulasCount

Defined in

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

getFormulaCycleIndex()

getFormulaCycleIndex(): number

Returns

number

Defined in

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

getFormulaExecuteStage()

getFormulaExecuteStage(): FormulaExecuteStageType

Returns

FormulaExecuteStageType

Implementation of

IFormulaRuntimeService.getFormulaExecuteStage

Defined in

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

getFunctionDefinitionPrivacyVar()

getFunctionDefinitionPrivacyVar(lambdaId): Nullable<Map<string, Nullable<BaseAstNode>>>

Parameters

Returns

Nullable<Map<string, Nullable<BaseAstNode>>>

Implementation of

IFormulaRuntimeService.getFunctionDefinitionPrivacyVar

Defined in

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

getRuntimeArrayFormulaCellData()

getRuntimeArrayFormulaCellData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Implementation of

IFormulaRuntimeService.getRuntimeArrayFormulaCellData

Defined in

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

getRuntimeClearArrayFormulaCellData()

getRuntimeClearArrayFormulaCellData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Defined in

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

getRuntimeFeatureCellData()

getRuntimeFeatureCellData(): {}

Returns

{}

Implementation of

IFormulaRuntimeService.getRuntimeFeatureCellData

Defined in

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

getRuntimeFeatureRange()

getRuntimeFeatureRange(): {}

Returns

{}

Implementation of

IFormulaRuntimeService.getRuntimeFeatureRange

Defined in

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

getRuntimeOtherData()

getRuntimeOtherData(): IRuntimeOtherUnitDataType

Returns

IRuntimeOtherUnitDataType

Implementation of

IFormulaRuntimeService.getRuntimeOtherData

Defined in

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

getRuntimeState()

getRuntimeState(): IExecutionInProgressParams

Returns

IExecutionInProgressParams

Implementation of

IFormulaRuntimeService.getRuntimeState

Defined in

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

getTotalArrayFormulasToCalculate()

getTotalArrayFormulasToCalculate(): number

Returns

number

Implementation of

IFormulaRuntimeService.getTotalArrayFormulasToCalculate

Defined in

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

getTotalFormulasToCalculate()

getTotalFormulasToCalculate(): number

Returns

number

Implementation of

IFormulaRuntimeService.getTotalFormulasToCalculate

Defined in

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

getUnitArrayFormula()

getUnitArrayFormula(): IArrayFormulaRangeType

Returns

IArrayFormulaRangeType

Implementation of

IFormulaRuntimeService.getUnitArrayFormula

Defined in

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

getUnitData()

getUnitData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Implementation of

IFormulaRuntimeService.getUnitData

Defined in

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

isCycleDependency()

isCycleDependency(): boolean

Returns

boolean

Implementation of

IFormulaRuntimeService.isCycleDependency

Defined in

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

isStopExecution()

isStopExecution(): boolean

Returns

boolean

Implementation of

IFormulaRuntimeService.isStopExecution

Defined in

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

markedAsInitialFunctionsExecuted()

markedAsInitialFunctionsExecuted(): void

Returns

void

Implementation of

IFormulaRuntimeService.markedAsInitialFunctionsExecuted

Defined in

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

markedAsNoFunctionsExecuted()

markedAsNoFunctionsExecuted(): void

Returns

void

Implementation of

IFormulaRuntimeService.markedAsNoFunctionsExecuted

Defined in

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

markedAsStopFunctionsExecuted()

markedAsStopFunctionsExecuted(): void

Returns

void

Implementation of

IFormulaRuntimeService.markedAsStopFunctionsExecuted

Defined in

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

markedAsSuccessfullyExecuted()

markedAsSuccessfullyExecuted(): void

Returns

void

Implementation of

IFormulaRuntimeService.markedAsSuccessfullyExecuted

Defined in

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

registerFunctionDefinitionPrivacyVar()

registerFunctionDefinitionPrivacyVar(lambdaId, lambdaVar): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.registerFunctionDefinitionPrivacyVar

Defined in

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

reset()

reset(): void

Returns

void

Implementation of

IFormulaRuntimeService.reset

Defined in

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

setCompletedArrayFormulasCount()

setCompletedArrayFormulasCount(value): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setCompletedArrayFormulasCount

Defined in

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

setCompletedFormulasCount()

setCompletedFormulasCount(value): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setCompletedFormulasCount

Defined in

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

setCurrent()

setCurrent(
   row, 
   column, 
   rowCount, 
   columnCount, 
   sheetId, 
   unitId): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setCurrent

Defined in

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

setFormulaCycleIndex()

setFormulaCycleIndex(index): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setFormulaCycleIndex

Defined in

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

setFormulaExecuteStage()

setFormulaExecuteStage(type): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setFormulaExecuteStage

Defined in

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

setRuntimeData()

setRuntimeData(functionVariant): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setRuntimeData

Defined in

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

setRuntimeFeatureCellData()

setRuntimeFeatureCellData(featureId, featureData): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setRuntimeFeatureCellData

Defined in

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

setRuntimeFeatureRange()

setRuntimeFeatureRange(featureId, featureRange): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setRuntimeFeatureRange

Defined in

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

setRuntimeOtherData()

setRuntimeOtherData(formulaId, functionVariant): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setRuntimeOtherData

Defined in

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

setTotalArrayFormulasToCalculate()

setTotalArrayFormulasToCalculate(value): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setTotalArrayFormulasToCalculate

Defined in

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

setTotalFormulasToCalculate()

setTotalFormulasToCalculate(value): void

Parameters

Returns

void

Implementation of

IFormulaRuntimeService.setTotalFormulasToCalculate

Defined in

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

stopExecution()

stopExecution(): void

Returns

void

Implementation of

IFormulaRuntimeService.stopExecution

Defined in

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