@univerjs/sheets-conditional-formatting v0.5.0-beta.1 • Docs

Class: ConditionalFormattingFormulaService

Extends

Disposable

Constructors

new ConditionalFormattingFormulaService()

new ConditionalFormattingFormulaService(
   _commandService, 
   _injector, 
   _activeDirtyManagerService, 
   _conditionalFormattingViewModel, 
   _conditionalFormattingRuleModel): ConditionalFormattingFormulaService

Parameters

Parameter	Type
`_commandService`	`ICommandService`
`_injector`	`Injector`
`_activeDirtyManagerService`	`IActiveDirtyManagerService`
`_conditionalFormattingViewModel`	`ConditionalFormattingViewModel`
`_conditionalFormattingRuleModel`	`ConditionalFormattingRuleModel`

Returns

ConditionalFormattingFormulaService

Overrides

Disposable.constructor

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:68

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	core/src/shared/lifecycle.ts:93

Methods

createCFormulaId()

createCFormulaId(cfId, formulaText): string

Parameters

Parameter	Type
`cfId`	`string`
`formulaText`	`string`

Returns

string

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:307

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

core/src/shared/lifecycle.ts:106

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100

getCache()

getCache(
   unitId, 
   subUnitId, 
cfId): undefined | ObjectMatrix<unknown>

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`cfId`	`string`

Returns

undefined | ObjectMatrix<unknown>

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:230

getFormulaResult()

getFormulaResult(
   unitId, 
   subUnitId, 
   cfId, 
   formulaText, 
   row, 
   col): {
  result: undefined;
  status: FormulaResultStatus.NOT_REGISTER;
 } | {
  result: Nullable<
     | undefined
     | null
     | string
     | number
     | boolean
     | void>;
  status: FormulaResultStatus.SUCCESS;
}

Parameters

Parameter	Type	Default value
`unitId`	`string`	`undefined`
`subUnitId`	`string`	`undefined`
`cfId`	`string`	`undefined`
`formulaText`	`string`	`undefined`
`row`	`number`	`0`
`col`	`number`	`0`

Returns

{ result: undefined; status: FormulaResultStatus.NOT_REGISTER; } | { result: Nullable< | undefined | null | string | number | boolean | void>; status: FormulaResultStatus.SUCCESS; }

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:282

getSubUnitFormulaMap()

getSubUnitFormulaMap(unitId, subUnitId): undefined | RefAlias<IFormulaItem, "id" | "formulaId">

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

undefined | RefAlias<IFormulaItem, "id" | "formulaId">

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:235

registerFormulaWithRange()

registerFormulaWithRange(
   unitId, 
   subUnitId, 
   cfId, 
   formulaText, 
   ranges): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`cfId`	`string`
`formulaText`	`string`
`ranges`	`IRange`[]

Returns

void

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:239

Readme Conditionalformattingicon