@univerjs/sheets-conditional-formatting 0.5.1 → 0.5.2

package/lib/types/facade/conditional-formatting-builder.d.ts

@@ -0,0 +1,487 @@
+import { IRange } from '@univerjs/core';
+import { CFTimePeriodOperator, IAverageHighlightCell, IColorScale, IConditionalFormattingRuleConfig, IConditionFormattingRule, IIconSet, IValueConfig, CFRuleType } from '@univerjs/sheets-conditional-formatting';
+declare class ConditionalFormatRuleBaseBuilder {
+    protected _rule: Partial<IConditionFormattingRule>;
+    protected get _ruleConfig(): IConditionalFormattingRuleConfig | null;
+    protected _getDefaultConfig(type?: CFRuleType): IConditionalFormattingRuleConfig;
+    constructor(initRule?: Partial<IConditionFormattingRule>);
+    protected _ensureAttr(obj: Record<string, any>, keys: string[]): Record<string, any>;
+    build(): IConditionFormattingRule<IConditionalFormattingRuleConfig>;
+    /**
+     * deep clone a current builder.
+     *
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    copy(): ConditionalFormatRuleBaseBuilder;
+    /**
+     * Gets the scope of the current conditional format
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    getRanges(): IRange[];
+    /**
+     * Get the icon set mapping dictionary
+     */
+    getIconMap(): Record<string, string[]>;
+    /**
+     * create a conditional format ID.
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    createCfId(): string;
+    /**
+     * Sets the scope for conditional formatting
+     * @param {IRange[]} ranges
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setRanges(ranges: IRange[]): this;
+}
+declare class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBuilder {
+    constructor(initConfig?: Partial<IConditionFormattingRule>);
+    copy(): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Set average rule
+     *
+     * @param {IAverageHighlightCell['operator']} operator
+     * @memberof ConditionalFormatHighlightRuleBuilder
+     */
+    setAverage(operator: IAverageHighlightCell['operator']): this;
+    /**
+     * Set uniqueValues rule
+     *
+     * @memberof ConditionalFormatHighlightRuleBuilder
+     */
+    setUniqueValues(): this;
+    /**
+     * Set duplicateValues rule
+     *
+     * @memberof ConditionalFormatHighlightRuleBuilder
+     */
+    setDuplicateValues(): this;
+    /**
+     * Set rank rule
+     *
+     * @param {{ isBottom: boolean, isPercent: boolean, value: number }} config
+     * @memberof ConditionalFormatHighlightRuleBuilder
+     */
+    setRank(config: {
+        isBottom: boolean;
+        isPercent: boolean;
+        value: number;
+    }): this;
+    /**
+     * Sets the background color
+     * @param {string} [color]
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setBackground(color?: string): this;
+    /**
+     * Set Bold
+     * @param {boolean} isBold
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setBold(isBold: boolean): this;
+    /**
+     * Sets the font color
+     * @param {string} [color]
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setFontColor(color?: string): this;
+    /**
+     * Set the text to italic
+     * @param {boolean} isItalic
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setItalic(isItalic: boolean): this;
+    /**
+     * Set the strikethrough
+     * @param {boolean} isStrikethrough
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setStrikethrough(isStrikethrough: boolean): this;
+    /**
+     * Set the underscore
+     * @param {boolean} isUnderline
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setUnderline(isUnderline: boolean): this;
+    /**
+     * Sets the conditional formatting rule to fire when the cell is empty.
+     */
+    whenCellEmpty(): this;
+    /**
+     * Sets the conditional formatting rule to fire when the cell is not empty
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenCellNotEmpty(): this;
+    /**
+     * Highlight when the date is in a time period, custom time is not supported.
+     *
+     * @param {CFTimePeriodOperator} date
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenDate(date: CFTimePeriodOperator): this;
+    /**
+     * Sets a conditional formatting rule to fire when a given formula evaluates to true.
+     * @param {string} formulaString  formulaString start with' = '
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenFormulaSatisfied(formulaString: string): this;
+    /**
+     * Sets the conditional formatting rule to fire when a number is between two specified values or equal to one of them.
+     * @param {number} start
+     * @param {number} end
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberBetween(start: number, end: number): this;
+    /**
+     * Sets the conditional formatting rule to fire when the number equals the given value
+     *
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberEqualTo(value: number): this;
+    /**
+     * Sets the conditional formatting rule to fire when the number is greater than the given value
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberGreaterThan(value: number): this;
+    /**
+     * Sets a conditional formatting rule to fire when a number is greater than or equal to a given value.
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberGreaterThanOrEqualTo(value: number): this;
+    /**
+     * Sets a conditional formatting rule to fire when the number is less than the given value.
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberLessThan(value: number): this;
+    /**
+     * Sets the conditional formatting rule to fire when the value is less than or equal to the given value.
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberLessThanOrEqualTo(value: number): this;
+    /**
+     * Sets a conditional formatting rule to fire when a number is not between two specified values and is not equal to them.
+     * @param {number} start
+     * @param {number} end
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberNotBetween(start: number, end: number): this;
+    /**
+     * Sets the conditional formatting rule to fire when a number does not equal a given value.
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberNotEqualTo(value: number): this;
+    /**
+     * Sets the conditional formatting rule to fire when the input contains the given value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextContains(text: string): this;
+    /**
+     * Sets a conditional formatting rule to fire when the input does not contain the given value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextDoesNotContain(text: string): this;
+    /**
+     * Sets a conditional formatting rule to fire when input ends with a specified value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextEndsWith(text: string): this;
+    /**
+     * Sets the conditional formatting rule to fire when the input equals the given value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextEqualTo(text: string): this;
+    /**
+     * Sets the conditional formatting rule to fire when the input value begins with the given value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextStartsWith(text: string): this;
+}
+declare class ConditionalFormatDataBarRuleBuilder extends ConditionalFormatRuleBaseBuilder {
+    copy(): ConditionalFormatDataBarRuleBuilder;
+    /**
+     * Data bar settings
+     *
+     * @param {{
+     *         min: IValueConfig;
+     *         max: IValueConfig;
+     *         isGradient?: boolean;
+     *         positiveColor: string;
+     *         nativeColor: string;
+     *         isShowValue?: boolean;
+     *     }} config
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setDataBar(config: {
+        min: IValueConfig;
+        max: IValueConfig;
+        isGradient?: boolean;
+        positiveColor: string;
+        nativeColor: string;
+        isShowValue?: boolean;
+    }): this;
+}
+declare class ConditionalFormatColorScaleRuleBuilder extends ConditionalFormatRuleBaseBuilder {
+    copy(): ConditionalFormatColorScaleRuleBuilder;
+    /**
+     * Color scale set
+     * @param {{ index: number; color: string; value: IValueConfig }[]} config
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setColorScale(config: IColorScale['config']): this;
+}
+declare class ConditionalFormatIconSetRuleBuilder extends ConditionalFormatRuleBaseBuilder {
+    copy(): ConditionalFormatIconSetRuleBuilder;
+    /**
+     *
+     * Icon Set
+     * @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setIconSet(config: {
+        iconConfigs: IIconSet['config'];
+        isShowValue: boolean;
+    }): this;
+}
+export declare class FConditionalFormattingBuilder {
+    private _initConfig;
+    constructor(_initConfig?: {
+        ranges?: IRange[];
+    });
+    build(): IConditionFormattingRule<IConditionalFormattingRuleConfig>;
+    /**
+     * Set average rule
+     *
+     * @param {IAverageHighlightCell['operator']} operator
+     * @memberof ConditionalFormatHighlightRuleBuilder
+     */
+    setAverage(operator: IAverageHighlightCell['operator']): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Set uniqueValues rule
+     *
+     * @memberof ConditionalFormatHighlightRuleBuilder
+     */
+    setUniqueValues(): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Set duplicateValues rule
+     *
+     * @memberof ConditionalFormatHighlightRuleBuilder
+     */
+    setDuplicateValues(): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Set rank rule
+     *
+     * @param {{ isBottom: boolean, isPercent: boolean, value: number }} config
+     * @memberof ConditionalFormatHighlightRuleBuilder
+     */
+    setRank(config: {
+        isBottom: boolean;
+        isPercent: boolean;
+        value: number;
+    }): ConditionalFormatHighlightRuleBuilder;
+    /**
+     *
+     * Set iconSet rule
+     * @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setIconSet(config: {
+        iconConfigs: IIconSet['config'];
+        isShowValue: boolean;
+    }): ConditionalFormatIconSetRuleBuilder;
+    /**
+     * Set colorScale rule
+     * @param {{ index: number; color: string; value: IValueConfig }[]} config
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setColorScale(config: IColorScale['config']): ConditionalFormatColorScaleRuleBuilder;
+    /**
+     * Set dataBar rule
+     *
+     * @param {{
+     *         min: IValueConfig;
+     *         max: IValueConfig;
+     *         isGradient?: boolean;
+     *         positiveColor: string;
+     *         nativeColor: string;
+     *         isShowValue?: boolean;
+     *     }} config
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setDataBar(config: {
+        min: IValueConfig;
+        max: IValueConfig;
+        isGradient?: boolean;
+        positiveColor: string;
+        nativeColor: string;
+        isShowValue?: boolean;
+    }): ConditionalFormatDataBarRuleBuilder;
+    /**
+     * Sets the background color
+     * @param {string} [color]
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setBackground(color?: string): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Set Bold
+     * @param {boolean} isBold
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setBold(isBold: boolean): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the font color
+     * @param {string} [color]
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setFontColor(color?: string): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Set the text to italic
+     * @param {boolean} isItalic
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setItalic(isItalic: boolean): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Set the strikethrough
+     * @param {boolean} isStrikethrough
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setStrikethrough(isStrikethrough: boolean): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Set the underscore
+     * @param {boolean} isUnderline
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    setUnderline(isUnderline: boolean): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when the cell is empty.
+     */
+    whenCellEmpty(): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when the cell is not empty
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenCellNotEmpty(): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Highlight when the date is in a time period, custom time is not supported.
+     *
+     * @param {CFTimePeriodOperator} date
+     * @return {*}
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenDate(date: CFTimePeriodOperator): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets a conditional formatting rule to fire when a given formula evaluates to true.
+     * @param {string} formulaString  formulaString start with' = '
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenFormulaSatisfied(formulaString: string): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when a number is between two specified values or equal to one of them.
+     * @param {number} start
+     * @param {number} end
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberBetween(start: number, end: number): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when the number equals the given value
+     *
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberEqualTo(value: number): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when the number is greater than the given value
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberGreaterThan(value: number): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets a conditional formatting rule to fire when a number is greater than or equal to a given value.
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberGreaterThanOrEqualTo(value: number): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets a conditional formatting rule to fire when the number is less than the given value.
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberLessThan(value: number): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when the value is less than or equal to the given value.
+     * @param {number} value
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberLessThanOrEqualTo(value: number): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets a conditional formatting rule to fire when a number is not between two specified values and is not equal to them.
+     * @param {number} start
+     * @param {number} end
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberNotBetween(start: number, end: number): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when a number does not equal a given value.
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenNumberNotEqualTo(value: number): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when the input contains the given value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextContains(text: string): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets a conditional formatting rule to fire when the input does not contain the given value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextDoesNotContain(text: string): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets a conditional formatting rule to fire when input ends with a specified value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextEndsWith(text: string): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when the input equals the given value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextEqualTo(text: string): ConditionalFormatHighlightRuleBuilder;
+    /**
+     * Sets the conditional formatting rule to fire when the input value begins with the given value.
+     * @param {string} text
+     * @memberof ConditionalFormatRuleBuilder
+     */
+    whenTextStartsWith(text: string): ConditionalFormatHighlightRuleBuilder;
+}
+export {};

