API Reference
@univerjs
@univerjs/engine-formula
classes
Formulacurrentconfigservice

@univerjs/engine-formula v0.4.2Docs


Class: FormulaCurrentConfigService

Extends

Implements

Constructors

new FormulaCurrentConfigService()

new FormulaCurrentConfigService(_univerInstanceService, _localeService): FormulaCurrentConfigService

Parameters

ParameterType
_univerInstanceServiceIUniverInstanceService
_localeServiceLocaleService

Returns

FormulaCurrentConfigService

Overrides

Disposable.constructor

Defined in

packages/engine-formula/src/services/current-data.service.ts:142 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)

Methods

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

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


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

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(): IRuntimeUnitDataType

Returns

IRuntimeUnitDataType

Implementation of

IFormulaCurrentConfigService.getArrayFormulaCellData

Defined in

packages/engine-formula/src/services/current-data.service.ts:197 (opens in a new tab)


getArrayFormulaRange()

getArrayFormulaRange(): IArrayFormulaRangeType

Returns

IArrayFormulaRangeType

Implementation of

IFormulaCurrentConfigService.getArrayFormulaRange

Defined in

packages/engine-formula/src/services/current-data.service.ts:201 (opens in a new tab)


getClearDependencyTreeCache()

getClearDependencyTreeCache(): IDirtyUnitSheetNameMap

Returns

IDirtyUnitSheetNameMap

Implementation of

IFormulaCurrentConfigService.getClearDependencyTreeCache

Defined in

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


getDirtyData()

getDirtyData(): IFormulaDirtyData

Returns

IFormulaDirtyData

Implementation of

IFormulaCurrentConfigService.getDirtyData

Defined in

packages/engine-formula/src/services/current-data.service.ts:299 (opens in a new tab)


getDirtyDefinedNameMap()

getDirtyDefinedNameMap(): IDirtyUnitSheetDefinedNameMap

Returns

IDirtyUnitSheetDefinedNameMap

Implementation of

IFormulaCurrentConfigService.getDirtyDefinedNameMap

Defined in

packages/engine-formula/src/services/current-data.service.ts:221 (opens in a new tab)


getDirtyNameMap()

getDirtyNameMap(): IDirtyUnitSheetNameMap

Returns

IDirtyUnitSheetNameMap

Implementation of

IFormulaCurrentConfigService.getDirtyNameMap

Defined in

packages/engine-formula/src/services/current-data.service.ts:217 (opens in a new tab)


getDirtyRanges()

getDirtyRanges(): IUnitRange[]

Returns

IUnitRange[]

Implementation of

IFormulaCurrentConfigService.getDirtyRanges

Defined in

packages/engine-formula/src/services/current-data.service.ts:213 (opens in a new tab)


getDirtyUnitFeatureMap()

getDirtyUnitFeatureMap(): IDirtyUnitFeatureMap

Returns

IDirtyUnitFeatureMap

Implementation of

IFormulaCurrentConfigService.getDirtyUnitFeatureMap

Defined in

packages/engine-formula/src/services/current-data.service.ts:225 (opens in a new tab)


getDirtyUnitOtherFormulaMap()

getDirtyUnitOtherFormulaMap(): IDirtyUnitOtherFormulaMap

Returns

IDirtyUnitOtherFormulaMap

Implementation of

IFormulaCurrentConfigService.getDirtyUnitOtherFormulaMap

Defined in

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


getExcludedRange()

getExcludedRange(): Nullable<IUnitExcludedCell>

Returns

Nullable<IUnitExcludedCell>

Implementation of

IFormulaCurrentConfigService.getExcludedRange

Defined in

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


getExecuteSubUnitId()

getExecuteSubUnitId(): Nullable<string>

Returns

Nullable<string>

Implementation of

IFormulaCurrentConfigService.getExecuteSubUnitId

Defined in

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


getExecuteUnitId()

getExecuteUnitId(): Nullable<string>

Returns

Nullable<string>

Implementation of

IFormulaCurrentConfigService.getExecuteUnitId

Defined in

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


getFormulaData()

getFormulaData(): IFormulaData

Returns

IFormulaData

Implementation of

