@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/conditionalFormat/IConditionalFormat.d.ts

@@ -0,0 +1,518 @@
+import { IRange, Scalar } from '@sheetxl/primitives';
+import { ReferenceableClipboard } from '@sheetxl/utils';
+import { IProperties } from '../type';
+import { ITransaction } from '../transaction';
+import { IHistory } from '../history';
+import { IAnchored } from '../anchored';
+import { ICellRanges } from '../cellRange';
+import { IListener } from '../listener';
+import { ICondition } from '../condition';
+import { IStyle } from '../style';
+import { IConditionalFormatCollection } from './IConditionalFormatCollection';
+/**
+ * Represents a conditional formatting rule for a range.
+ *
+ * @remarks
+ * Used for modifying the type and rules of a conditional formatting entry.
+ *
+ * * Conditional formatting rules can be used to highlight, format, or modify
+ *   cell appearance based on data conditions or criteria.
+ *
+ * * Conditional formatting help users identify patterns, trends, and exceptions
+ *   in data by applying visual styles dynamically.
+ */
+export interface IConditionalFormat extends IAnchored, ICondition.Stateful, IProperties.ICellRanged<IStyle.Properties> {
+    /**
+     * Re-anchors this rule to `address`, REPLACING every range it currently covers.
+     *
+     * @param address The range or ranges to cover — anything `ISheet.getRanges` accepts
+     *   (`'A1:C20'`, `'A1:A5, C1:C5'`, coords). Resolved against this rule's own sheet.
+     * @param options Transaction options; `description` names the entry in undo history.
+     *
+     * @remarks
+     * A REPLACE, not an add: the ranges named become the whole anchor. An address that names
+     * nothing throws rather than leaving the rule unanchored — clearing is
+     * {@link IAnchored.delete}.
+     *
+     * Undoable, and refused on a protected sheet. A rule spans several ranges as readily as
+     * one; Excel writes them as one `sqref`, and so do we.
+     */
+    setRanges(address: ICellRanges.Address, options?: ITransaction.OperationOptions): this;
+    /**
+     * Set the condition.
+     *
+     * @remarks
+     * The condition **is** the rule's predicate — there is no second, OOXML-shaped representation of
+     * it. A rule that maps a range of values onto a visual instead of testing each cell carries a
+     * {@link IConditionalFormat.getScale} rather than a condition.
+     */
+    setCondition(condition: ICondition.Input | null, options?: ITransaction.OperationOptions): this;
+    /**
+     * Returns the index of this conditional format within its container.
+     *
+     * @remarks
+     * The index is the evaluation order (index 0 evaluates first). Exported to OOXML as
+     * `priority = index + 1`.
+     */
+    getIndex(): number;
+    /**
+     * Sets the index of this conditional format within its container.
+     * @param index The new index to set.
+     */
+    setIndex(index: number): this;
+    /**
+     * Sets whether to stop evaluating additional conditional formatting rules if this rule is true.
+     *
+     * @param stopIfTrue A boolean to indicate if this is a stop.
+     *
+     * @remarks
+     * This will only affect formatting rules for the current range or cell.
+     */
+    setStopIfTrue(stopIfTrue: boolean, options?: ITransaction.OperationOptions): this;
+    /**
+     * @see {@link IConditionalFormat.setStopIfTrue}
+     *
+     * @remarks
+     * The flag **as authored**, which is what round-trips — not whether it takes effect. It is a
+     * predicate-rule concept: a color scale, data bar or icon set always applies, so it ends
+     * nothing, and Excel greys the checkbox out for all three. The attribute is still schema-legal
+     * on any `cfRule`, so a rule can arrive from a file carrying it on a data bar; Excel ignores it
+     * there and so does evaluation here. The authored value is kept verbatim rather than rewritten
+     * on load, so such a rule round-trips unchanged.
+     */
+    isStopIfTrue(): boolean;
+    /**
+     * Returns the value→visual mapping for this rule, or `null` if the rule is a predicate.
+     *
+     * @remarks
+     * Color scales, data bars and icon sets are not predicates: they map the whole range's spread of
+     * values onto a rendering rather than testing each cell. A rule carries either a
+     * {@link IConditionalFormat.getCondition} or a scale, never both.
+     */
+    getScale(): IConditionalFormat.Scale | null;
+    /**
+     * Returns the style applied when the condition is met, or `null` if the rule renders itself
+     * (see {@link IConditionalFormat.getScale}).
+     *
+     * @remarks
+     * The OOXML `dxf`, inlined. A differential format: only the properties it names are overridden.
+     */
+    getStyle(): IStyle.Properties | null;
+    /**
+     * Returns what this rule draws in a cell, or `null` if it draws nothing there.
+     *
+     * @param rowIndex The cell's row.
+     * @param colIndex The cell's column.
+     * @param value The cell's value.
+     *
+     * @remarks
+     * The render-side companion to {@link IProperties.ICellRanged.getPropertiesAt}: a rule that
+     * restyles a cell answers through that, a rule that *draws* in it answers through this. Only a
+     * data bar or an icon set ever returns a decoration — a color scale resolves to a fill and so
+     * travels the style path.
+     *
+     * Like `getPropertiesAt` this is a synchronous read off a prepared cache, never an evaluation:
+     * the range-wide domain (min / max / percentile) is resolved asynchronously when values change.
+     * A rule whose domain has not resolved yet returns `null`.
+     */
+    getDecorationAt(rowIndex: number, colIndex: number, value: Scalar): IConditionalFormat.Decoration | null;
+    /**
+     * Set multiple properties at the same time.
+     *
+     * @remarks
+     * Only the keys named are touched. An explicit `null` **clears** a key — required when switching
+     * a rule between its two shapes, since `condition`+`style` and `scale` are mutually exclusive
+     * (setting one side also clears the other unless the caller named both).
+     */
+    update(properties: IConditionalFormat.Modifiers, options?: ITransaction.OperationOptions): this;
+    /**
+     * Returns a snapshot of the conditional that can be used for copying and archiving.
+     */
+    getSnapshot(options?: ReferenceableClipboard.CopyOptions): IConditionalFormat.ISnapshot;
+    /**
+     * Add Listeners.
+     *
+     * @see
+     * {@link IListener.ISource.addListeners}
+     */
+    addListeners(listeners: IConditionalFormat.IListeners, options?: IListener.Options): IListener.Remove;
+    /**
+     * @returns The current state as a JSON object, or `null` if there is no state.
+     */
+    toJSON(): IConditionalFormat.JSON | null;
+    /**
+     * For runtime type checking.
+     */
+    readonly isIConditionalFormat: true;
+}
+/**
+ * Capabilities for working with conditional styling ranges.
+ *
+ * @see
+ * ### **Interface**
+ *
+ * {@link IConditionalFormat}
+ *
+ * **Additional Interfaces**
+ * * {@link IConditionalFormatCollection}
+ */
+export declare namespace IConditionalFormat {
+    /**
+     * The three rules that are a value→visual mapping rather than a predicate.
+     *
+     * @remarks
+     * OOXML spells eighteen `cfRule` types; fifteen of them are a predicate plus a style and are
+     * modeled as {@link ICondition} + {@link IConditionalFormat.getStyle}. These three are not
+     * boolean tests at all — they read the whole range and render across it — so they get their own
+     * shape. The remaining OOXML type names are an IO concern and live in `io-xlsx`.
+     */
+    const ScaleType: {
+        /**
+         * A gradient across the range's values.
+         */
+        readonly ColorScale: "colorScale";
+        /**
+         * An in-cell bar proportional to the value.
+         */
+        readonly DataBar: "dataBar";
+        /**
+         * An in-cell icon chosen by which band the value falls in.
+         */
+        readonly IconSet: "iconSet";
+    };
+    type ScaleType = typeof ScaleType[keyof typeof ScaleType];
+    const ColorStopType: {
+        /**
+         * The larger of zero and the range's minimum. Data bars only (an Excel 2010 refinement of
+         * {@link IConditionalFormat.ColorStopType.Min}).
+         */
+        readonly AutoMin: "autoMin";
+        /**
+         * The larger of zero and the range's maximum. Data bars only.
+         */
+        readonly AutoMax: "autoMax";
+        /**
+         * The minimum/ midpoint / maximum value for the gradient is determined by a formula.
+         */
+        readonly Formula: "formula";
+        /**
+         * Indicates that the maximum value in the range shall be used as the maximum value for the gradient.
+         */
+        readonly Max: "max";
+        /**
+         * Indicates that the minimum value in the range shall be used as the minimum value for the gradient.
+         */
+        readonly Min: "min";
+        /**
+         * Indicates that the minimum / midpoint / maximum value for the gradient is specified by a constant numeric value.
+         */
+        readonly Num: "num";
+        /**
+         * Value indicates a percentage between the minimum and maximum values in the range shall be used as the minimum / midpoint / maximum value for the gradient.
+         */
+        readonly Percent: "percent";
+        /**
+         * Value indicates a percentile ranking in the range shall be used as the minimum / midpoint / maximum value for the gradient.
+         */
+        readonly Percentile: "percentile";
+    };
+    type ColorStopType = typeof ColorStopType[keyof typeof ColorStopType];
+    /**
+     * One threshold in a {@link IConditionalFormat.Scale} — where a band starts.
+     *
+     * @remarks
+     * Stops are held in the order they were authored, which for every scale Excel can write is
+     * ascending. A color scale attaches a color to each; a data bar and an icon set do not.
+     */
+    interface Stop {
+        /**
+         * @defaultValue StopType.Num
+         */
+        type?: IConditionalFormat.ColorStopType;
+        /**
+         * The value of the stop
+         *
+         * @remarks
+         * * For numbers:
+         *   Threshold value:
+         *   - Num: absolute number
+         *   - Percent: 0..100 of min..max span
+         *   - Percentile: 0..100 quantile (requires percentile stats)
+         * * For strings:
+         * - Formula: a formula that evaluates to a string value.
+         */
+        value?: number | string;
+        /**
+         * Upper bound exclusivity.
+         *
+         * @remarks
+         * false => inclusive (>=), true => exclusive (>)
+         * If true, equality does NOT enter the upper stop/segment (exclusive upper bound).
+         * Default false matches Excel's boundary-inclusive behavior.
+         *
+         * @defaultValue false
+         */
+        exclusive?: boolean;
+    }
+    /**
+     * A {@link IConditionalFormat.Stop} that also carries the color its band starts at.
+     */
+    interface ColorScaleStop extends IConditionalFormat.Stop {
+        /**
+         * Stop color.
+         */
+        color: string;
+    }
+    /**
+     * A gradient across the range's values. Excel's UI authors 2 or 3 stops; the format allows more.
+     */
+    interface ColorScale {
+        type: typeof IConditionalFormat.ScaleType.ColorScale;
+        stops: IConditionalFormat.ColorScaleStop[];
+    }
+    /**
+     * An in-cell bar whose length is the value's position between the two stops.
+     */
+    interface DataBar {
+        type: typeof IConditionalFormat.ScaleType.DataBar;
+        /**
+         * The lower and upper bound of the bar. Always two.
+         */
+        stops: IConditionalFormat.Stop[];
+        /**
+         * The bar's fill color.
+         */
+        color?: string;
+        maxLength?: number;
+        minLength?: number;
+        /**
+         * If true, the value will be shown in the cell.
+         */
+        showValue?: boolean;
+        /**
+         * A gradient fill fading from {@link color}; absent is a solid bar.
+         */
+        gradient?: boolean;
+        /**
+         * The bar's border color. Absent means no border.
+         */
+        borderColor?: string;
+        /**
+         * The fill for bars of negative values. Absent means negative bars use {@link color}.
+         */
+        negativeFillColor?: string;
+        /**
+         * The border for bars of negative values. Absent means negative bars use
+         * {@link borderColor}.
+         */
+        negativeBorderColor?: string;
+        /**
+         * The color of the axis drawn between positive and negative bars.
+         */
+        axisColor?: string;
+        /**
+         * Where the axis sits when the range mixes signs. Absent is automatic (proportional to the
+         * values); `middle` fixes it at the cell midpoint; `none` draws no axis and bars grow from
+         * the value's own side.
+         */
+        axisPosition?: 'middle' | 'none';
+        /**
+         * The direction bars grow in. Absent follows the cell's text direction.
+         */
+        direction?: 'leftToRight' | 'rightToLeft';
+    }
+    /**
+     * An in-cell icon chosen by which band the value falls in.
+     */
+    interface IconSet {
+        type: typeof IConditionalFormat.ScaleType.IconSet;
+        /**
+         * Where each icon's band starts. One per icon in the set.
+         */
+        stops: IConditionalFormat.Stop[];
+        /**
+         * Per-stop icon overrides — one entry per stop, each naming the set the icon is borrowed
+         * from and its zero-based index within that set.
+         */
+        icon?: {
+            set: IStyle.IconSet;
+            id: number;
+        }[];
+        /**
+         * The icon set to use
+         */
+        iconSet?: IStyle.IconSet;
+        reverse?: boolean;
+        /**
+         * If true, the value will be shown in the cell.
+         */
+        showValue?: boolean;
+    }
+    /**
+     * A value→visual mapping across the whole range — not a predicate.
+     *
+     * @remarks
+     * Discriminated on {@link IConditionalFormat.ScaleType}.
+     */
+    type Scale = IConditionalFormat.ColorScale | IConditionalFormat.DataBar | IConditionalFormat.IconSet;
+    /**
+     * The in-cell bar a {@link IConditionalFormat.DataBar} resolves to for one cell.
+     *
+     * @remarks
+     * Render-ready: the value has already been placed on the bar's track, so a renderer never sees a
+     * {@link IConditionalFormat.Stop} and never re-derives the range's domain.
+     */
+    interface DataBarDecoration {
+        type: typeof IConditionalFormat.ScaleType.DataBar;
+        /**
+         * Where the value sits on the track, `0` (lower stop) to `1` (upper stop). Clamped.
+         */
+        value: number;
+        /**
+         * Where zero sits on the track, `0` to `1`. `0` when the range never goes negative — the
+         * common case, and the bar then simply grows from the left.
+         */
+        axis: number;
+        /** The bar's fill, resolved to a CSS color. */
+        color: string;
+        /** The fill for a negative bar, resolved. Absent means negative bars reuse {@link color}. */
+        negativeColor?: string;
+        /** The bar's border, resolved. Absent means no border. */
+        borderColor?: string;
+        /** The border for a negative bar, resolved. Absent means it reuses {@link borderColor}. */
+        negativeBorderColor?: string;
+        /** The axis rule's color, resolved. Only meaningful when {@link axis} is not `0`. */
+        axisColor?: string;
+        /** Fade the fill from {@link color} rather than painting it solid. */
+        gradient: boolean;
+        /** The direction the bar grows in, resolved against the cell's text direction. */
+        direction: 'leftToRight' | 'rightToLeft';
+        /** Draw the cell's value beside the bar. When `false` the bar is the cell's only content. */
+        showValue: boolean;
+    }
+    /**
+     * The icon a {@link IConditionalFormat.IconSet} resolves to for one cell.
+     *
+     * @remarks
+     * Render-ready: the band has already been chosen, so a renderer needs only a set → glyph table.
+     * {@link set} is per-cell rather than per-rule because a rule may borrow each band's icon from a
+     * different set (OOXML's per-stop `iconSet`/`iconId` override).
+     */
+    interface IconSetDecoration {
+        type: typeof IConditionalFormat.ScaleType.IconSet;
+        /** Which band the value fell in. `0` is the lowest band, matching `stops[0]`. */
+        index: number;
+        /** The set {@link index} indexes into — the rule's own, or a per-stop override. */
+        set: IStyle.IconSet;
+        /** How many bands {@link set} has, so a renderer can bounds-check {@link index}. */
+        count: number;
+        /** Draw the cell's value beside the icon. When `false` the icon is the cell's only content. */
+        showValue: boolean;
+    }
+    /**
+     * What a rule renders for one cell, for the two scales that draw rather than restyle.
+     *
+     * @remarks
+     * A {@link IConditionalFormat.ColorScale} is absent here on purpose: it resolves to a fill, so it
+     * travels the ordinary style path ({@link IProperties.ICellRanged.getPropertiesAt}).
+     */
+    type Decoration = IConditionalFormat.DataBarDecoration | IConditionalFormat.IconSetDecoration;
+    /**
+     * Every decoration that applies to one cell.
+     *
+     * @remarks
+     * A bar and an icon set can apply to the same cell — Excel draws the icon over the bar — so this
+     * is a slot per kind rather than a single value. Within a kind the first rule in evaluation order
+     * wins.
+     */
+    interface Decorations {
+        dataBar: IConditionalFormat.DataBarDecoration | null;
+        iconSet: IConditionalFormat.IconSetDecoration | null;
+    }
+    /**
+     * A set of values that can be set on a IConditionalFormat.
+     *
+     * @see
+     * {@link IConditionalFormat}
+     */
+    interface Properties {
+        /**
+         * The predicate. Set for every rule that is a per-cell test.
+         *
+         * @remarks
+         * Mutually exclusive with {@link IConditionalFormat.Properties.scale}.
+         */
+        condition?: ICondition.Properties;
+        /**
+         * The differential style applied where the condition holds.
+         */
+        style?: IStyle.Properties;
+        /**
+         * The value→visual mapping, for the three rules that are not predicates.
+         *
+         * @remarks
+         * Mutually exclusive with {@link IConditionalFormat.Properties.condition}.
+         */
+        scale?: IConditionalFormat.Scale;
+        /**
+         * Stop evaluating later rules for a cell this one matched.
+         *
+         * @defaultValue false
+         */
+        stopIfTrue?: boolean;
+    }
+    /**
+     * The shape {@link IConditionalFormat.update} accepts — {@link IConditionalFormat.Properties}
+     * widened so a named key may be `null`, which clears it.
+     */
+    type Modifiers = {
+        [K in keyof IConditionalFormat.Properties]?: IConditionalFormat.Properties[K] | null;
+    };
+    /**
+     * Provides destination details for the Snapshot when using {@link IHistory.ISnapshot.copyTo}.
+     */
+    interface SnapshotDestination {
+        conditionals: IConditionalFormatCollection;
+        /** The first pasted area. `ranges` carries the rest when the paste tiles. */
+        range: IRange.Coords;
+        /** Every pasted image of the rule's marked areas — tiled, transposed, clipped. */
+        ranges?: IRange.Coords[];
+        /**
+         * Extend the live source rule instead of cloning — the same-sheet paste. Falls back to a
+         * clone when the source rule is gone or its definition changed since the mark.
+         */
+        extend?: boolean;
+        /** Insert position for a cloned rule. Pastes land at top priority, Excel-style. */
+        index?: number;
+    }
+    interface ISnapshot extends IHistory.ISnapshot<IConditionalFormat.SnapshotDestination, IConditionalFormat, IRange.Coords> {
+    }
+    /**
+     * A JSON representation useful for persistence.
+     */
+    interface JSON extends Properties {
+        /**
+         * If associated with a pivot.
+         *
+         * @defaultValue false
+         */
+        pivot?: boolean;
+        /**
+         * Payload from a rule this build does not understand.
+         *
+         * @remarks
+         * Namespaced by producer. Survives the sxl round-trip; **dropped with a warning on xlsx
+         * write** until a carrier is chosen. Reserved so that adding one later does not change the
+         * persisted shape.
+         */
+        ext?: Record<string, unknown>;
+    }
+    /**
+     * IListener for {@link IConditionalFormat} events.
+     */
+    interface Events extends IAnchored.Events {
+    }
+    interface IListeners extends IListener.Callbacks<IConditionalFormat, IConditionalFormat.Events> {
+    }
+}
+//# sourceMappingURL=IConditionalFormat.d.ts.map

