@cool-office/sheets-conditional-formatting 0.0.0-stage → 1.2.0

package/lib/cjs/facade.js

@@ -0,0 +1,2237 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let _cool_office_core = require("@cool-office/core");
+let _cool_office_sheets_conditional_formatting = require("@cool-office/sheets-conditional-formatting");
+let _cool_office_sheets_facade = require("@cool-office/sheets/facade");
+let _cool_office_core_facade = require("@cool-office/core/facade");
+
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/typeof.js
+function _typeof(o) {
+	"@babel/helpers - typeof";
+	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
+		return typeof o;
+	} : function(o) {
+		return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
+	}, _typeof(o);
+}
+
+//#endregion
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/toPrimitive.js
+function toPrimitive(t, r) {
+	if ("object" != _typeof(t) || !t) return t;
+	var e = t[Symbol.toPrimitive];
+	if (void 0 !== e) {
+		var i = e.call(t, r || "default");
+		if ("object" != _typeof(i)) return i;
+		throw new TypeError("@@toPrimitive must return a primitive value.");
+	}
+	return ("string" === r ? String : Number)(t);
+}
+
+//#endregion
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/toPropertyKey.js
+function toPropertyKey(t) {
+	var i = toPrimitive(t, "string");
+	return "symbol" == _typeof(i) ? i : i + "";
+}
+
+//#endregion
+//#region \0@oxc-project+runtime@0.153.0/helpers/esm/defineProperty.js
+function _defineProperty(e, r, t) {
+	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
+		value: t,
+		enumerable: !0,
+		configurable: !0,
+		writable: !0
+	}) : e[r] = t, e;
+}
+
+//#endregion
+//#region src/facade/f-conditional-formatting-builder.ts
+/**
+* @ignore
+* @hideconstructor
+*/
+var ConditionalFormatRuleBaseBuilder = class ConditionalFormatRuleBaseBuilder {
+	get _ruleConfig() {
+		return this._rule.rule || null;
+	}
+	_getDefaultConfig(type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell) {
+		switch (type) {
+			case _cool_office_sheets_conditional_formatting.CFRuleType.colorScale: return {
+				type,
+				config: [{
+					index: 0,
+					color: new _cool_office_core.ColorKit("").toRgbString(),
+					value: { type: _cool_office_sheets_conditional_formatting.CFValueType.min }
+				}, {
+					index: 0,
+					color: new _cool_office_core.ColorKit("green").toRgbString(),
+					value: { type: _cool_office_sheets_conditional_formatting.CFValueType.max }
+				}]
+			};
+			case _cool_office_sheets_conditional_formatting.CFRuleType.dataBar: return {
+				type,
+				isShowValue: true,
+				config: {
+					min: { type: _cool_office_sheets_conditional_formatting.CFValueType.min },
+					max: { type: _cool_office_sheets_conditional_formatting.CFValueType.max },
+					positiveColor: new _cool_office_core.ColorKit("green").toRgbString(),
+					nativeColor: new _cool_office_core.ColorKit("").toRgbString(),
+					isGradient: false
+				}
+			};
+			case _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell: return {
+				type,
+				subType: _cool_office_sheets_conditional_formatting.CFSubRuleType.text,
+				operator: _cool_office_sheets_conditional_formatting.CFTextOperator.containsText,
+				value: "abc",
+				style: {}
+			};
+			case _cool_office_sheets_conditional_formatting.CFRuleType.iconSet: return {
+				type,
+				isShowValue: true,
+				config: [
+					{
+						operator: _cool_office_sheets_conditional_formatting.CFNumberOperator.greaterThanOrEqual,
+						value: { type: _cool_office_sheets_conditional_formatting.CFValueType.min },
+						iconType: _cool_office_sheets_conditional_formatting.IIconSetType.empty,
+						iconId: ""
+					},
+					{
+						operator: _cool_office_sheets_conditional_formatting.CFNumberOperator.greaterThanOrEqual,
+						value: {
+							type: _cool_office_sheets_conditional_formatting.CFValueType.percentile,
+							value: .5
+						},
+						iconType: _cool_office_sheets_conditional_formatting.IIconSetType.empty,
+						iconId: ""
+					},
+					{
+						operator: _cool_office_sheets_conditional_formatting.CFNumberOperator.lessThanOrEqual,
+						value: { type: _cool_office_sheets_conditional_formatting.CFValueType.max },
+						iconType: _cool_office_sheets_conditional_formatting.IIconSetType.empty,
+						iconId: ""
+					}
+				]
+			};
+		}
+	}
+	constructor(initRule = {}) {
+		_defineProperty(this, "_rule", {});
+		this._rule = initRule;
+		this._ensureAttr(this._rule, ["rule"]);
+	}
+	_ensureAttr(obj, keys) {
+		keys.reduce((pre, cur) => {
+			if (!pre[cur]) pre[cur] = {};
+			return pre[cur];
+		}, obj);
+		return obj;
+	}
+	/**
+	* 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.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellEmpty()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	build() {
+		var _this$_rule$rule;
+		if (!this._rule.cfId) this._rule.cfId = (0, _cool_office_sheets_conditional_formatting.createCfId)();
+		if (!this._rule.ranges) this._rule.ranges = [];
+		if (this._rule.stopIfTrue === void 0) this._rule.stopIfTrue = false;
+		if (!((_this$_rule$rule = this._rule.rule) === null || _this$_rule$rule === void 0 ? void 0 : _this$_rule$rule.type)) {
+			this._rule.rule.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+			this._ensureAttr(this._rule, ["rule", "style"]);
+		}
+		const defaultConfig = this._getDefaultConfig(this._rule.rule.type);
+		return {
+			...this._rule,
+			rule: {
+				...defaultConfig,
+				...this._rule.rule
+			}
+		};
+	}
+	/**
+	* Deep clone a current builder.
+	* @returns {ConditionalFormatRuleBaseBuilder} A new builder with the same settings as the original.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const builder = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellEmpty()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(builder.build());
+	*
+	* // Copy the rule and change the background color to green for the range A1:B2.
+	* const newRange = fWorksheet.getRange('A1:B2');
+	* const newBuilder = builder.copy()
+	*   .setBackground('#00FF00')
+	*   .setRanges([newRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(newBuilder.build());
+	* ```
+	*/
+	copy() {
+		const newRule = _cool_office_core.Tools.deepClone(this._rule);
+		if (newRule.cfId) newRule.cfId = (0, _cool_office_sheets_conditional_formatting.createCfId)();
+		return new ConditionalFormatRuleBaseBuilder(newRule);
+	}
+	/**
+	* Gets the scope of the current conditional format.
+	* @returns {IRange[]} The ranges to which the conditional format applies.
+	*/
+	getRanges() {
+		return this._rule.ranges || [];
+	}
+	/**
+	* Get the icon set mapping dictionary.
+	* @returns {Record<string, string[]>} The icon set mapping dictionary.
+	*/
+	getIconMap() {
+		return _cool_office_sheets_conditional_formatting.iconMap;
+	}
+	/**
+	* Create a conditional format ID.
+	* @returns {string} The conditional format ID.
+	*/
+	createCfId() {
+		return (0, _cool_office_sheets_conditional_formatting.createCfId)();
+	}
+	/**
+	* Sets the scope for conditional formatting.
+	* @param {IRange[]} ranges - The ranges to which the conditional format applies.
+	* @returns {ConditionalFormatRuleBaseBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellEmpty()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setRanges(ranges) {
+		this._rule.ranges = ranges;
+		return this;
+	}
+};
+/**
+* @hideconstructor
+*/
+var ConditionalFormatHighlightRuleBuilder = class ConditionalFormatHighlightRuleBuilder extends ConditionalFormatRuleBaseBuilder {
+	constructor(initConfig = {}) {
+		super(initConfig);
+		this._ensureAttr(this._rule, ["rule", "style"]);
+	}
+	/**
+	* Deep clone a current builder.
+	* @returns {ConditionalFormatHighlightRuleBuilder} A new builder with the same settings as the original.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const builder = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellEmpty()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(builder.build());
+	*
+	* // Copy the rule and change the background color to green for the range A1:B2.
+	* const newRange = fWorksheet.getRange('A1:B2');
+	* const newBuilder = builder.copy()
+	*   .setBackground('#00FF00')
+	*   .setRanges([newRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(newBuilder.build());
+	* ```
+	*/
+	copy() {
+		const newRule = _cool_office_core.Tools.deepClone(this._rule);
+		if (newRule.cfId) newRule.cfId = (0, _cool_office_sheets_conditional_formatting.createCfId)();
+		return new ConditionalFormatHighlightRuleBuilder(newRule);
+	}
+	/**
+	* Set average rule.
+	* @param {IAverageHighlightCell['operator']} operator - The operator to use for the average rule.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with greater than average values in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setAverage(univerAPI.Enum.ConditionFormatNumberOperatorEnum.greaterThan)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setAverage(operator) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.average;
+		ruleConfig.operator = operator;
+		return this;
+	}
+	/**
+	* Set unique values rule.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with unique values in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setUniqueValues()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setUniqueValues() {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.uniqueValues;
+		return this;
+	}
+	/**
+	* Set duplicate values rule.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with duplicate values in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setDuplicateValues()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setDuplicateValues() {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.duplicateValues;
+		return this;
+	}
+	/**
+	* Set rank rule.
+	* @param {{ isBottom: boolean, isPercent: boolean, value: number }} config - The rank rule settings.
+	* @param {boolean} config.isBottom - Whether to highlight the bottom rank.
+	* @param {boolean} config.isPercent - Whether to use a percentage rank.
+	* @param {number} config.value - The rank value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights the bottom 10% of values in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setRank({ isBottom: true, isPercent: true, value: 10 })
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setRank(config) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.rank;
+		ruleConfig.isBottom = config.isBottom;
+		ruleConfig.isPercent = config.isPercent;
+		ruleConfig.value = config.value;
+		return this;
+	}
+	/**
+	* Sets the background color for the conditional format rule's format.
+	* @param {string} [color] - The background color to set. If not provided, the background color is removed.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellEmpty()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setBackground(color) {
+		var _this$_ruleConfig;
+		if (((_this$_ruleConfig = this._ruleConfig) === null || _this$_ruleConfig === void 0 ? void 0 : _this$_ruleConfig.type) === _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell) {
+			if (color) {
+				this._ensureAttr(this._ruleConfig, ["style", "bg"]);
+				const colorKit = new _cool_office_core.ColorKit(color);
+				this._ruleConfig.style.bg.rgb = colorKit.toRgbString();
+			} else delete this._ruleConfig.style.bg;
+		}
+		return this;
+	}
+	/**
+	* Sets text bolding for the conditional format rule's format.
+	* @param {boolean} isBold - Whether to bold the text.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that bolds the text for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setBold(true)
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setBold(isBold) {
+		var _this$_ruleConfig2;
+		if (((_this$_ruleConfig2 = this._ruleConfig) === null || _this$_ruleConfig2 === void 0 ? void 0 : _this$_ruleConfig2.type) === _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell) {
+			this._ensureAttr(this._ruleConfig, ["style"]);
+			this._ruleConfig.style.bl = isBold ? _cool_office_core.BooleanNumber.TRUE : _cool_office_core.BooleanNumber.FALSE;
+		}
+		return this;
+	}
+	/**
+	* Sets the font color for the conditional format rule's format.
+	* @param {string} [color] - The font color to set. If not provided, the font color is removed.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that changes the font color to red for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setFontColor('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setFontColor(color) {
+		var _this$_ruleConfig3;
+		if (((_this$_ruleConfig3 = this._ruleConfig) === null || _this$_ruleConfig3 === void 0 ? void 0 : _this$_ruleConfig3.type) === _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell) {
+			if (color) {
+				const colorKit = new _cool_office_core.ColorKit(color);
+				this._ensureAttr(this._ruleConfig, ["style", "cl"]);
+				this._ruleConfig.style.cl.rgb = colorKit.toRgbString();
+			} else delete this._ruleConfig.style.cl;
+		}
+		return this;
+	}
+	/**
+	* Sets text italics for the conditional format rule's format.
+	* @param {boolean} isItalic - Whether to italicize the text.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that italicizes the text for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setItalic(true)
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setItalic(isItalic) {
+		var _this$_ruleConfig4;
+		if (((_this$_ruleConfig4 = this._ruleConfig) === null || _this$_ruleConfig4 === void 0 ? void 0 : _this$_ruleConfig4.type) === _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell) {
+			this._ensureAttr(this._ruleConfig, ["style"]);
+			this._ruleConfig.style.it = isItalic ? _cool_office_core.BooleanNumber.TRUE : _cool_office_core.BooleanNumber.FALSE;
+		}
+		return this;
+	}
+	/**
+	* Sets text strikethrough for the conditional format rule's format.
+	* @param {boolean} isStrikethrough - Whether is strikethrough the text.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that set text strikethrough for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setStrikethrough(true)
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setStrikethrough(isStrikethrough) {
+		var _this$_ruleConfig5;
+		if (((_this$_ruleConfig5 = this._ruleConfig) === null || _this$_ruleConfig5 === void 0 ? void 0 : _this$_ruleConfig5.type) === _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell) {
+			this._ensureAttr(this._ruleConfig, ["style", "st"]);
+			this._ruleConfig.style.st.s = isStrikethrough ? _cool_office_core.BooleanNumber.TRUE : _cool_office_core.BooleanNumber.FALSE;
+		}
+		return this;
+	}
+	/**
+	* Sets text underlining for the conditional format rule's format.
+	* @param {boolean} isUnderline - Whether to underline the text.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that underlines the text for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setUnderline(true)
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setUnderline(isUnderline) {
+		var _this$_ruleConfig6;
+		if (((_this$_ruleConfig6 = this._ruleConfig) === null || _this$_ruleConfig6 === void 0 ? void 0 : _this$_ruleConfig6.type) === _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell) {
+			this._ensureAttr(this._ruleConfig, ["style", "ul"]);
+			this._ruleConfig.style.ul.s = isUnderline ? _cool_office_core.BooleanNumber.TRUE : _cool_office_core.BooleanNumber.FALSE;
+		}
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when the cell is empty.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellEmpty()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenCellEmpty() {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.text;
+		ruleConfig.value = "";
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFTextOperator.equal;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when the cell is not empty.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that changes the font color to red for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setFontColor('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenCellNotEmpty() {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.text;
+		ruleConfig.value = "";
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFTextOperator.notEqual;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when a time period is met.
+	* @param {CFTimePeriodOperator} date - The time period to check for.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with dates in the last 7 days in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenDate(univerAPI.Enum.ConditionFormatTimePeriodOperatorEnum.last7Days)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenDate(date) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.timePeriod;
+		ruleConfig.operator = date;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the given formula evaluates to `true`.
+	* @param {string} formulaString - A custom formula that evaluates to true if the input is valid. formulaString start with '='.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenFormulaSatisfied('=A1>10')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenFormulaSatisfied(formulaString) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.formula;
+		ruleConfig.value = formulaString;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number falls between, or is either of, two specified values.
+	* @param {number} start - The lowest acceptable value.
+	* @param {number} end - The highest acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values between 10 and 20 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberBetween(10, 20)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberBetween(start, end) {
+		const min = Math.min(start, end);
+		const max = Math.max(start, end);
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.number;
+		ruleConfig.value = [min, max];
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFNumberOperator.between;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number is equal to the given value.
+	* @param {number} value - The sole acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values equal to 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberEqualTo(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberEqualTo(value) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.number;
+		ruleConfig.value = value;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFNumberOperator.equal;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number is greater than the given value.
+	* @param {number} value - The highest unacceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberGreaterThan(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberGreaterThan(value) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.number;
+		ruleConfig.value = value;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFNumberOperator.greaterThan;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number is greater than or equal to the given value.
+	* @param {number} value - The lowest acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values greater than or equal to 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberGreaterThanOrEqualTo(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberGreaterThanOrEqualTo(value) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.number;
+		ruleConfig.value = value;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFNumberOperator.greaterThanOrEqual;
+		return this;
+	}
+	/**
+	* Sets the conditional conditional format rule to trigger when a number less than the given value.
+	* @param {number} value - The lowest unacceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values less than 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberLessThan(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberLessThan(value) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.number;
+		ruleConfig.value = value;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFNumberOperator.lessThan;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number less than or equal to the given value.
+	* @param {number} value - The highest acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values less than or equal to 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberLessThanOrEqualTo(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberLessThanOrEqualTo(value) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.number;
+		ruleConfig.value = value;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFNumberOperator.lessThanOrEqual;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number does not fall between, and is neither of, two specified values.
+	* @param {number} start - The lowest unacceptable value.
+	* @param {number} end - The highest unacceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values not between 10 and 20 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberNotBetween(10, 20)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberNotBetween(start, end) {
+		const min = Math.min(start, end);
+		const max = Math.max(start, end);
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.number;
+		ruleConfig.value = [min, max];
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFNumberOperator.notBetween;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number is not equal to the given value.
+	* @param {number} value - The sole unacceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values not equal to 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberNotEqualTo(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberNotEqualTo(value) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.number;
+		ruleConfig.value = value;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFNumberOperator.notEqual;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input contains the given value.
+	* @param {string} text - The value that the input must contain.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text containing 'apple' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextContains('apple')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextContains(text) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.text;
+		ruleConfig.value = text;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFTextOperator.containsText;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input does not contain the given value.
+	* @param {string} text - The value that the input must not contain.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text not containing 'apple' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextDoesNotContain('apple')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextDoesNotContain(text) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.text;
+		ruleConfig.value = text;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFTextOperator.notContainsText;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input ends with the given value.
+	* @param {string} text - Text to compare against the end of the string.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text ending with '.ai' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextEndsWith('.ai')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextEndsWith(text) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.text;
+		ruleConfig.value = text;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFTextOperator.endsWith;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input is equal to the given value.
+	* @param {string} text - The sole acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text equal to 'apple' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextEqualTo('apple')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextEqualTo(text) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.text;
+		ruleConfig.value = text;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFTextOperator.equal;
+		return this;
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input starts with the given value.
+	* @param {string} text - Text to compare against the beginning of the string.
+	* @returns {ConditionalFormatHighlightRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text starting with 'https://' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextStartsWith('https://')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextStartsWith(text) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.highlightCell;
+		ruleConfig.subType = _cool_office_sheets_conditional_formatting.CFSubRuleType.text;
+		ruleConfig.value = text;
+		ruleConfig.operator = _cool_office_sheets_conditional_formatting.CFTextOperator.beginsWith;
+		return this;
+	}
+};
+var ConditionalFormatDataBarRuleBuilder = class ConditionalFormatDataBarRuleBuilder extends ConditionalFormatRuleBaseBuilder {
+	/**
+	* Deep clone a current builder.
+	* @returns {ConditionalFormatDataBarRuleBuilder} A new instance of the builder with the same settings as the original.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that adds a data bar to cells with values between -100 and 100 in the range A1:D10.
+	* // positive values are green and negative values are red.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const builder = fWorksheet.newConditionalFormattingRule()
+	*   .setDataBar({
+	*     min: { type: 'num', value: -100 },
+	*     max: { type: 'num', value: 100 },
+	*     positiveColor: '#00FF00',
+	*     nativeColor: '#FF0000',
+	*     isShowValue: true
+	*   })
+	*   .setRanges([fRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(builder.build());
+	*
+	* // Copy the rule and apply it to a new range.
+	* const newRange = fWorksheet.getRange('F1:F10');
+	* const newBuilder = builder.copy()
+	*   .setRanges([newRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(newBuilder.build());
+	* ```
+	*/
+	copy() {
+		const newRule = _cool_office_core.Tools.deepClone(this._rule);
+		if (newRule.cfId) newRule.cfId = (0, _cool_office_sheets_conditional_formatting.createCfId)();
+		return new ConditionalFormatDataBarRuleBuilder(newRule);
+	}
+	/**
+	* Set data bar rule.
+	* @param {object} config - The data bar rule settings.
+	* @param {IValueConfig} config.min - The minimum value for the data bar.
+	* @param {IValueConfig} config.max - The maximum value for the data bar.
+	* @param {boolean} [config.isGradient] - Whether the data bar is gradient.
+	* @param {string} config.positiveColor - The color for positive values.
+	* @param {string} config.nativeColor - The color for negative values.
+	* @param {boolean} [config.isShowValue] - Whether to show the value in the cell.
+	* @returns {ConditionalFormatDataBarRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that adds a data bar to cells with values between -100 and 100 in the range A1:D10.
+	* // positive values are green and negative values are red.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setDataBar({
+	*     min: { type: 'num', value: -100 },
+	*     max: { type: 'num', value: 100 },
+	*     positiveColor: '#00FF00',
+	*     nativeColor: '#FF0000',
+	*     isShowValue: true
+	*   })
+	*  .setRanges([fRange.getRange()])
+	* .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setDataBar(config) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.dataBar;
+		ruleConfig.isShowValue = !!config.isShowValue;
+		ruleConfig.config = {
+			min: config.min,
+			max: config.max,
+			positiveColor: config.positiveColor,
+			nativeColor: config.nativeColor,
+			isGradient: !!config.isGradient
+		};
+		return this;
+	}
+};
+var ConditionalFormatColorScaleRuleBuilder = class ConditionalFormatColorScaleRuleBuilder extends ConditionalFormatRuleBaseBuilder {
+	/**
+	* Deep clone a current builder.
+	* @returns {ConditionalFormatColorScaleRuleBuilder} A new instance of the builder with the same settings as the original.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that adds a color scale to cells with values between 0 and 100 in the range A1:D10.
+	* // The color scale is green for 0, yellow for 50, and red for 100.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const builder = fWorksheet.newConditionalFormattingRule()
+	*   .setColorScale([
+	*     { index: 0, color: '#00FF00', value: { type: 'num', value: 0 } },
+	*     { index: 1, color: '#FFFF00', value: { type: 'num', value: 50 } },
+	*     { index: 2, color: '#FF0000', value: { type: 'num', value: 100 } }
+	*   ])
+	*   .setRanges([fRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(builder.build());
+	*
+	* // Copy the rule and apply it to a new range.
+	* const newRange = fWorksheet.getRange('F1:F10');
+	* const newBuilder = builder.copy()
+	*   .setRanges([newRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(newBuilder.build());
+	* ```
+	*/
+	copy() {
+		const newRule = _cool_office_core.Tools.deepClone(this._rule);
+		if (newRule.cfId) newRule.cfId = (0, _cool_office_sheets_conditional_formatting.createCfId)();
+		return new ConditionalFormatColorScaleRuleBuilder(newRule);
+	}
+	/**
+	* Set color scale rule.
+	* @param {{ index: number; color: string; value: IValueConfig }[]} config - The color scale rule settings.
+	* @param {number} config.index - The index of the color scale configuration.
+	* @param {string} config.color - The color corresponding to the index of the color scale configuration.
+	* @param {IValueConfig} config.value - The condition value corresponding to the index of the color scale configuration.
+	* @returns {ConditionalFormatColorScaleRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that adds a color scale to cells with values between 0 and 100 in the range A1:D10.
+	* // The color scale is green for 0, yellow for 50, and red for 100.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setColorScale([
+	*     { index: 0, color: '#00FF00', value: { type: 'num', value: 0 } },
+	*     { index: 1, color: '#FFFF00', value: { type: 'num', value: 50 } },
+	*     { index: 2, color: '#FF0000', value: { type: 'num', value: 100 } }
+	*   ])
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setColorScale(config) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.colorScale;
+		ruleConfig.config = config;
+		return this;
+	}
+};
+var ConditionalFormatIconSetRuleBuilder = class ConditionalFormatIconSetRuleBuilder extends ConditionalFormatRuleBaseBuilder {
+	/**
+	* Deep clone a current builder.
+	* @returns {ConditionalFormatIconSetRuleBuilder} A new instance of the builder with the same settings as the original.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a 3-arrow icon set conditional formatting rule in the range A1:D10.
+	* // The first arrow is green for values greater than 20.
+	* // The second arrow is yellow for values greater than 10.
+	* // The third arrow is red for values less than or equal to 10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const builder = fWorksheet.newConditionalFormattingRule()
+	*   .setIconSet({
+	*     iconConfigs: [
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '0',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.greaterThan,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 20
+	*         }
+	*       },
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '1',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.greaterThan,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 10
+	*         }
+	*       },
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '2',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.lessThanOrEqual,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 10
+	*         }
+	*       }
+	*     ],
+	*     isShowValue: true,
+	*   })
+	*   .setRanges([fRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(builder.build());
+	*
+	* // Copy the rule and apply it to a new range.
+	* const newRange = fWorksheet.getRange('F1:F10');
+	* const newBuilder = builder.copy()
+	*   .setRanges([newRange.getRange()]);
+	* fWorksheet.addConditionalFormattingRule(newBuilder.build());
+	* ```
+	*/
+	copy() {
+		const newRule = _cool_office_core.Tools.deepClone(this._rule);
+		if (newRule.cfId) newRule.cfId = (0, _cool_office_sheets_conditional_formatting.createCfId)();
+		return new ConditionalFormatIconSetRuleBuilder(newRule);
+	}
+	/**
+	* Set up icon set conditional formatting rule.
+	* @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config - The icon set conditional formatting rule settings.
+	* @param {IIconSet['config']} config.iconConfigs - The icon configurations. iconId property is a string indexing of a group icons.
+	* @param {boolean} config.isShowValue - Whether to show the value in the cell.
+	* @returns {ConditionalFormatIconSetRuleBuilder} This builder for chaining.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a 3-arrow icon set conditional formatting rule in the range A1:D10.
+	* // The first arrow is green for values greater than 20.
+	* // The second arrow is yellow for values greater than 10.
+	* // The third arrow is red for values less than or equal to 10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const builder = fWorksheet.newConditionalFormattingRule();
+	* console.log(builder.getIconMap()); // icons key-value map
+	* const rule = builder.setIconSet({
+	*     iconConfigs: [
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '0',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.greaterThan,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 20
+	*         }
+	*       },
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '1',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.greaterThan,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 10
+	*         }
+	*       },
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '2',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.lessThanOrEqual,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 10
+	*         }
+	*       }
+	*     ],
+	*     isShowValue: true,
+	*   })
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setIconSet(config) {
+		const ruleConfig = this._ruleConfig;
+		ruleConfig.type = _cool_office_sheets_conditional_formatting.CFRuleType.iconSet;
+		ruleConfig.config = config.iconConfigs;
+		ruleConfig.isShowValue = config.isShowValue;
+		return this;
+	}
+};
+/**
+* @hideconstructor
+*/
+var FConditionalFormattingBuilder = class {
+	constructor(_initConfig = {}) {
+		this._initConfig = _initConfig;
+	}
+	/**
+	* 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.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberGreaterThan(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	build() {
+		return new ConditionalFormatRuleBaseBuilder(this._initConfig).build();
+	}
+	/**
+	* Set average rule.
+	* @param {IAverageHighlightCell['operator']} operator - The operator to use for the average rule.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with greater than average values in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setAverage(univerAPI.Enum.ConditionFormatNumberOperatorEnum.greaterThan)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setAverage(operator) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setAverage(operator);
+	}
+	/**
+	* Set unique values rule.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with unique values in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setUniqueValues()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setUniqueValues() {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setUniqueValues();
+	}
+	/**
+	* Set duplicate values rule.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with duplicate values in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setDuplicateValues()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setDuplicateValues() {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setDuplicateValues();
+	}
+	/**
+	* Set rank rule.
+	* @param {{ isBottom: boolean, isPercent: boolean, value: number }} config - The rank rule settings.
+	* @param {boolean} config.isBottom - Whether to highlight the bottom rank.
+	* @param {boolean} config.isPercent - Whether to use a percentage rank.
+	* @param {number} config.value - The rank value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights the bottom 10% of values in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setRank({ isBottom: true, isPercent: true, value: 10 })
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setRank(config) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setRank(config);
+	}
+	/**
+	* Get the icon set mapping dictionary.
+	* @returns {Record<string, string[]>} The icon set mapping dictionary.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	* console.log(fWorksheet.newConditionalFormattingRule().getIconMap()); // icons key-value map
+	* ```
+	*/
+	getIconMap() {
+		return _cool_office_sheets_conditional_formatting.iconMap;
+	}
+	/**
+	* Set up icon set conditional formatting rule.
+	* @param {{ iconConfigs: IIconSet['config'], isShowValue: boolean }} config - The icon set conditional formatting rule settings.
+	* @param {IIconSet['config']} config.iconConfigs - The icon configurations. iconId property is a string indexing of a group icons.
+	* @param {boolean} config.isShowValue - Whether to show the value in the cell.
+	* @returns {ConditionalFormatIconSetRuleBuilder} The conditional format icon set rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a 3-arrow icon set conditional formatting rule in the range A1:D10.
+	* // The first arrow is green for values greater than 20.
+	* // The second arrow is yellow for values greater than 10.
+	* // The third arrow is red for values less than or equal to 10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const builder = fWorksheet.newConditionalFormattingRule();
+	* console.log(builder.getIconMap()); // icons key-value map
+	* const rule = builder.setIconSet({
+	*     iconConfigs: [
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '0',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.greaterThan,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 20
+	*         }
+	*       },
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '1',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.greaterThan,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 10
+	*         }
+	*       },
+	*       {
+	*         iconType: univerAPI.Enum.ConditionFormatIconSetTypeEnum.threeArrows,
+	*         iconId: '2',
+	*         operator: univerAPI.Enum.ConditionFormatNumberOperatorEnum.lessThanOrEqual,
+	*         value: {
+	*           type: univerAPI.Enum.ConditionFormatValueTypeEnum.num,
+	*           value: 10
+	*         }
+	*       }
+	*     ],
+	*     isShowValue: true,
+	*   })
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setIconSet(config) {
+		return new ConditionalFormatIconSetRuleBuilder(this._initConfig).setIconSet(config);
+	}
+	/**
+	* Set color scale rule.
+	* @param {{ index: number; color: string; value: IValueConfig }[]} config - The color scale rule settings.
+	* @param {number} config.index - The index of the color scale.
+	* @param {string} config.color - The color for the color scale.
+	* @param {IValueConfig} config.value - The value for the color scale.
+	* @returns {ConditionalFormatColorScaleRuleBuilder} The conditional format color scale rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that adds a color scale to cells with values between 0 and 100 in the range A1:D10.
+	* // The color scale is green for 0, yellow for 50, and red for 100.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setColorScale([
+	*     { index: 0, color: '#00FF00', value: { type: 'num', value: 0 } },
+	*     { index: 1, color: '#FFFF00', value: { type: 'num', value: 50 } },
+	*     { index: 2, color: '#FF0000', value: { type: 'num', value: 100 } }
+	*   ])
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setColorScale(config) {
+		return new ConditionalFormatColorScaleRuleBuilder(this._initConfig).setColorScale(config);
+	}
+	/**
+	* Set data bar rule.
+	* @param {object} config - The data bar rule settings.
+	* @param {IValueConfig} config.min - The minimum value for the data bar.
+	* @param {IValueConfig} config.max - The maximum value for the data bar.
+	* @param {boolean} [config.isGradient] - Whether the data bar is gradient.
+	* @param {string} config.positiveColor - The color for positive values.
+	* @param {string} config.nativeColor - The color for negative values.
+	* @param {boolean} [config.isShowValue] - Whether to show the value in the cell.
+	* @returns {ConditionalFormatDataBarRuleBuilder} The conditional format data bar rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that adds a data bar to cells with values between -100 and 100 in the range A1:D10.
+	* // positive values are green and negative values are red.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .setDataBar({
+	*     min: { type: 'num', value: -100 },
+	*     max: { type: 'num', value: 100 },
+	*     positiveColor: '#00FF00',
+	*     nativeColor: '#FF0000',
+	*     isShowValue: true
+	*   })
+	*  .setRanges([fRange.getRange()])
+	* .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setDataBar(config) {
+		return new ConditionalFormatDataBarRuleBuilder(this._initConfig).setDataBar(config);
+	}
+	/**
+	* Sets the background color for the conditional format rule's format.
+	* @param {string} [color] - The background color to set. If not provided, the background color is removed.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellEmpty()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setBackground(color) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setBackground(color);
+	}
+	/**
+	* Sets text bolding for the conditional format rule's format.
+	* @param {boolean} isBold - Whether to bold the text.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that bolds the text for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setBold(true)
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setBold(isBold) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setBold(isBold);
+	}
+	/**
+	* Sets the font color for the conditional format rule's format.
+	* @param {string} [color] - The font color to set. If not provided, the font color is removed.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that changes the font color to red for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setFontColor('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setFontColor(color) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setFontColor(color);
+	}
+	/**
+	* Sets text italics for the conditional format rule's format.
+	* @param {boolean} isItalic - Whether to italicize the text.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that italicizes the text for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setItalic(true)
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setItalic(isItalic) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setItalic(isItalic);
+	}
+	/**
+	* Sets text strikethrough for the conditional format rule's format.
+	* @param {boolean} isStrikethrough - Whether is strikethrough the text.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that set text strikethrough for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setStrikethrough(true)
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setStrikethrough(isStrikethrough) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setStrikethrough(isStrikethrough);
+	}
+	/**
+	* Sets text underlining for the conditional format rule's format.
+	* @param {boolean} isUnderline - Whether to underline the text.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that underlines the text for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setUnderline(true)
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	setUnderline(isUnderline) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).setUnderline(isUnderline);
+	}
+	/**
+	* Sets the conditional format rule to trigger when the cell is empty.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with no content in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellEmpty()
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenCellEmpty() {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenCellEmpty();
+	}
+	/**
+	* Sets the conditional format rule to trigger when the cell is not empty.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that changes the font color to red for cells with not empty content in the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenCellNotEmpty()
+	*   .setFontColor('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenCellNotEmpty() {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenCellNotEmpty();
+	}
+	/**
+	* Sets the conditional format rule to trigger when a time period is met.
+	* @param {CFTimePeriodOperator} date - The time period to check for.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with dates in the last 7 days in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenDate(univerAPI.Enum.ConditionFormatTimePeriodOperatorEnum.last7Days)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenDate(date) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenDate(date);
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the given formula evaluates to `true`.
+	* @param {string} formulaString - A custom formula that evaluates to true if the input is valid. formulaString start with '='.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenFormulaSatisfied('=A1>10')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenFormulaSatisfied(formulaString) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenFormulaSatisfied(formulaString);
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number falls between, or is either of, two specified values.
+	* @param {number} start - The lowest acceptable value.
+	* @param {number} end - The highest acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values between 10 and 20 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberBetween(10, 20)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberBetween(start, end) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenNumberBetween(start, end);
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number is equal to the given value.
+	* @param {number} value - The sole acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values equal to 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberEqualTo(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberEqualTo(value) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenNumberEqualTo(value);
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number is greater than the given value.
+	* @param {number} value - The highest unacceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values greater than 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberGreaterThan(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberGreaterThan(value) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenNumberGreaterThan(value);
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number is greater than or equal to the given value.
+	* @param {number} value - The lowest acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values greater than or equal to 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberGreaterThanOrEqualTo(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberGreaterThanOrEqualTo(value) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenNumberGreaterThanOrEqualTo(value);
+	}
+	/**
+	* Sets the conditional conditional format rule to trigger when a number less than the given value.
+	* @param {number} value - The lowest unacceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values less than 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberLessThan(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberLessThan(value) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenNumberLessThan(value);
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number less than or equal to the given value.
+	* @param {number} value - The highest acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values less than or equal to 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberLessThanOrEqualTo(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberLessThanOrEqualTo(value) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenNumberLessThanOrEqualTo(value);
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number does not fall between, and is neither of, two specified values.
+	* @param {number} start - The lowest unacceptable value.
+	* @param {number} end - The highest unacceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values not between 10 and 20 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberNotBetween(10, 20)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberNotBetween(start, end) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenNumberNotBetween(start, end);
+	}
+	/**
+	* Sets the conditional format rule to trigger when a number is not equal to the given value.
+	* @param {number} value - The sole unacceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with values not equal to 10 in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenNumberNotEqualTo(10)
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenNumberNotEqualTo(value) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenNumberNotEqualTo(value);
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input contains the given value.
+	* @param {string} text - The value that the input must contain.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text containing 'apple' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextContains('apple')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextContains(text) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenTextContains(text);
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input does not contain the given value.
+	* @param {string} text - The value that the input must not contain.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text not containing 'apple' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextDoesNotContain('apple')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextDoesNotContain(text) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenTextDoesNotContain(text);
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input ends with the given value.
+	* @param {string} text - Text to compare against the end of the string.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text ending with '.ai' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextEndsWith('.ai')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextEndsWith(text) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenTextEndsWith(text);
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input is equal to the given value.
+	* @param {string} text - The sole acceptable value.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text equal to 'apple' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextEqualTo('apple')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextEqualTo(text) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenTextEqualTo(text);
+	}
+	/**
+	* Sets the conditional format rule to trigger when that the input starts with the given value.
+	* @param {string} text - Text to compare against the beginning of the string.
+	* @returns {ConditionalFormatHighlightRuleBuilder} The conditional format highlight rule builder.
+	* @example
+	* ```typescript
+	* const fWorkbook = univerAPI.getActiveWorkbook();
+	* const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+	* if (!fWorksheet) return;
+	*
+	* // Create a conditional formatting rule that highlights cells with text starting with 'https://' in red for the range A1:D10.
+	* const fRange = fWorksheet.getRange('A1:D10');
+	* const rule = fWorksheet.newConditionalFormattingRule()
+	*   .whenTextStartsWith('https://')
+	*   .setBackground('#FF0000')
+	*   .setRanges([fRange.getRange()])
+	*   .build();
+	* fWorksheet.addConditionalFormattingRule(rule);
+	* ```
+	*/
+	whenTextStartsWith(text) {
+		return new ConditionalFormatHighlightRuleBuilder(this._initConfig).whenTextStartsWith(text);
+	}
+};
+
+//#endregion
+//#region src/facade/f-range.ts
+var FRangeSheetsConditionalFormattingMixin = class extends _cool_office_sheets_facade.FRange {
+	_getConditionalFormattingRuleModel() {
+		return this._injector.get(_cool_office_sheets_conditional_formatting.ConditionalFormattingRuleModel);
+	}
+	getConditionalFormattingRules() {
+		return [...this._getConditionalFormattingRuleModel().getSubunitRules(this._workbook.getUnitId(), this._worksheet.getSheetId()) || []].filter((rule) => rule.ranges.some((range) => _cool_office_core.Rectangle.intersects(range, this._range)));
+	}
+	createConditionalFormattingRule() {
+		return new FConditionalFormattingBuilder({ ranges: [this._range] });
+	}
+	clearConditionalFormatRules() {
+		const params = {
+			unitId: this._workbook.getUnitId(),
+			subUnitId: this._worksheet.getSheetId(),
+			ranges: [this._range]
+		};
+		this._commandService.syncExecuteCommand(_cool_office_sheets_conditional_formatting.ClearRangeCfCommand.id, params);
+		return this;
+	}
+};
+_cool_office_sheets_facade.FRange.extend(FRangeSheetsConditionalFormattingMixin);
+
+//#endregion
+//#region src/facade/f-worksheet.ts
+var FWorksheetConditionalFormattingMixin = class extends _cool_office_sheets_facade.FWorksheet {
+	_getConditionalFormattingRuleModel() {
+		return this._injector.get(_cool_office_sheets_conditional_formatting.ConditionalFormattingRuleModel);
+	}
+	getConditionalFormattingRules() {
+		return [...this._getConditionalFormattingRuleModel().getSubunitRules(this._workbook.getUnitId(), this._worksheet.getSheetId()) || []];
+	}
+	newConditionalFormattingRule() {
+		return new FConditionalFormattingBuilder();
+	}
+	addConditionalFormattingRule(rule) {
+		const params = {
+			unitId: this._workbook.getUnitId(),
+			subUnitId: this._worksheet.getSheetId(),
+			rule
+		};
+		this._commandService.syncExecuteCommand(_cool_office_sheets_conditional_formatting.AddCfCommand.id, params);
+		return this;
+	}
+	deleteConditionalFormattingRule(cfId) {
+		const params = {
+			unitId: this._workbook.getUnitId(),
+			subUnitId: this._worksheet.getSheetId(),
+			cfId
+		};
+		this._commandService.syncExecuteCommand(_cool_office_sheets_conditional_formatting.DeleteCfCommand.id, params);
+		return this;
+	}
+	moveConditionalFormattingRule(cfId, toCfId, type = "after") {
+		const params = {
+			unitId: this._workbook.getUnitId(),
+			subUnitId: this._worksheet.getSheetId(),
+			start: {
+				id: cfId,
+				type: "self"
+			},
+			end: {
+				id: toCfId,
+				type
+			}
+		};
+		this._commandService.syncExecuteCommand(_cool_office_sheets_conditional_formatting.MoveCfCommand.id, params);
+		return this;
+	}
+	setConditionalFormattingRule(cfId, rule) {
+		const params = {
+			unitId: this._workbook.getUnitId(),
+			subUnitId: this._worksheet.getSheetId(),
+			cfId,
+			rule
+		};
+		this._commandService.syncExecuteCommand(_cool_office_sheets_conditional_formatting.SetCfCommand.id, params);
+		return this;
+	}
+	clearConditionalFormatRules() {
+		const params = {
+			unitId: this._workbook.getUnitId(),
+			subUnitId: this._worksheet.getSheetId()
+		};
+		this._commandService.syncExecuteCommand(_cool_office_sheets_conditional_formatting.ClearWorksheetCfCommand.id, params);
+		return this;
+	}
+};
+_cool_office_sheets_facade.FWorksheet.extend(FWorksheetConditionalFormattingMixin);
+
+//#endregion
+//#region src/facade/f-enum.ts
+/**
+* Copyright 2023-present DreamNum Co., Ltd.
+*
+* 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.
+*/
+var FSheetsConditionalFormattingEnumMixin = class extends _cool_office_core_facade.FEnum {
+	get ConditionFormatNumberOperatorEnum() {
+		return _cool_office_sheets_conditional_formatting.CFNumberOperator;
+	}
+	get ConditionFormatTimePeriodOperatorEnum() {
+		return _cool_office_sheets_conditional_formatting.CFTimePeriodOperator;
+	}
+	get ConditionFormatIconSetTypeEnum() {
+		return _cool_office_sheets_conditional_formatting.IIconSetType;
+	}
+	get ConditionFormatValueTypeEnum() {
+		return _cool_office_sheets_conditional_formatting.CFValueType;
+	}
+};
+_cool_office_core_facade.FEnum.extend(FSheetsConditionalFormattingEnumMixin);
+
+//#endregion
+exports.FConditionalFormattingBuilder = FConditionalFormattingBuilder;