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


Class: FormulaRuntimeService

Extends

Implements

Constructors

new FormulaRuntimeService()

new FormulaRuntimeService(_currentConfigService): FormulaRuntimeService

Parameters

ParameterType
_currentConfigServiceIFormulaCurrentConfigService

Returns

FormulaRuntimeService

Overrides

Disposable.constructor

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:230

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93

Accessors

currentColumn

Get Signature

get currentColumn(): number
Returns

number

Implementation of

IFormulaRuntimeService.currentColumn

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:238


currentColumnCount

Get Signature

get currentColumnCount(): number
Returns

number

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:246


currentRow

Get Signature

get currentRow(): number
Returns

number

Implementation of

IFormulaRuntimeService.currentRow

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:234


currentRowCount

Get Signature

get currentRowCount(): number
Returns

number

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:242


currentSubUnitId

Get Signature

get currentSubUnitId(): string
Returns

string

Implementation of

IFormulaRuntimeService.currentSubUnitId

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:250


currentUnitId

Get Signature

get currentUnitId(): string
Returns

string

Implementation of

IFormulaRuntimeService.currentUnitId

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:254

Methods

clearFunctionDefinitionPrivacyVar()

clearFunctionDefinitionPrivacyVar(): void

Returns

void

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:389


clearReferenceAndNumberformatCache()

clearReferenceAndNumberformatCache(): void

Returns

void

Implementation of

IFormulaRuntimeService.clearReferenceAndNumberformatCache

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:373


disableCycleDependency()

disableCycleDependency(): void

Returns

void

Implementation of

IFormulaRuntimeService.disableCycleDependency

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:269


dispose()

dispose(): void

Returns

void

Implementation of

IFormulaRuntimeService.dispose

Overrides

Disposable.dispose

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:258


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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


enableCycleDependency()

enableCycleDependency(): void

Returns

void

Implementation of

IFormulaRuntimeService.enableCycleDependency

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:265


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

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


getAllRuntimeData()

getAllRuntimeData(): IAllRuntimeData

Returns

IAllRuntimeData

Implementation of

IFormulaRuntimeService.getAllRuntimeData

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:639


getCompletedArrayFormulasCount()

getCompletedArrayFormulasCount(): number

Returns

number

Implementation of

IFormulaRuntimeService.getCompletedArrayFormulasCount

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:297


getCompletedFormulasCount()

getCompletedFormulasCount(): number

Returns

number

Implementation of

IFormulaRuntimeService.getCompletedFormulasCount

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:313


getFormulaCycleIndex()

getFormulaCycleIndex(): number

Returns

number

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:281


getFormulaExecuteStage()

getFormulaExecuteStage(): FormulaExecuteStageType

Returns

FormulaExecuteStageType

Implementation of

IFormulaRuntimeService.getFormulaExecuteStage

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:347


getFunctionDefinitionPrivacyVar()

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

Parameters

ParameterType
lambdaIdstring

Returns

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

Implementation of

IFormulaRuntimeService.getFunctionDefinitionPrivacyVar

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:397


getRuntimeArrayFormulaCellData()

getRuntimeArrayFormulaCellData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Implementation of

IFormulaRuntimeService.getRuntimeArrayFormulaCellData

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:615


getRuntimeClearArrayFormulaCellData()

getRuntimeClearArrayFormulaCellData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:619


getRuntimeFeatureCellData()

getRuntimeFeatureCellData(): {}

Returns

{}

Implementation of

IFormulaRuntimeService.getRuntimeFeatureCellData

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:631


getRuntimeFeatureRange()

getRuntimeFeatureRange(): {}

Returns

{}

Implementation of

IFormulaRuntimeService.getRuntimeFeatureRange

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:623


getRuntimeOtherData()

getRuntimeOtherData(): IRuntimeOtherUnitDataType

Returns

IRuntimeOtherUnitDataType

Implementation of

IFormulaRuntimeService.getRuntimeOtherData

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:611


getRuntimeState()

getRuntimeState(): IExecutionInProgressParams

Returns

IExecutionInProgressParams

Implementation of

IFormulaRuntimeService.getRuntimeState

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:653


getTotalArrayFormulasToCalculate()

getTotalArrayFormulasToCalculate(): number

Returns

number

Implementation of

IFormulaRuntimeService.getTotalArrayFormulasToCalculate

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:289


getTotalFormulasToCalculate()

getTotalFormulasToCalculate(): number

Returns

number

Implementation of

IFormulaRuntimeService.getTotalFormulasToCalculate

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:305


getUnitArrayFormula()

getUnitArrayFormula(): IArrayFormulaRangeType

Returns

IArrayFormulaRangeType

Implementation of

