npm - @univerjs/sheets-conditional-formatting - Versions diffs - 0.5.1 → 0.5.2 - Mend

@univerjs/sheets-conditional-formatting 0.5.1 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/lib/cjs/facade.js +1 -0
package/lib/cjs/index.js +1 -1
package/lib/es/facade.js +815 -0
package/lib/es/index.js +205 -200
package/lib/types/facade/conditional-formatting-builder.d.ts +487 -0
package/lib/types/facade/f-range.d.ts +106 -0
package/lib/types/facade/f-workbook.d.ts +12 -0
package/lib/types/facade/f-worksheet.d.ts +116 -0
package/lib/types/facade/index.d.ts +22 -0
package/lib/umd/facade.js +1 -0
package/lib/umd/index.js +1 -1
package/package.json +18 -8

package/lib/types/facade/f-worksheet.d.ts ADDED Viewed

@@ -0,0 +1,116 @@
+import { IAnchor, IConditionFormattingRule } from '@univerjs/sheets-conditional-formatting';
+import { FWorksheet } from '@univerjs/sheets/facade';
+import { FConditionalFormattingBuilder } from './conditional-formatting-builder';
+export interface IFWorksheetConditionalFormattingMixin {
+    /**
+     * Gets all the conditional formatting for the current sheet
+     * @return {*}  {IConditionFormattingRule[]}
+     * @memberof IFWorksheetConditionalFormattingMixin
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()?.getActiveSheet().getConditionalFormattingRules();
+     * ```
+     */
+    getConditionalFormattingRules(): IConditionFormattingRule[];
+    /**
+     * Creates a constructor for conditional formatting
+     * @return {*}  {ConditionalFormatRuleBuilder}
+     * @memberof IFWorksheetConditionalFormattingMixin
+     * @example
+     * ```ts
+     *  const workbook = univerAPI.getActiveWorkbook();
+     *  const worksheet = workbook?.getActiveSheet();
+     *  const rule = worksheet?.createConditionalFormattingRule()
+     *      .whenCellNotEmpty()
+     *      .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
+     *      .setItalic(true)
+     *      .setItalic(true)
+     *      .setBackground('red')
+     *      .setFontColor('green')
+     *      .build();
+     * ```
+     */
+    createConditionalFormattingRule(): FConditionalFormattingBuilder;
+    /**
+     * Add a new conditional format
+     * @param {IConditionFormattingRule} rule
+     * @return {*}  {Promise<boolean>}
+     * @memberof IFWorksheetConditionalFormattingMixin
+     * @example
+     * ```ts
+     *  const workbook = univerAPI.getActiveWorkbook();
+     *  const worksheet = workbook?.getActiveSheet();
+     *  const rule = worksheet?.createConditionalFormattingRule()
+     *       .whenCellNotEmpty()
+     *       .setRanges([{ startRow: 0, endRow: 100, startColumn: 0, endColumn: 100 }])
+     *       .setItalic(true)
+     *       .setItalic(true)
+     *       .setBackground('red')
+     *       .setFontColor('green')
+     *       .build();
+     *  worksheet?.addConditionalFormattingRule(rule!);
+     * ```
+     */
+    addConditionalFormattingRule(rule: IConditionFormattingRule): Promise<boolean>;
+    /**
+     * Delete conditional format according to `cfId`
+     *
+     * @param {string} cfId
+     * @return {*}  {Promise<boolean>}
+     * @memberof IFWorksheetConditionalFormattingMixin
+     * @example
+     * ```ts
+     *  const workbook = univerAPI.getActiveWorkbook();
+     *  const worksheet = workbook?.getActiveSheet();
+     *  const rules = worksheet?.getConditionalFormattingRules();
+     *  worksheet?.deleteConditionalFormattingRule(rules![0].cfId);
+     * ```
+     */
+    deleteConditionalFormattingRule(cfId: string): Promise<boolean>;
+    /**
+     * Modify the priority of the conditional format
+     * @param {string} cfId Rules that need to be moved
+     * @param {string} toCfId Target rule
+     * @param {IAnchor['type']} [type] After the default move to the destination rule, if type = before moves to the front, the default value is after
+     * @memberof FWorksheetConditionalFormattingMixin
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook?.getActiveSheet();
+     * const rules = worksheet?.getConditionalFormattingRules()!;
+     * const rule = rules[2];
+     * const targetRule = rules[0];
+     * worksheet?.moveConditionalFormattingRule(rule.cfId, targetRule.cfId, 'before');
+     * ```
+     */
+    moveConditionalFormattingRule(cfId: string, toCfId: string, type?: IAnchor['type']): Promise<boolean>;
+    /**
+     * Set the conditional format according to `cfId`
+     * @param {string} cfId
+     * @param {IConditionFormattingRule} rule
+     * @return {*}  {Promise<boolean>}
+     * @memberof IFWorksheetConditionalFormattingMixin
+     * @example
+     * ```ts
+     *   const workbook = univerAPI.getActiveWorkbook();
+     *   const worksheet = workbook?.getActiveSheet();
+     *   const rules = worksheet?.getConditionalFormattingRules()!;
+     *   const rule = rules[0];
+     *   worksheet?.setConditionalFormattingRule(rule.cfId, { ...rule, ranges: [] });
+     * ```
+     */
+    setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): Promise<boolean>;
+}
+export declare class FWorksheetConditionalFormattingMixin extends FWorksheet implements IFWorksheetConditionalFormattingMixin {
+    private _getConditionalFormattingRuleModel;
+    getConditionalFormattingRules(): IConditionFormattingRule[];
+    createConditionalFormattingRule(): FConditionalFormattingBuilder;
+    addConditionalFormattingRule(rule: IConditionFormattingRule): Promise<boolean>;
+    deleteConditionalFormattingRule(cfId: string): Promise<boolean>;
+    moveConditionalFormattingRule(cfId: string, toCfId: string, type?: IAnchor['type']): Promise<boolean>;
+    setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): Promise<boolean>;
+}
+declare module '@univerjs/sheets/facade' {
+    interface FWorksheet extends IFWorksheetConditionalFormattingMixin {
+    }
+}

package/lib/types/facade/index.d.ts ADDED Viewed

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import './f-range';
+import './f-workbook';
+import './f-worksheet';
+export { FConditionalFormattingBuilder } from './conditional-formatting-builder';
+export type { IFRangeConditionalFormattingMixin } from './f-range';
+export type { FWorkbookConditionalFormattingMixin } from './f-workbook';
+export type { IFWorksheetConditionalFormattingMixin } from './f-worksheet';

package/lib/umd/facade.js ADDED Viewed

@@ -0,0 +1 @@