package/types/src/conditionalFormat/IConditionalFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IConditionalFormat.d.ts","sourceRoot":"","sources":["../../../../src/conditionalFormat/IConditionalFormat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAE7D,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,KAAK,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF;;;;;;;;;;;GAWG;AAEH,MAAM,WAAW,kBAAmB,SAAQ,SAAS,EAAE,UAAU,CAAC,QAAQ,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC;IACpH;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IACvF;;;;;;;OAOG;IACH,YAAY,CACV,SAAS,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,EAClC,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GACtC,IAAI,CAAC;IACR;;;;;;OAMG;IACH,QAAQ,IAAI,MAAM,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;;;;OAOG;IACH,aAAa,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAClF;;;;;;;;;;OAUG;IACH,YAAY,IAAI,OAAO,CAAC;IACxB;;;;;;;OAOG;IACH,QAAQ,IAAI,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;IAC5C;;;;;;OAMG;IACH,QAAQ,IAAI,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IACrC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAAC,UAAU,GAAG,IAAI,CAAC;IACzG;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,EAAE,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAChG;;OAEG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,sBAAsB,CAAC,WAAW,GAAG,kBAAkB,CAAC,SAAS,CAAC;IACxF;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,kBAAkB,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC;IACtG;;OAEG;IACH,MAAM,IAAI,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,oBAAoB,EAAE,IAAI,CAAC;CACrC;AAGD;;;;;;;;;;GAUG;AACH,yBAAiB,kBAAkB,CAAC;IAClC;;;;;;;;OAQG;IACI,MAAM,SAAS;QACpB;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;KAEK,CAAC;IACX,KAAY,SAAS,GAAG,OAAO,SAAS,CAAC,MAAM,OAAO,SAAS,CAAC,CAAC;IAE1D,MAAM,aAAa;QACxB;;;WAGG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;KAEK,CAAC;IACX,KAAY,aAAa,GAAG,OAAO,aAAa,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,IAAI,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC;QACxC;;;;;;;;;;;WAWG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACxB;;;;;;;;;WASG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB;IAED;;OAEG;IACH,UAAiB,cAAe,SAAQ,kBAAkB,CAAC,IAAI;QAC7D;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,EAAE,OAAO,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC;QACrD,KAAK,EAAE,kBAAkB,CAAC,cAAc,EAAE,CAAC;KAC5C;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB,IAAI,EAAE,OAAO,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC;QAClD;;WAEG;QACH,KAAK,EAAE,kBAAkB,CAAC,IAAI,EAAE,CAAC;QACjC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;WAEG;QAEH,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B;;;WAGG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB;;;;WAIG;QACH,YAAY,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;QACjC;;WAEG;QACH,SAAS,CAAC,EAAE,aAAa,GAAG,aAAa,CAAC;KAC3C;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB,IAAI,EAAE,OAAO,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC;QAClD;;WAEG;QACH,KAAK,EAAE,kBAAkB,CAAC,IAAI,EAAE,CAAC;QACjC;;;WAGG;QACH,IAAI,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;QAE7C;;WAEG;QAEH,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;QACzB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;WAEG;QAEH,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB;IAED;;;;;OAKG;IACH,KAAY,KAAK,GACb,kBAAkB,CAAC,UAAU,GAC7B,kBAAkB,CAAC,OAAO,GAC1B,kBAAkB,CAAC,OAAO,CAAC;IAE/B;;;;;;OAMG;IACH,UAAiB,iBAAiB;QAChC,IAAI,EAAE,OAAO,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC;QAClD;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb,+CAA+C;QAC/C,KAAK,EAAE,MAAM,CAAC;QACd,6FAA6F;QAC7F,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,0DAA0D;QAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,2FAA2F;QAC3F,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,qFAAqF;QACrF,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,sEAAsE;QACtE,QAAQ,EAAE,OAAO,CAAC;QAClB,kFAAkF;QAClF,SAAS,EAAE,aAAa,GAAG,aAAa,CAAC;QACzC,6FAA6F;QAC7F,SAAS,EAAE,OAAO,CAAC;KACpB;IAED;;;;;;;OAOG;IACH,UAAiB,iBAAiB;QAChC,IAAI,EAAE,OAAO,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAAC;QAClD,iFAAiF;QACjF,KAAK,EAAE,MAAM,CAAC;QACd,mFAAmF;QACnF,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC;QACpB,oFAAoF;QACpF,KAAK,EAAE,MAAM,CAAC;QACd,+FAA+F;QAC/F,SAAS,EAAE,OAAO,CAAC;KACpB;IAED;;;;;;OAMG;IACH,KAAY,UAAU,GAClB,kBAAkB,CAAC,iBAAiB,GACpC,kBAAkB,CAAC,iBAAiB,CAAC;IAEzC;;;;;;;OAOG;IACH,UAAiB,WAAW;QAC1B,OAAO,EAAE,kBAAkB,CAAC,iBAAiB,GAAG,IAAI,CAAC;QACrD,OAAO,EAAE,kBAAkB,CAAC,iBAAiB,GAAG,IAAI,CAAC;KACtD;IAED;;;;;OAKG;IACH,UAAiB,UAAU;QACzB;;;;;WAKG;QACH,SAAS,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC;QAClC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;QAC1B;;;;;WAKG;QACH,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;QACjC;;;;WAIG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;IAED;;;OAGG;IACH,KAAY,SAAS,GAAG;SACrB,CAAC,IAAI,MAAM,kBAAkB,CAAC,UAAU,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI;KACrF,CAAC;IAEF;;OAEG;IACH,UAAiB,mBAAmB;QAClC,YAAY,EAAE,4BAA4B,CAAC;QAC3C,6EAA6E;QAC7E,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,kFAAkF;QAClF,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;QACzB;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,mFAAmF;QACnF,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,UAAiB,SAAU,SAAQ,QAAQ,CAAC,SAAS,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC;KAAG;IAEnI;;OAEG;IACH,UAAiB,IAAK,SAAQ,UAAU;QACtC;;;;WAIG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB;;;;;;;WAOG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC/B;IAED;;OAEG;IACH,UAAiB,MAAO,SAAQ,SAAS,CAAC,MAAM;KAM/C;IAED,UAAiB,UAAW,SAAQ,SAAS,CAAC,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,MAAM,CAAC;KAAG;CAE1G"}