IFormulaRuntimeService.getUnitArrayFormula

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:607


getUnitData()

getUnitData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Implementation of

IFormulaRuntimeService.getUnitData

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:603


isCycleDependency()

isCycleDependency(): boolean

Returns

boolean

Implementation of

IFormulaRuntimeService.isCycleDependency

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:273


isStopExecution()

isStopExecution(): boolean

Returns

boolean

Implementation of

IFormulaRuntimeService.isStopExecution

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:339


markedAsInitialFunctionsExecuted()

markedAsInitialFunctionsExecuted(): void

Returns

void

Implementation of

IFormulaRuntimeService.markedAsInitialFunctionsExecuted

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:329


markedAsNoFunctionsExecuted()

markedAsNoFunctionsExecuted(): void

Returns

void

Implementation of

IFormulaRuntimeService.markedAsNoFunctionsExecuted

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:321


markedAsStopFunctionsExecuted()

markedAsStopFunctionsExecuted(): void

Returns

void

Implementation of

IFormulaRuntimeService.markedAsStopFunctionsExecuted

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:325


markedAsSuccessfullyExecuted()

markedAsSuccessfullyExecuted(): void

Returns

void

Implementation of

IFormulaRuntimeService.markedAsSuccessfullyExecuted

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:317


registerFunctionDefinitionPrivacyVar()

registerFunctionDefinitionPrivacyVar(lambdaId, lambdaVar): void

Parameters

ParameterType
lambdaIdstring
lambdaVarMap<string, Nullable<BaseAstNode>>

Returns

void

Implementation of

IFormulaRuntimeService.registerFunctionDefinitionPrivacyVar

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:393


reset()

reset(): void

Returns

void

Implementation of

IFormulaRuntimeService.reset

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:351


setCompletedArrayFormulasCount()

setCompletedArrayFormulasCount(value): void

Parameters

ParameterType
valuenumber

Returns

void

Implementation of

IFormulaRuntimeService.setCompletedArrayFormulasCount

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:293


setCompletedFormulasCount()

setCompletedFormulasCount(value): void

Parameters

ParameterType
valuenumber

Returns

void

Implementation of

IFormulaRuntimeService.setCompletedFormulasCount

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:309


setCurrent()

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

Parameters

ParameterType
rownumber
columnnumber
rowCountnumber
columnCountnumber
sheetIdstring
unitIdstring

Returns

void

Implementation of

IFormulaRuntimeService.setCurrent

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:380


setFormulaCycleIndex()

setFormulaCycleIndex(index): void

Parameters

ParameterType
indexnumber

Returns

void

Implementation of

IFormulaRuntimeService.setFormulaCycleIndex

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:277


setFormulaExecuteStage()

setFormulaExecuteStage(type): void

Parameters

ParameterType
typeFormulaExecuteStageType

Returns

void

Implementation of

IFormulaRuntimeService.setFormulaExecuteStage

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:343


setRuntimeData()

setRuntimeData(functionVariant): void

Parameters

ParameterType
functionVariantFunctionVariantType

Returns

void

Implementation of

IFormulaRuntimeService.setRuntimeData

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:453


setRuntimeFeatureCellData()

setRuntimeFeatureCellData(featureId, featureData): void

Parameters

ParameterType
featureIdstring
featureDataIRuntimeUnitDataType

Returns

void

Implementation of

IFormulaRuntimeService.setRuntimeFeatureCellData

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:635


setRuntimeFeatureRange()

setRuntimeFeatureRange(featureId, featureRange): void

Parameters

ParameterType
featureIdstring
featureRangeIFeatureDirtyRangeType

Returns

void

Implementation of

IFormulaRuntimeService.setRuntimeFeatureRange

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:627


setRuntimeOtherData()

setRuntimeOtherData(
   formulaId, 
   x, 
   y, 
   functionVariant): void

Parameters

ParameterType
formulaIdstring
xnumber
ynumber
functionVariantFunctionVariantType

Returns

void

Implementation of

IFormulaRuntimeService.setRuntimeOtherData

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:401


setTotalArrayFormulasToCalculate()

setTotalArrayFormulasToCalculate(value): void

Parameters

ParameterType
valuenumber

Returns

void

Implementation of

IFormulaRuntimeService.setTotalArrayFormulasToCalculate

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:285


setTotalFormulasToCalculate()

setTotalFormulasToCalculate(value): void

Parameters

ParameterType
valuenumber

Returns

void

Implementation of

IFormulaRuntimeService.setTotalFormulasToCalculate

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:301


stopExecution()

stopExecution(): void

Returns

void

Implementation of

IFormulaRuntimeService.stopExecution

Defined in

submodules/univer/packages/engine-formula/src/services/runtime.service.ts:333