@univerjs/sheets-conditional-formatting v0.4.2 • 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`

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	core/src/shared/lifecycle.ts:93 (opens in a new tab)
`formulaChange$`	`public`	`Observable`<{ `cfId`: `string`; `formulaId`: `string`; `formulaText`: `string`; `subUnitId`: `string`; `unitId`: `string`; }>	`undefined`	-	sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:64 (opens in a new tab)

Methods

_createFormulaId()

_createFormulaId(unitId, subUnitId): string

Parameters

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

Returns

string

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:286 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:84 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

core/src/shared/lifecycle.ts:96 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

core/src/shared/lifecycle.ts:100 (opens in a new tab)

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:224 (opens in a new tab)

getFormulaResult()

getFormulaResult(
   unitId, 
   subUnitId, 
   formulaText): {
  result: item.result;
  status: FormulaResultStatus.NOT_REGISTER;
 } | {
  result: item.result;
  status: FormulaResultStatus.SUCCESS;
}

Parameters

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

Returns

{ result: item.result; status: FormulaResultStatus.NOT_REGISTER; } | { result: item.result; status: FormulaResultStatus.SUCCESS; }

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:266 (opens in a new tab)

getSubUnitFormulaMap()

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

Parameters

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

Returns

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

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:229 (opens in a new tab)

registerFormula()

registerFormula(
   unitId, 
   subUnitId, 
   cfId, 
   formulaText): void

Parameters

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

Returns

void

Defined in

sheets-conditional-formatting/src/services/conditional-formatting-formula.service.ts:233 (opens in a new tab)

Readme Conditionalformattingicon