package/types/src/conditionalFormat/IConditionalFormatCollection.d.ts

@@ -0,0 +1,70 @@
+import { ICellRange, ICellRanges } from '../cellRange';
+import { ICollection } from '../type';
+import { IConditionalFormat } from './IConditionalFormat';
+import { ITransaction } from '../transaction';
+/**
+ * Holds a collection of {@link IConditionalFormat}s.
+ */
+export interface IConditionalFormatCollection extends ICollection<IConditionalFormat> {
+    /**
+     * Add an `IConditionalFormat` to the container.
+     *
+     * @param address The address of the item. May name several discontiguous ranges.
+     * @param options {@link IConditionalFormatCollection.AddOptions}
+     */
+    add(address: ICellRanges.Address | IConditionalFormat, options?: IConditionalFormatCollection.AddOptions): IConditionalFormat;
+    /**
+     * Returns items that match the filter criteria.
+     *
+     * If no filter criteria is provided, all items will be returned.
+     *
+     * @param options {@link IConditionalFormatCollection.GetItemsOptions}
+     */
+    getItems(options?: IConditionalFormatCollection.GetItemsOptions): IConditionalFormat[];
+    /**
+     * Create a temporary item that can be interacted with but is not added to the collection.
+     *
+     * @param template A template to use for the temporary item.
+     */
+    createItem(template?: IConditionalFormat): IConditionalFormat;
+}
+/**
+ * {@inheritDoc IConditionalFormatCollection}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IConditionalFormatCollection}
+ */
+export declare namespace IConditionalFormatCollection {
+    /**
+     * Options for adding a {@link IConditionalFormat}.
+     */
+    interface AddOptions extends IConditionalFormat.Properties, ITransaction.OperationOptions {
+    }
+    /**
+     * Options for searching for {@link IConditionalFormat}s.
+     */
+    interface GetItemsOptions extends ICollection.GetItemsOptions {
+        /**
+         * If provided, the search will be limited to items that intersect the range.
+        */
+        address?: ICellRange.Address;
+        /**
+         * Indicate if items that are in hidden headers or marked as hidden should be returned.
+         *
+         * @defaultValue false
+         */
+        ignoreHidden?: boolean;
+        /**
+         * Only return items that are completely contained with the search bounds.
+         *
+         * @defaultValue false
+         */
+        fullyContained?: boolean;
+        /**
+         * Search with the given name. This is case insensitive.
+         */
+        name?: string;
+    }
+}
+//# sourceMappingURL=IConditionalFormatCollection.d.ts.map

