@univerjs/engine-formula v0.4.2 • Docs

Interface: IFormulaRuntimeService

Properties

Property	Type	Defined in
`currentColumn`	`number`	packages/engine-formula/src/services/runtime.service.ts:94 (opens in a new tab)
`currentRow`	`number`	packages/engine-formula/src/services/runtime.service.ts:92 (opens in a new tab)
`currentSubUnitId`	`string`	packages/engine-formula/src/services/runtime.service.ts:96 (opens in a new tab)
`currentUnitId`	`string`	packages/engine-formula/src/services/runtime.service.ts:98 (opens in a new tab)

Methods

clearReferenceAndNumberformatCache()

clearReferenceAndNumberformatCache(): void

Returns

void

Defined in

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

disableCycleDependency()

disableCycleDependency(): void

Returns

void

Defined in

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

dispose()

dispose(): void

Returns

void

Defined in

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

enableCycleDependency()

enableCycleDependency(): void

Returns

void

Defined in

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

getAllRuntimeData()

getAllRuntimeData(): IAllRuntimeData

Returns

IAllRuntimeData

Defined in

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

getCompletedArrayFormulasCount()

getCompletedArrayFormulasCount(): number

Returns

number

Defined in

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

getCompletedFormulasCount()

getCompletedFormulasCount(): number

Returns

number

Defined in

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

getFormulaExecuteStage()

getFormulaExecuteStage(): FormulaExecuteStageType

Returns

FormulaExecuteStageType

Defined in

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

getFunctionDefinitionPrivacyVar()

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

Parameters

Parameter	Type
`lambdaId`	`string`

Returns

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

Defined in

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

getRuntimeArrayFormulaCellData()

getRuntimeArrayFormulaCellData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Defined in

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

getRuntimeFeatureCellData()

getRuntimeFeatureCellData(): {}

Returns

{}

Defined in

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

getRuntimeFeatureRange()

getRuntimeFeatureRange(): {}

Returns

{}

Defined in

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

getRuntimeOtherData()

getRuntimeOtherData(): IRuntimeOtherUnitDataType

Returns

IRuntimeOtherUnitDataType

Defined in

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

getRuntimeState()

getRuntimeState(): IExecutionInProgressParams

Returns

IExecutionInProgressParams

Defined in

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

getTotalArrayFormulasToCalculate()

getTotalArrayFormulasToCalculate(): number

Returns

number

Defined in

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

getTotalFormulasToCalculate()

getTotalFormulasToCalculate(): number

Returns

number

Defined in

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

getUnitArrayFormula()

getUnitArrayFormula(): IArrayFormulaRangeType

Returns

IArrayFormulaRangeType

Defined in

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

getUnitData()

getUnitData(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Defined in

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

isCycleDependency()

isCycleDependency(): boolean

Returns

boolean

Defined in

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

isStopExecution()

isStopExecution(): boolean

Returns

boolean

Defined in

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

markedAsInitialFunctionsExecuted()

markedAsInitialFunctionsExecuted(): void

Returns

void

Defined in

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

markedAsNoFunctionsExecuted()

markedAsNoFunctionsExecuted(): void

Returns

void

Defined in

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

markedAsStopFunctionsExecuted()

markedAsStopFunctionsExecuted(): void

Returns

void

Defined in

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

markedAsSuccessfullyExecuted()

markedAsSuccessfullyExecuted(): void

Returns

void

Defined in

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

registerFunctionDefinitionPrivacyVar()

registerFunctionDefinitionPrivacyVar(lambdaId, lambdaVar): void

Parameters

Parameter	Type
`lambdaId`	`string`
`lambdaVar`	`Map`<`string`, `Nullable`<`BaseAstNode`>>

Returns

void

Defined in

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

reset()

reset(): void

Returns

void

Defined in

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

setCompletedArrayFormulasCount()

setCompletedArrayFormulasCount(value): void

Parameters

Parameter	Type
`value`	`number`

Returns

void

Defined in

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

setCompletedFormulasCount()

setCompletedFormulasCount(value): void

Parameters

Parameter	Type
`value`	`number`

Returns

void

Defined in

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

setCurrent()

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

Parameters

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

Returns

void

Defined in

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

setFormulaCycleIndex()

setFormulaCycleIndex(index): void

Parameters

Parameter	Type
`index`	`number`

Returns

void

Defined in

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

setFormulaExecuteStage()

setFormulaExecuteStage(type): void

Parameters

Parameter	Type
`type`	`FormulaExecuteStageType`

Returns

void

Defined in

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

setRuntimeData()

setRuntimeData(functionVariant): void

Parameters

Parameter	Type
`functionVariant`	`FunctionVariantType`

Returns

void

Defined in

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

setRuntimeFeatureCellData()

setRuntimeFeatureCellData(featureId, featureData): void

Parameters

Parameter	Type
`featureId`	`string`
`featureData`	`IRuntimeUnitDataType`

Returns

void

Defined in

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

setRuntimeFeatureRange()

setRuntimeFeatureRange(featureId, featureRange): void

Parameters

Parameter	Type
`featureId`	`string`
`featureRange`	`IFeatureDirtyRangeType`

Returns

void

Defined in

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

setRuntimeOtherData()

setRuntimeOtherData(formulaId, functionVariant): void

Parameters

Parameter	Type
`formulaId`	`string`
`functionVariant`	`FunctionVariantType`

Returns

void

Defined in

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

setTotalArrayFormulasToCalculate()

setTotalArrayFormulasToCalculate(value): void

Parameters

Parameter	Type
`value`	`number`

Returns

void

Defined in

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

setTotalFormulasToCalculate()

setTotalFormulasToCalculate(value): void

Parameters

Parameter	Type
`value`	`number`

Returns

void

Defined in

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

stopExecution()

stopExecution(): void

Returns

void

Defined in

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

Iformuladirtydata Ifunctioninfo