@sheetxl/sdk 0.7.27 → 0.7.28-beta.1

package/types/src/sheet/ISheetCollection.d.ts

@@ -0,0 +1,70 @@
+import { ICollection } from '../type';
+import { ITransaction } from '../transaction';
+import { ISheet } from './ISheet';
+/**
+ * Holds a collection of {@link ISheet}s.
+ */
+export interface ISheetCollection extends ICollection<ISheet> {
+    /**
+     * Add an `ISheet` to the collection.
+     */
+    add(options?: ISheetCollection.AddOptions | string | number): ISheet;
+    /**
+     * Returns sheets that match the filter criteria.
+     *
+     * If no filter criteria is provided, all sheets will be returned.
+     *
+     * @param options {@link ISheetCollection.GetItemsOptions}
+     */
+    getItems(options?: ISheetCollection.GetItemsOptions): ISheet[];
+    /**
+     * Returns the sheet at the given index.
+     * @param index
+     * @returns
+     */
+    /**
+     * Convenience method for filtering by name. This is
+     * functionally equivalent to getItems({ name });
+     *
+     * @param name The name to search for This is case insensitive.
+     */
+    getByName(name: string): ISheet | null;
+}
+/**
+ * {@inheritDoc ISheetCollection}
+ * @see
+ * ### **Interface**
+ *
+ * {@link ISheetCollection}
+ */
+export declare namespace ISheetCollection {
+    /**
+     * Options for adding a sheet to the collection.
+     */
+    interface AddOptions extends ITransaction.OperationOptions {
+        /**
+         * The name of the sheet.
+         *
+         * @defaultValue - A unique name as determined by {@link IWorkbook.ConstructorOptions.createSheetNameCallback}.
+         */
+        name?: string;
+        /**
+         * Position for the sheet.
+         *
+         * @defaultValue - At the end.
+         */
+        index?: number;
+    }
+    interface GetItemsOptions extends ICollection.GetItemsOptions {
+        /**
+         * Indicate if items that are in hidden headers or marked as hidden should be returned.
+         * @defaultValue false
+         */
+        visibility?: ISheet.Visibility;
+        /**
+         * Search with the given name. This is case insensitive.
+         */
+        name?: string;
+    }
+}
+//# sourceMappingURL=ISheetCollection.d.ts.map

package/types/src/sheet/NamedCellRange.d.ts

@@ -0,0 +1,45 @@
+import { ICellRanges } from '../cellRange';
+import { _NamedGraphNode } from '../cellRange/_GraphNode';
+import { NamedRange } from './NamedRange';
+import { ISheetInternal } from './Sheet';
+import { SheetRangeOptions } from './SheetRange';
+/**
+ * A defined name as a NODE in the calculation graph — an `INamedRange` whose coords are the
+ * name's ANCHOR (its defining cell), not a target.
+ *
+ * @remarks
+ * This is how a name rides inside an ordinary `ICellRanges` graph answer next to plain cell
+ * ranges: the brand (`isINamedRange`) carries the identity, the coords carry the anchor, and the
+ * four graph methods answer the NAME question rather than the cell question at those coords
+ * (DESIGN-NAMED-FORMULAS.md §4). Contrast {@link NamedRange}, which `getRange('Revenue')` returns
+ * over the name's *target* — same brand, different referent, and only this one exists for a value
+ * name (`Doubled = Base*2`), which has no target at all.
+ *
+ * The anchor matters to precedents (relative references in the body resolve from it) and is only
+ * a label for dependents (the symbol index is global). Lead with the name when displaying one —
+ * two names authored from the same active cell share an anchor address, and the name is the fact.
+ */
+export declare class NamedCellRange extends NamedRange {
+    private readonly _node;
+    constructor(node: _NamedGraphNode, internal: ISheetInternal, options: SheetRangeOptions | null);
+    /**
+     * {@inheritDoc INamedRange.getRanges}
+     *
+     * @remarks
+     * Delegates to the name's own `getRanges`, so a union refers-to (`$A$1:$B$2,$D$3:$E$4`) comes
+     * back whole — the one answer this node's single-cell anchor coords cannot carry — and a value
+     * name answers `null`. Overrides {@link NamedRange.getRanges}, whose own-coords answer would be
+     * the ANCHOR here, which designates nothing.
+     */
+    getRanges(): ICellRanges | null;
+    /** {@inheritDoc ICellRange.getDirectPrecedents} */
+    getDirectPrecedents(): ICellRanges | null;
+    /** {@inheritDoc ICellRange.getPrecedents} */
+    getPrecedents(): ICellRanges | null;
+    /** {@inheritDoc ICellRange.getDirectDependents} */
+    getDirectDependents(): ICellRanges | null;
+    /** {@inheritDoc ICellRange.getDependents} */
+    getDependents(): ICellRanges | null;
+    get [Symbol.toStringTag](): string;
+}
+//# sourceMappingURL=NamedCellRange.d.ts.map

package/types/src/sheet/NamedRange.d.ts

@@ -0,0 +1,30 @@
+import { IRange } from '@sheetxl/primitives';
+import { INamedRange, ICellRanges } from '../cellRange';
+import { SheetRange, SheetRangeOptions } from './SheetRange';
+import { ISheetInternal } from './Sheet';
+export declare class NamedRange extends SheetRange implements INamedRange {
+    readonly isINamedRange: true;
+    private _id;
+    private _name;
+    /** The name's OWN extent resolver — see {@link getRanges}. */
+    private _rangesResolver;
+    constructor(id: string, name: string, coords: IRange.FixableCoords, internal: ISheetInternal, options: SheetRangeOptions, getRanges?: (() => ICellRanges | null) | null);
+    /** {@inheritDoc INamedRange.getId} */
+    getId(): string;
+    /** {@inheritDoc INamedRange.getName} */
+    getName(): string;
+    /**
+     * {@inheritDoc INamedRange.getRanges}
+     *
+     * @remarks
+     * The name's own answer wherever the construction site could supply it — load-bearing, because
+     * this range's coords may be only the FIRST area of a union (`_SheetCoords.createRange` resolves
+     * a named reference through `getReferences()?.at(0)`), and a value name's are a fallback with no
+     * designation at all. Only a construction site with no name in hand (none in the tree today)
+     * gets the single-member answer over these coords.
+     */
+    getRanges(): ICellRanges | null;
+    toString(): string;
+    get [Symbol.toStringTag](): string;
+}
+//# sourceMappingURL=NamedRange.d.ts.map