package/types/src/conditionalFormat/IConditionalFormatCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IConditionalFormatCollection.d.ts","sourceRoot":"","sources":["../../../../src/conditionalFormat/IConditionalFormatCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AAEH,MAAM,WAAW,4BAA6B,SAAQ,WAAW,CAAC,kBAAkB,CAAC;IACnF;;;;;OAKG;IACH,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,kBAAkB,EAAE,OAAO,CAAC,EAAE,4BAA4B,CAAC,UAAU,GAAG,kBAAkB,CAAC;IAC9H;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,4BAA4B,CAAC,eAAe,GAAG,kBAAkB,EAAE,CAAC;IACvF;;;;OAIG;IACH,UAAU,CAAC,QAAQ,CAAC,EAAE,kBAAkB,GAAG,kBAAkB,CAAC;CAC/D;AAED;;;;;;GAMG;AACH,yBAAiB,4BAA4B,CAAC;IAE5C;;OAEG;IACH,UAAiB,UAAW,SAAQ,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,gBAAgB;KAAG;IAEnG;;OAEG;IACH,UAAiB,eAAgB,SAAQ,WAAW,CAAC,eAAe;QAClE;;UAEE;QACF,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;QAC7B;;;;WAIG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;;WAIG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF"}

package/types/src/conditionalFormat/_ConditionalMessages.d.ts

@@ -0,0 +1,2 @@
+export declare const MODEL_CLOSED = "Table has been closed. No further operations are allowed.";
+//# sourceMappingURL=_ConditionalMessages.d.ts.map

package/types/src/conditionalFormat/_ConditionalMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ConditionalMessages.d.ts","sourceRoot":"","sources":["../../../../src/conditionalFormat/_ConditionalMessages.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,YAAY,8DAA8D,CAAC"}

package/types/src/conditionalFormat/index.d.ts

@@ -0,0 +1,3 @@
+export * from './IConditionalFormat';
+export * from './IConditionalFormatCollection';
+//# sourceMappingURL=index.d.ts.map

package/types/src/conditionalFormat/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/conditionalFormat/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,gCAAgC,CAAC"}