IFormulaCurrentConfigService.getFormulaData

Defined in

packages/engine-formula/src/services/current-data.service.ts:193 (opens in a new tab)


getLocale()

getLocale(): LocaleType

Returns

LocaleType

Implementation of

IFormulaCurrentConfigService.getLocale

Defined in

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


getSheetName()

getSheetName(unitId, sheetId): string

Parameters

ParameterType
unitIdstring
sheetIdstring

Returns

string

Implementation of

IFormulaCurrentConfigService.getSheetName

Defined in

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


getSheetNameMap()

getSheetNameMap(): IUnitSheetNameMap

Returns

IUnitSheetNameMap

Implementation of

IFormulaCurrentConfigService.getSheetNameMap

Defined in

packages/engine-formula/src/services/current-data.service.ts:205 (opens in a new tab)


getSheetsInfo()

getSheetsInfo(): {
  sheetNameMap: {};
  sheetOrder: string[];
}

Returns

{
  sheetNameMap: {};
  sheetOrder: string[];
}
NameTypeDefined in
sheetNameMap{}packages/engine-formula/src/services/current-data.service.ts:255 (opens in a new tab)
sheetOrderstring[]packages/engine-formula/src/services/current-data.service.ts:254 (opens in a new tab)

Implementation of

IFormulaCurrentConfigService.getSheetsInfo

Defined in

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


getUnitData()

getUnitData(): IUnitData

Returns

IUnitData

Implementation of

IFormulaCurrentConfigService.getUnitData

Defined in

packages/engine-formula/src/services/current-data.service.ts:185 (opens in a new tab)


getUnitStylesData()

getUnitStylesData(): IUnitStylesData

Get the unit styles data.

Returns

IUnitStylesData

Implementation of

IFormulaCurrentConfigService.getUnitStylesData

Defined in

packages/engine-formula/src/services/current-data.service.ts:189 (opens in a new tab)


isForceCalculate()

isForceCalculate(): boolean

Returns

boolean

Implementation of

IFormulaCurrentConfigService.isForceCalculate

Defined in

packages/engine-formula/src/services/current-data.service.ts:209 (opens in a new tab)


load()

load(config): void

Parameters

ParameterType
configIFormulaDatasetConfig

Returns

void

Implementation of

IFormulaCurrentConfigService.load

Defined in

packages/engine-formula/src/services/current-data.service.ts:259 (opens in a new tab)


loadDirtyRangesAndExcludedCell()

loadDirtyRangesAndExcludedCell(dirtyRanges, excludedCell?): void

Parameters

ParameterType
dirtyRangesIUnitRange[]
excludedCell?IUnitExcludedCell

Returns

void

Implementation of

IFormulaCurrentConfigService.loadDirtyRangesAndExcludedCell

Defined in

packages/engine-formula/src/services/current-data.service.ts:311 (opens in a new tab)


registerFormulaData()

registerFormulaData(formulaData): void

Parameters

ParameterType
formulaDataIFormulaData

Returns

void

Implementation of

IFormulaCurrentConfigService.registerFormulaData

Defined in

packages/engine-formula/src/services/current-data.service.ts:326 (opens in a new tab)


registerSheetNameMap()

registerSheetNameMap(sheetNameMap): void

Parameters

ParameterType
sheetNameMapIUnitSheetNameMap

Returns

void

Implementation of

IFormulaCurrentConfigService.registerSheetNameMap

Defined in

packages/engine-formula/src/services/current-data.service.ts:330 (opens in a new tab)


registerUnitData()

registerUnitData(unitData): void

Parameters

ParameterType
unitDataIUnitData

Returns

void

Implementation of

IFormulaCurrentConfigService.registerUnitData

Defined in

packages/engine-formula/src/services/current-data.service.ts:322 (opens in a new tab)


setExecuteSubUnitId()

setExecuteSubUnitId(subUnitId): void

Parameters

ParameterType
subUnitIdstring

Returns

void

Implementation of

IFormulaCurrentConfigService.setExecuteSubUnitId

Defined in

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


setExecuteUnitId()

setExecuteUnitId(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IFormulaCurrentConfigService.setExecuteUnitId

Defined in

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


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.