package/lib/types/facade/f-range.d.ts

@@ -0,0 +1,106 @@
+import { IAnchor, IConditionFormattingRule } from '@univerjs/sheets-conditional-formatting';
+import { FRange } from '@univerjs/sheets/facade';
+import { FConditionalFormattingBuilder } from './conditional-formatting-builder';
+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(): FConditionalFormattingBuilder;
+    /**
+     * Add a new conditional format
+     * @param {IConditionFormattingRule} rule
+     * @return {*}  {Promise<boolean>}
+     * @memberof IFWorksheetConditionalFormattingMixin
+     */
+    addConditionalFormattingRule(rule: IConditionFormattingRule): Promise<boolean>;
+    /**
+     * Delete conditional format according to `cfId`
+     *
+     * @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>;
+    /**
+     * Modify the priority of the conditional format
+     * @param {string} cfId Rules that need to be moved
+     * @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>;
+    /**
+     * Set the conditional format according to `cfId`
+     * @param {string} cfId
+     * @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>;
+}
+export declare class FRangeConditionalFormattingMixin extends FRange implements IFRangeConditionalFormattingMixin {
+    private _getConditionalFormattingRuleModel;
+    getConditionalFormattingRules(): IConditionFormattingRule[];
+    createConditionalFormattingRule(): FConditionalFormattingBuilder;
+    addConditionalFormattingRule(rule: IConditionFormattingRule): Promise<boolean>;
+    deleteConditionalFormattingRule(cfId: string): Promise<boolean>;
+    moveConditionalFormattingRule(cfId: string, toCfId: string, type?: IAnchor['type']): Promise<boolean>;
+    setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): Promise<boolean>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FRange extends IFRangeConditionalFormattingMixin {
+    }
+}

package/lib/types/facade/f-workbook.d.ts

@@ -0,0 +1,12 @@
+import { ColorBuilder } from '@univerjs/core';
+import { FWorkbook } from '@univerjs/sheets/facade';
+export interface IFWorkbookConditionalFormattingMixin {
+    newColor(): ColorBuilder;
+}
+export declare class FWorkbookConditionalFormattingMixin extends FWorkbook implements IFWorkbookConditionalFormattingMixin {
+    newColor(): ColorBuilder;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorkbook extends IFWorkbookConditionalFormattingMixin {
+    }
+}