Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

feat(conditional-formatting): add test and jsdoc (#4303)

Gpound.liu7abd39d5c7bd
diff --git a/packages/facade/src/apis/__tests__/create-test-bed.ts b/packages/facade/src/apis/__tests__/create-test-bed.ts
index 189d200806..4ec397ae9a 100644
--- a/packages/facade/src/apis/__tests__/create-test-bed.ts
+++ b/packages/facade/src/apis/__tests__/create-test-bed.ts
@@ -77,6 +77,10 @@ function getTestWorkbookDataDemo(): IWorkbookData {
f: '=SUM(A1)',
si: '3e4r5t',
},
+ 4: {
+ v: 123,
+ t: 2,
+ },
},
1: {
3: {
@@ -106,7 +110,7 @@ function getTestWorkbookDataDemo(): IWorkbookData {
resources: [
{
name: 'SHEET_CONDITIONAL_FORMATTING_PLUGIN',
- data: '{"sheet-0011":[{"cfId":"AEGZdW8C","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"4ICEXdJj","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"geCv018z","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false}]}',
+ data: '{"sheet1":[{"cfId":"AEGZdW8C","ranges":[{"startRow":2,"startColumn":1,"endRow":5,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"4ICEXdJj","ranges":[{"startRow":4,"startColumn":1,"endRow":7,"endColumn":7,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"geCv018z","ranges":[{"startRow":11,"startColumn":1,"endRow":12,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false}]}',
},
],
};
@@ -208,6 +212,7 @@ export function createFacadeTestBed(workbookData?: IWorkbookData, dependencies?:
this._injector.get(WorkbookPermissionService);
this._injector.get(WorksheetPermissionService);
this._injector.get(ConditionalFormattingService);
+ this._injector.get(ConditionalFormattingViewModel);
}
override onReady(): void {
diff --git a/packages/facade/src/apis/__tests__/facade.spec.ts b/packages/facade/src/apis/__tests__/facade.spec.ts
index d84b0f4fee..df8ef21a24 100644
--- a/packages/facade/src/apis/__tests__/facade.spec.ts
+++ b/packages/facade/src/apis/__tests__/facade.spec.ts
@@ -281,7 +281,7 @@ describe('Test FUniver', () => {
},
{
name: 'SHEET_CONDITIONAL_FORMATTING_PLUGIN',
- data: '{"sheet-0011":[{"cfId":"AEGZdW8C","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"4ICEXdJj","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"geCv018z","ranges":[{"startRow":2,"startColumn":1,"endRow":11,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false}]}',
+ data: '{"sheet1":[{"cfId":"AEGZdW8C","ranges":[{"startRow":2,"startColumn":1,"endRow":5,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"4ICEXdJj","ranges":[{"startRow":4,"startColumn":1,"endRow":7,"endColumn":7,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false},{"cfId":"geCv018z","ranges":[{"startRow":11,"startColumn":1,"endRow":12,"endColumn":5,"startAbsoluteRefType":0,"endAbsoluteRefType":0,"rangeType":0}],"rule":{"type":"highlightCell","subType":"text","operator":"containsText","style":{"cl":{"rgb":"#2f56ef"},"bg":{"rgb":"#e8ecfc"}},"value":""},"stopIfTrue":false}]}',
},
{
data: '{}',
diff --git a/packages/facade/src/apis/everything.ts b/packages/facade/src/apis/everything.ts
index deb387a1d0..b417edbe25 100644
--- a/packages/facade/src/apis/everything.ts
+++ b/packages/facade/src/apis/everything.ts
@@ -26,10 +26,12 @@ import '@univerjs/sheets-numfmt/facade';
import '@univerjs/sheets-hyper-link/facade';
import '@univerjs/sheets-hyper-link-ui/facade';
import '@univerjs/sheets-thread-comment/facade';
+import '@univerjs/sheets-conditional-formatting/facade';
export { FHooks, FUniver } from '@univerjs/core';
export { FFormula } from '@univerjs/engine-formula/facade';
+export { FConditionalFormattingBuilder } from '@univerjs/sheets-conditional-formatting/facade';
export { FDataValidation, FDataValidationBuilder } from '@univerjs/sheets-data-validation/facade';
export { FFilter } from '@univerjs/sheets-filter/facade';
export { FThreadComment } from '@univerjs/sheets-thread-comment/facade';
diff --git a/packages/facade/src/apis/sheets/__tests__/f-conditional-formatting.spec.ts b/packages/facade/src/apis/sheets/__tests__/f-conditional-formatting.spec.ts
new file mode 100644
index 0000000000..78c8f66a75
--- /dev/null
+++ b/packages/facade/src/apis/sheets/__tests__/f-conditional-formatting.spec.ts
@@ -0,0 +1,159 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { FUniver, Injector, Univer } from '@univerjs/core';
+import { ICommandService } from '@univerjs/core/services/command/command.service.js';
+import { RemoveOtherFormulaMutation } from '@univerjs/engine-formula';
+import { SetSelectionsOperation } from '@univerjs/sheets';
+import { AddConditionalRuleMutation, ConditionalFormattingViewModel, DeleteConditionalRuleMutation, MoveConditionalRuleMutation, SetConditionalRuleMutation } from '@univerjs/sheets-conditional-formatting';
+import { beforeEach, describe, expect, it } from 'vitest';
+import { createFacadeTestBed } from '../../__tests__/create-test-bed';
+
+describe('Test conditional formatting facade', () => {
+ let get: Injector['get'];
+ let commandService: ICommandService;
+ let univerAPI: FUniver;
+ let univer: Univer = null as any;
+
+ beforeEach(() => {
+ if (univer) {
+ univer.dispose();
+ }
+ const testBed = createFacadeTestBed();
+ get = testBed.get;
+ univerAPI = testBed.univerAPI;
+ univer = testBed.univer;
+
+ commandService = get(ICommandService);
+ [AddConditionalRuleMutation, DeleteConditionalRuleMutation, MoveConditionalRuleMutation, SetConditionalRuleMutation, SetSelectionsOperation, RemoveOtherFormulaMutation].forEach((m) => {
+ commandService.registerCommand(m);
+ });
+ });
+ it('Gets all the conditional formatting for the current sheet', () => {
+ const rules = univerAPI.getActiveWorkbook()?.getActiveSheet().getConditionalFormattingRules();
+ expect(rules?.length).toEqual(3);
+ });
+
+ it('Gets all the conditional formatting for the current range', () => {
+ const workbook = univerAPI.getActiveWorkbook();
+ const worksheet = workbook?.getActiveSheet();
+ workbook?.setActiveRange(worksheet?.getRange(5, 5, 3, 3)!);
+ const rules = univerAPI.getActiveWorkbook()?.getActiveRange()?.getConditionalFormattingRules();
+ expect(rules?.length).toEqual(2);
+ });
+
+ it('Creates a constructor for conditional formatting', () => {
+ const workbook = univerAPI.getActiveWorkbook();
+ const worksheet = workbook?.getActiveSheet();
+ const rule = worksheet?.createConditionalFormattingRule()
+ .whenCellNotEmpty()
+ .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
+ .setItalic(true)
+ .setItalic(true)
+ .setBackground('red')
+ .setFontColor('green')
+ .build();
+ expect({ ...rule, cfId: 123 }).toEqual({
+ rule: {
+ type: 'highlightCell',
+ subType: 'text',
+ operator: 'notEqual',
+ value: '',
+ style: {
+ it: 1,
+ bg: {
+ rgb: 'rgb(255,0,0)',
+ },
+ cl: {
+ rgb: 'rgb(0,128,0)',
+ },
+ },
+ },
+ ranges: [
+ {
+ startRow: 0,
+ endRow: 100,
+ startColumn: 0,
+ endColumn: 100,
+ },
+ ],
+ cfId: 123,
+ stopIfTrue: false,
+ });
+ });
+
+ it('Creates rule and add', () => {
+ const workbook = univerAPI.getActiveWorkbook();
+ const worksheet = workbook?.getActiveSheet();
+ const rule = worksheet?.createConditionalFormattingRule()
+ .whenCellNotEmpty()
+ .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
+ .setItalic(true)
+ .setItalic(true)
+ .setBackground('red')
+ .setFontColor('green')
+ .build();
+ worksheet?.addConditionalFormattingRule(rule!);
+
+ const conditionalFormattingViewModel = get(ConditionalFormattingViewModel);
+ const cell4 = conditionalFormattingViewModel.getCellCfs(workbook!.getId(), worksheet!.getSheetId(), 0, 4);
+ const cell5 = conditionalFormattingViewModel.getCellCfs(workbook!.getId(), worksheet!.getSheetId(), 0, 5);
+ expect(cell4?.map((e) => e.result)).toEqual([
+ {
+ it: 1,
+ bg: {
+ rgb: 'rgb(255,0,0)',
+ },
+ cl: {
+ rgb: 'rgb(0,128,0)',
+ },
+ },
+
+ ]);
+ expect(cell5?.map((e) => e.result)).toEqual([{}]);
+ });
+
+ it('Delete conditional format according to cfId', async () => {
+ const workbook = univerAPI.getActiveWorkbook();
+ const worksheet = workbook?.getActiveSheet();
+ const rules = worksheet?.getConditionalFormattingRules();
+ expect(rules?.length).toEqual(3);
+ await worksheet?.deleteConditionalFormattingRule(rules![0].cfId);
+ expect(worksheet?.getConditionalFormattingRules()?.length).toEqual(2);
+ });
+
+ it('Modify the priority of the conditional format', () => {
+ const workbook = univerAPI.getActiveWorkbook();
+ const worksheet = workbook?.getActiveSheet();
+ const rules = worksheet?.getConditionalFormattingRules()!;
+ const rule = rules[2];
+ const targetRule = rules[0];
+ worksheet?.moveConditionalFormattingRule(rule.cfId, targetRule.cfId, 'before');
+ const index = worksheet?.getConditionalFormattingRules()!.findIndex((r) => r.cfId === rule.cfId);
+ expect(index).toEqual(0);
+ });
+
+ it('Set the conditional format according to cfId', () => {
+ const workbook = univerAPI.getActiveWorkbook();
+ const worksheet = workbook?.getActiveSheet();
+ const rules = worksheet?.getConditionalFormattingRules()!;
+ const rule = rules[0];
+ worksheet?.setConditionalFormattingRule(rule.cfId, { ...rule, ranges: [] });
+ const afterEditRule = worksheet?.getConditionalFormattingRules()[0];
+ expect(afterEditRule?.cfId).toEqual(rule.cfId);
+ expect(afterEditRule?.ranges).toEqual([]);
+ });
+});
diff --git a/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts b/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
index 723c4c101e..6d71be99b2 100644
--- a/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
+++ b/packages/sheets-conditional-formatting/src/facade/conditional-formatting-builder.ts
@@ -635,7 +635,7 @@ class ConditionalFormatIconSetRuleBuilder extends ConditionalFormatRuleBaseBuild
}
}
-export class ConditionalFormattingBuilder {
+export class FConditionalFormattingBuilder {
constructor(private _initConfig: { ranges?: IRange[] } = {}) {
}
diff --git a/packages/sheets-conditional-formatting/src/facade/f-range.ts b/packages/sheets-conditional-formatting/src/facade/f-range.ts
index 0d3569d132..221ff3b47c 100644
--- a/packages/sheets-conditional-formatting/src/facade/f-range.ts
+++ b/packages/sheets-conditional-formatting/src/facade/f-range.ts
@@ -32,7 +32,7 @@ import {
} from '@univerjs/sheets-conditional-formatting';
import { FRange } from '@univerjs/sheets/facade';
-import { ConditionalFormattingBuilder } from './conditional-formatting-builder';
+import { FConditionalFormattingBuilder } from './conditional-formatting-builder';
export interface IFRangeConditionalFormattingMixin {
@@ -40,15 +40,36 @@ export interface IFRangeConditionalFormattingMixin {
* Gets all the conditional formatting for the current range
* @return {*} {IConditionFormattingRule[]}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * workbook?.setActiveRange(worksheet?.getRange(5, 5, 3, 3)!);
+ * const rules = univerAPI.getActiveWorkbook()?.getActiveRange()?.getConditionalFormattingRules();
+ * ```
*/
getConditionalFormattingRules(): IConditionFormattingRule[];
/**
* Creates a constructor for conditional formatting
* @return {*} {ConditionalFormatRuleBuilder}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rule = worksheet?.createConditionalFormattingRule()
+ * .whenCellNotEmpty()
+ * .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
+ * .setItalic(true)
+ * .setItalic(true)
+ * .setBackground('red')
+ * .setFontColor('green')
+ * .build();
+ * worksheet?.addConditionalFormattingRule(rule!);
+ * ```
*/
- createConditionalFormattingRule(): ConditionalFormattingBuilder;
+ createConditionalFormattingRule(): FConditionalFormattingBuilder;
/**
* Add a new conditional format
@@ -64,6 +85,13 @@ export interface IFRangeConditionalFormattingMixin {
* @param {string} cfId
* @return {*} {Promise<boolean>}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rules = worksheet?.getConditionalFormattingRules();
+ * worksheet?.deleteConditionalFormattingRule(rules![0].cfId);
+ * ```
*/
deleteConditionalFormattingRule(cfId: string): Promise<boolean>;
@@ -73,6 +101,15 @@ export interface IFRangeConditionalFormattingMixin {
* @param {string} toCfId Target rule
* @param {IAnchor['type']} [type] After the default move to the destination rule, if type = before moves to the front, the default value is after
* @memberof FWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rules = worksheet?.getConditionalFormattingRules()!;
+ * const rule = rules[2];
+ * const targetRule = rules[0];
+ * worksheet?.moveConditionalFormattingRule(rule.cfId, targetRule.cfId, 'before');
+ * ```
*/
moveConditionalFormattingRule(cfId: string, toCfId: string, type?: IAnchor['type']): Promise<boolean>;
@@ -82,6 +119,14 @@ export interface IFRangeConditionalFormattingMixin {
* @param {IConditionFormattingRule} rule
* @return {*} {Promise<boolean>}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rules = worksheet?.getConditionalFormattingRules()!;
+ * const rule = rules[0];
+ * worksheet?.setConditionalFormattingRule(rule.cfId, { ...rule, ranges: [] });
+ * ```
*/
setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): Promise<boolean>;
}
@@ -96,8 +141,8 @@ export class FRangeConditionalFormattingMixin extends FRange implements IFRangeC
return [...rules].filter((rule) => rule.ranges.some((range) => Rectangle.intersects(range, this._range)));
}
- override createConditionalFormattingRule(): ConditionalFormattingBuilder {
- return new ConditionalFormattingBuilder({ ranges: [this._range] });
+ override createConditionalFormattingRule(): FConditionalFormattingBuilder {
+ return new FConditionalFormattingBuilder({ ranges: [this._range] });
}
override addConditionalFormattingRule(rule: IConditionFormattingRule): Promise<boolean> {
diff --git a/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts b/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
index fd325fcc34..d0f3c766be 100644
--- a/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
+++ b/packages/sheets-conditional-formatting/src/facade/f-worksheet.ts
@@ -30,7 +30,7 @@ import {
SetConditionalRuleMutation,
} from '@univerjs/sheets-conditional-formatting';
import { FWorksheet } from '@univerjs/sheets/facade';
-import { ConditionalFormattingBuilder } from './conditional-formatting-builder';
+import { FConditionalFormattingBuilder } from './conditional-formatting-builder';
export interface IFWorksheetConditionalFormattingMixin {
@@ -38,21 +38,51 @@ export interface IFWorksheetConditionalFormattingMixin {
* Gets all the conditional formatting for the current sheet
* @return {*} {IConditionFormattingRule[]}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * univerAPI.getActiveWorkbook()?.getActiveSheet().getConditionalFormattingRules();
+ * ```
*/
getConditionalFormattingRules(): IConditionFormattingRule[];
/**
* Creates a constructor for conditional formatting
* @return {*} {ConditionalFormatRuleBuilder}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rule = worksheet?.createConditionalFormattingRule()
+ * .whenCellNotEmpty()
+ * .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
+ * .setItalic(true)
+ * .setItalic(true)
+ * .setBackground('red')
+ * .setFontColor('green')
+ * .build();
+ * ```
*/
-
- createConditionalFormattingRule(): ConditionalFormattingBuilder;
+ createConditionalFormattingRule(): FConditionalFormattingBuilder;
/**
* Add a new conditional format
* @param {IConditionFormattingRule} rule
* @return {*} {Promise<boolean>}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rule = worksheet?.createConditionalFormattingRule()
+ * .whenCellNotEmpty()
+ * .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
+ * .setItalic(true)
+ * .setItalic(true)
+ * .setBackground('red')
+ * .setFontColor('green')
+ * .build();
+ * worksheet?.addConditionalFormattingRule(rule!);
+ * ```
*/
addConditionalFormattingRule(rule: IConditionFormattingRule): Promise<boolean>;
@@ -62,6 +92,13 @@ export interface IFWorksheetConditionalFormattingMixin {
* @param {string} cfId
* @return {*} {Promise<boolean>}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rules = worksheet?.getConditionalFormattingRules();
+ * worksheet?.deleteConditionalFormattingRule(rules![0].cfId);
+ * ```
*/
deleteConditionalFormattingRule(cfId: string): Promise<boolean>;
@@ -71,6 +108,15 @@ export interface IFWorksheetConditionalFormattingMixin {
* @param {string} toCfId Target rule
* @param {IAnchor['type']} [type] After the default move to the destination rule, if type = before moves to the front, the default value is after
* @memberof FWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rules = worksheet?.getConditionalFormattingRules()!;
+ * const rule = rules[2];
+ * const targetRule = rules[0];
+ * worksheet?.moveConditionalFormattingRule(rule.cfId, targetRule.cfId, 'before');
+ * ```
*/
moveConditionalFormattingRule(cfId: string, toCfId: string, type?: IAnchor['type']): Promise<boolean>;
@@ -80,6 +126,14 @@ export interface IFWorksheetConditionalFormattingMixin {
* @param {IConditionFormattingRule} rule
* @return {*} {Promise<boolean>}
* @memberof IFWorksheetConditionalFormattingMixin
+ * @example
+ * ```ts
+ * const workbook = univerAPI.getActiveWorkbook();
+ * const worksheet = workbook?.getActiveSheet();
+ * const rules = worksheet?.getConditionalFormattingRules()!;
+ * const rule = rules[0];
+ * worksheet?.setConditionalFormattingRule(rule.cfId, { ...rule, ranges: [] });
+ * ```
*/
setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): Promise<boolean>;
}
@@ -94,8 +148,8 @@ export class FWorksheetConditionalFormattingMixin extends FWorksheet implements
return [...rules];
}
- override createConditionalFormattingRule(): ConditionalFormattingBuilder {
- return new ConditionalFormattingBuilder();
+ override createConditionalFormattingRule(): FConditionalFormattingBuilder {
+ return new FConditionalFormattingBuilder();
}
override addConditionalFormattingRule(rule: IConditionFormattingRule): Promise<boolean> {
diff --git a/packages/sheets-conditional-formatting/src/facade/index.ts b/packages/sheets-conditional-formatting/src/facade/index.ts
index 83a77ecc7a..f9c93418f4 100644
--- a/packages/sheets-conditional-formatting/src/facade/index.ts
+++ b/packages/sheets-conditional-formatting/src/facade/index.ts
@@ -18,7 +18,7 @@ import './f-range';
import './f-workbook';
import './f-worksheet';
-export { ConditionalFormattingBuilder } from './conditional-formatting-builder';
+export { FConditionalFormattingBuilder } from './conditional-formatting-builder';
export type { IFRangeConditionalFormattingMixin } from './f-range';
export type { FWorkbookConditionalFormattingMixin } from './f-workbook';