@univerjs/sheets-conditional-formatting 0.6.2 → 0.6.3

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

@@ -1,517 +0,0 @@
-import { IRange } from '@univerjs/core';
-import { CFTimePeriodOperator, IAverageHighlightCell, IColorScale, IConditionalFormattingRuleConfig, IConditionFormattingRule, IIconSet, IValueConfig, CFRuleType } from '@univerjs/sheets-conditional-formatting';
-/**
- * @ignore
- * @hideconstructor
- */
-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;
-    /**
-     * Deep clone a current builder.
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    copy(): ConditionalFormatRuleBaseBuilder;
-    /**
-     * Gets the scope of the current conditional format
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    getRanges(): IRange[];
-    /**
-     * Get the icon set mapping dictionary
-     */
-    getIconMap(): Record<string, string[]>;
-    /**
-     * Create a conditional format ID.
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    createCfId(): string;
-    /**
-     * Sets the scope for conditional formatting
-     * @param {IRange[]} ranges
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setRanges(ranges: IRange[]): this;
-}
-/**
- * @hideconstructor
- */
-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
-     * @param config.isBottom
-     * @param config.isPercent
-     * @param config.value
-     * @memberof ConditionalFormatHighlightRuleBuilder
-     */
-    setRank(config: {
-        isBottom: boolean;
-        isPercent: boolean;
-        value: number;
-    }): this;
-    /**
-     * Sets the background color
-     * @param {string} [color]
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setBackground(color?: string): this;
-    /**
-     * Set Bold
-     * @param {boolean} isBold
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setBold(isBold: boolean): this;
-    /**
-     * Sets the font color
-     * @param {string} [color]
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setFontColor(color?: string): this;
-    /**
-     * Set the text to italic
-     * @param {boolean} isItalic
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setItalic(isItalic: boolean): this;
-    /**
-     * Set the strikethrough
-     * @param {boolean} isStrikethrough
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setStrikethrough(isStrikethrough: boolean): this;
-    /**
-     * Set the underscore
-     * @param {boolean} isUnderline
-     * @returns {*}
-     * @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
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    whenCellNotEmpty(): this;
-    /**
-     * Highlight when the date is in a time period, custom time is not supported.
-     * @param {CFTimePeriodOperator} date
-     * @returns {*}
-     * @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.
-     * @param 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
-     * @param config.min
-     * @param config.max
-     * @param config.isGradient
-     * @param config.positiveColor
-     * @param config.nativeColor
-     * @param config.isShowValue
-     * @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
-     * @param config.iconConfigs
-     * @param config.isShowValue
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setIconSet(config: {
-        iconConfigs: IIconSet['config'];
-        isShowValue: boolean;
-    }): this;
-}
-/**
- * @hideconstructor
- */
-export declare class FConditionalFormattingBuilder {
-    private _initConfig;
-    constructor(_initConfig?: {
-        ranges?: IRange[];
-    });
-    /**
-     * Constructs a conditional format rule from the settings applied to the builder.
-     * @returns {IConditionFormattingRule} The conditional format rule.
-     * @example
-     * ```typescript
-     * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
-     * const rule = fWorksheet.newConditionalFormattingRule().build();
-     * fWorksheet.setConditionalFormattingRules([rule]);
-     * ```
-     */
-    build(): IConditionFormattingRule;
-    /**
-     * 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
-     * @param config.isBottom
-     * @param config.isPercent
-     * @param config.value
-     * @memberof ConditionalFormatHighlightRuleBuilder
-     */
-    setRank(config: {
-        isBottom: boolean;
-        isPercent: boolean;
-        value: number;
-    }): ConditionalFormatHighlightRuleBuilder;
-    /**
-     *
-     * Set iconSet rule
-     * @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config
-     * @param config.iconConfigs
-     * @param config.isShowValue
-     * @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
-     * @param config.min
-     * @param config.max
-     * @param config.isGradient
-     * @param config.positiveColor
-     * @param config.nativeColor
-     * @param config.isShowValue
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setDataBar(config: {
-        min: IValueConfig;
-        max: IValueConfig;
-        isGradient?: boolean;
-        positiveColor: string;
-        nativeColor: string;
-        isShowValue?: boolean;
-    }): ConditionalFormatDataBarRuleBuilder;
-    /**
-     * Sets the background color
-     * @param {string} [color]
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setBackground(color?: string): ConditionalFormatHighlightRuleBuilder;
-    /**
-     * Set Bold
-     * @param {boolean} isBold
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setBold(isBold: boolean): ConditionalFormatHighlightRuleBuilder;
-    /**
-     * Sets the font color
-     * @param {string} [color]
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setFontColor(color?: string): ConditionalFormatHighlightRuleBuilder;
-    /**
-     * Set the text to italic
-     * @param {boolean} isItalic
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setItalic(isItalic: boolean): ConditionalFormatHighlightRuleBuilder;
-    /**
-     * Set the strikethrough
-     * @param {boolean} isStrikethrough
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    setStrikethrough(isStrikethrough: boolean): ConditionalFormatHighlightRuleBuilder;
-    /**
-     * Set the underscore
-     * @param {boolean} isUnderline
-     * @returns {*}
-     * @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
-     * @returns {*}
-     * @memberof ConditionalFormatRuleBuilder
-     */
-    whenCellNotEmpty(): ConditionalFormatHighlightRuleBuilder;
-    /**
-     * Highlight when the date is in a time period, custom time is not supported.
-     * @param {CFTimePeriodOperator} date
-     * @returns {*}
-     * @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.
-     * @param 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 {};