@sheetxl/sdk 0.7.27 → 0.7.28-beta.1

package/types/src/table/AnchoredTable.d.ts

@@ -0,0 +1,349 @@
+import { IRange, Scalar } from '@sheetxl/primitives';
+import { ReferenceableClipboard } from '@sheetxl/utils';
+import { IProperties } from '../type';
+import { IListener } from '../listener';
+import { ITransaction } from '../transaction';
+import { ICellRange } from '../cellRange';
+import { IStyle, IStyleCollection } from '../style';
+import { IAnchored } from '../anchored';
+import { INamedCollection, INamed } from '../named';
+import { ISheet } from '../sheet';
+import { ISort } from '../sort';
+import { ICondition } from '../condition';
+import { IFilter } from '../filter';
+import { AbstractAnchored } from '../anchored/AbstractAnchored';
+import { Anchored } from '../anchored/Anchored';
+import { ColumnPropertiesState, SortPropertiesState, FilterPropertiesState } from './_TableUtils';
+import { ITableStyle } from './ITableStyle';
+import { ITable } from './ITable';
+/**
+ * Implementation of {@link ITable}.
+ */
+export declare class AnchoredTable extends AbstractAnchored<State, CommitView, ITable.Events> implements ITable {
+    protected _sheet: ISheet | undefined;
+    private _styles;
+    private _stylesRemoveListener;
+    private _columnListener;
+    private _lastTransactionId;
+    private _emptyColumnName;
+    private _emptyColumnNamer;
+    private _autoExpandRemoveListener;
+    private _styleCache;
+    private _stylePropsCache;
+    private _processTableUpdate;
+    private _setContainerName;
+    private _names;
+    private _namedItem;
+    private _colHeadersSizeUnlistener;
+    private _rowHeadersSizeUnlistener;
+    private _visibleRange;
+    private _isHeaderVisible;
+    private _isTotalVisible;
+    private _isFirstColumnVisible;
+    private _isLastColumnVisible;
+    private _createColumn;
+    private _createSort;
+    private _createFilter;
+    constructor(options: AnchoredTable.ConstructorOptions);
+    protected _initializeOptions(options: AnchoredTable.ConstructorOptions): AnchoredTable.ConstructorOptions;
+    protected initializeColumnCreator(table: ITable, getProps: (id: number | string) => ColumnPropertiesState, updateProps: (id: number | string, update: Partial<ITable.ColumnProperties> | null, options?: string | ITransaction.OperationOptions) => void, deleteColumn: (id: number | string, options?: ITransaction.OperationOptions) => void): (id: number | string) => ITable.IColumn;
+    protected initializeSortCreator(table: ITable, getProps: (id: number | string) => SortPropertiesState, getColumnProps: (id: number | string) => ColumnPropertiesState): (id: number | string) => ISort;
+    protected initializeFilterCreator(table: ITable, getProps: (id: number | string) => FilterPropertiesState, getColumnProps: (id: number | string) => ColumnPropertiesState): (id: number | string) => IFilter;
+    protected _initialize(options: AnchoredTable.ConstructorOptions): void;
+    /** {@inheritDoc ITable.getNamed} */
+    getNamed(): INamed | null;
+    /**
+     * Recompute the derived visible state (`_visibleRange` and the visible flags), which depend on
+     * the sheet's hidden rows/columns.
+     *
+     * @remarks
+     * Callers of the visible getters recompute on read via this method rather than relying on the
+     * header `onSizesChange` listener alone. That listener fires order-dependently relative to the
+     * render: the sheet's transactional layout listener runs (and can drive a cell read) before this
+     * table's non-transactional listener updates the value, so a purely event-driven value can be
+     * read stale mid-transaction. The underlying header lookups are already current at read time, so
+     * recomputing here is always correct. It is cheap - a couple of trivial lookups when nothing is
+     * hidden.
+     */
+    protected _ensureVisible(): void;
+    /**
+     * Used the hidden headers to determine if various style parts are hidden.
+     *
+     * 1. Uses hidden columns/rows
+     * 2. Uses hidden flags or header/footer
+     * 3. DOES not use viewport
+     */
+    protected _calcVisible(): void;
+    /** {@inheritDoc ITable.getSnapshot} */
+    getSnapshot(options?: ReferenceableClipboard.CopyOptions): ITable.ISnapshot;
+    /** {@inheritDoc ITable.getAnchorType} */
+    getAnchorType(): IAnchored.Type;
+    /** {@inheritDoc ITable.getStyle} */
+    getStyle(): ITableStyle;
+    /** {@inheritDoc ITable.addRow} */
+    addRow(index?: number, options?: ITransaction.OperationOptions): this;
+    protected _ensureHeightForHeaderTotals(originalAnchorCoords: IRange.Coords, originalHeaderRowCount: number, originalTotalsRowCount: number, headerRowCount?: number, totalsRowCount?: number): boolean;
+    /** {@inheritDoc ITable.addRows} */
+    addRows(index: number, count?: number, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.deleteRowsAt} */
+    deleteRowsAt(index: number, count?: number, options?: ITransaction.OperationOptions): this;
+    protected _deleteColumn(id: number | string, options?: ITransaction.OperationOptions): void;
+    /** {@inheritDoc ITable.addColumn} */
+    addColumn(index?: number, values?: Scalar[], name?: string, options?: ITransaction.OperationOptions): ITable.IColumn;
+    /** {@inheritDoc ITable.getColumns} */
+    getColumns(): readonly ITable.IColumn[];
+    /** {@inheritDoc ITable.getColumns} */
+    getColumn(key: string): ITable.IColumn | null;
+    /** {@inheritDoc ITable.getColumns} */
+    getColumnById(id: string): ITable.IColumn | null;
+    /** {@inheritDoc ITable.getColumns} */
+    getColumnByName(name: string): ITable.IColumn | null;
+    /** {@inheritDoc ITable.convertToRange} */
+    convertToRange(maxCells?: number, options?: ITransaction.OperationOptions): ICellRange;
+    /** {@inheritDoc ITable.resizeTo} */
+    resizeTo(rowCount: number, colCount: number, options?: ITransaction.OperationOptions): ICellRange;
+    /** {@inheritDoc ITable.resize} */
+    resize(address: ICellRange.Address, options?: ITransaction.OperationOptions): ICellRange;
+    protected _resize(address: ICellRange.Address, options?: ITransaction.OperationOptions, description?: string): ICellRange;
+    /** {@inheritDoc ITable.getName} */
+    getName(): string;
+    /** {@inheritDoc ITable.setName} */
+    setName(name: string, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.getDescription} */
+    getDescription(): string;
+    /** {@inheritDoc ITable.setDescription} */
+    setDescription(description: string, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.select} */
+    select(options?: ICellRange.SelectOptions): Promise<ICellRange>;
+    /** @internal */
+    protected _processRestoreOrRevert(state: State, view: CommitView, commit: ITransaction.ICommit): void;
+    /** @internal */
+    protected _processAnchorCoords(): void;
+    /** @internal */
+    protected _processAfterContainerShift(before: IRange.Coords[], after: IRange.Coords[]): void;
+    /** {@inheritDoc ITable.getDataRange} */
+    getDataRange(): ICellRange;
+    private _getUsedCoords;
+    /** {@inheritDoc ITable.getHeaderRowRange} */
+    getHeaderRowRange(): ICellRange;
+    private _getHeaderCoords;
+    /** {@inheritDoc ITable.getTotalRowRange} */
+    getTotalRowRange(): ICellRange;
+    private _getTotalCoords;
+    /** {@inheritDoc ITable.getStyleOptions} */
+    getStyleOptions(): ITableStyle.StyleOptions;
+    /** {@inheritDoc ITable.updateStyleOptions} */
+    updateStyleOptions(options: ITableStyle.StyleOptions, description?: string): this;
+    /** {@inheritDoc ITable.getRangedStyle} */
+    getRangedStyle(): IProperties.ICellRanged<IStyle.Properties>;
+    /** {@inheritDoc ITable.getStyleAt} */
+    getStyleAt(coords: IRange.CellCoords): IStyle;
+    /** {@inheritDoc ITable.isShowTotals} */
+    isShowTotals(): boolean;
+    /** {@inheritDoc ITable.setShowTotals} */
+    setShowTotals(showTotals: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.isShowHeaders} */
+    isShowHeaders(): boolean;
+    /** {@inheritDoc ITable.setShowHeaders} */
+    setShowHeaders(showHeaders: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.isShowHighlightFirstColumn} */
+    isShowHighlightFirstColumn(): boolean;
+    /** {@inheritDoc ITable.setShowHighlightFirstColumn} */
+    setShowHighlightFirstColumn(showHighlightFirstColumn: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.isShowHighlightLastColumn} */
+    isShowHighlightLastColumn(): boolean;
+    /** {@inheritDoc ITable.setShowHighlightLastColumn} */
+    setShowHighlightLastColumn(showHighlightLastColumn: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.isShowBandedColumns} */
+    isShowBandedColumns(): boolean;
+    /** {@inheritDoc ITable.setShowBandedColumns} */
+    setShowBandedColumns(showBandedColumns: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.isShowBandedRows} */
+    isShowBandedRows(): boolean;
+    /** {@inheritDoc ITable.setShowBandedRows} */
+    setShowBandedRows(showBandedRows: boolean, options?: ITransaction.OperationOptions): this;
+    protected _setupAutoExpand(): void;
+    /** {@inheritDoc ITable.setDisabledAutoExpand} */
+    setDisabledAutoExpand(disabledAutoSize: boolean, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.isDisabledAutoExpand} */
+    isDisabledAutoExpand(): boolean;
+    /** {@inheritDoc ITable.applyFilters} */
+    applyFilters(options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.deleteFilters} */
+    deleteFilters(options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.getActiveFilters} */
+    getActiveFilters(): readonly IFilter[];
+    /** {@inheritDoc ITable.getFilterAt} */
+    getFilterAt(index: number): IFilter | null;
+    protected _updateSorts(sorts: ISort.Options[] | undefined, originalSorts: readonly ISort[], orderedColumnsProps: ColumnPropertiesState[], mapColumnPropsById: Map<string | number, ColumnPropertiesState>): readonly ISort[];
+    protected _updateFilters(conditions: ICondition.Input[] | undefined, originalFilters: readonly IFilter[], orderedColumnsProps: ColumnPropertiesState[], mapColumnPropsById: Map<string | number, ColumnPropertiesState>): readonly IFilter[];
+    /** {@inheritDoc ITable.filter} */
+    /**
+     * Perform filtering on the table.
+     */
+    filter(conditions?: ICondition.Input | ICondition.RangeOptions, options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.sort} */
+    sort(options?: ISort.RangeOptions & ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.applySorts} */
+    applySorts(options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.deleteSorts} */
+    deleteSorts(options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.applySortsAndFilters} */
+    applySortsAndFilters(options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.deleteSortsAndFilters} */
+    deleteSortsAndFilters(options?: ITransaction.OperationOptions): this;
+    /** {@inheritDoc ITable.getActiveSorts} */
+    getActiveSorts(): readonly ISort[];
+    /** {@inheritDoc ITable.getSortAt} */
+    getSortAt(index: number): ISort | null;
+    /** {@inheritDoc ITable.setHiddenButtonAt} */
+    setHiddenButtonAt(index: number, hidden: boolean): this;
+    /** {@inheritDoc ITable.isHiddenButtonAt} */
+    isHiddenButtonAt(index: number): boolean;
+    /** {@inheritDoc ITable.setHiddenButtons} */
+    setHiddenButtons(hidden: boolean): this;
+    /** {@inheritDoc ITable.isHiddenButtons} */
+    isHiddenButtons(): boolean;
+    /** @internal */
+    private _applyFilters;
+    /** @internal */
+    private _applySorts;
+    /** {@inheritDoc ITable.getColumnAt} */
+    getColumnAt(index: number): ITable.IColumn | null;
+    /**
+     * Updates internal column state.
+     * - Note validating of unique names
+     * 1. index ordering
+     * 2. create or reused new Ids
+     *
+     * @remarks
+     * Mutates columnPropsNews to ensure index is correct.
+     *
+     * @internal
+     */
+    protected _updateColumnsState(columnPropsNews: Partial<ColumnPropertiesState>[], options?: string | ITransaction.OperationOptions): ITable.IColumn[];
+    /** {@inheritDoc ITable.getVisibleRefRangeCoords} */
+    getVisibleRefRangeCoords(): IRange.Coords;
+    /** {@inheritDoc ITable.getVisibleCellCoords} */
+    getVisibleCellCoords(coords: IRange.CellCoords): IRange.CellCoords;
+    /** {@inheritDoc ITable.isHeaderVisible} */
+    isHeaderVisible(): boolean;
+    /** {@inheritDoc ITable.isTotalVisible} */
+    isTotalVisible(): boolean;
+    /** {@inheritDoc ITable.isFirstColumnVisible} */
+    isFirstColumnVisible(): boolean;
+    /** {@inheritDoc ITable.isLastColumnVisible} */
+    isLastColumnVisible(): boolean;
+    /**
+     * Builds columns from state and sheet (if available).
+     *
+     * @remarks
+     * The `converted` is true if the sheet is out of sync from the state.columns.
+     *
+     * @internal
+     */
+    protected _readSyncSheet(ignoreBlanks?: boolean, ignoreTotal?: boolean): {
+        columns: ITable.ColumnProperties[];
+        converted: boolean;
+    } | null;
+    /**
+     * This takes a list of columns headers and then validates them
+     * and if there is a sheet it will set the values back into the sheet.
+     *
+     * 1. They must be unique. (case insensitive)
+     * 2. They can't be blank.
+     * 3. They must be text
+     *
+     * @param isRemove If true we are removing so we don't update the sheet.
+     * @internal
+     */
+    protected _writeSyncSheet(isRemove?: boolean): void;
+    /** @internal */
+    protected _processDelete(): void;
+    /** @internal */
+    protected _processFilterUpdate(): void;
+    /** @internal */
+    protected _processContainerShift(options: Anchored.ShiftOptions): IRange.Coords | null | void;
+    protected _beginCommit(options?: string | ITransaction.OperationOptions): ITransaction;
+    private _modifyTable;
+    /** {@inheritDoc IListener.ISource.addListeners} */
+    addListeners(listeners: ITable.IListeners, options?: IListener.Options): IListener.Remove;
+    /** @internal */
+    protected _processAfterStateChange(state: State, view: CommitView, commit: ITransaction.ICommit): void;
+    /** @internal */
+    protected _processHeaderListener(): void;
+    /** @internal */
+    protected _processTotalsListener(): void;
+    get [Symbol.toStringTag](): string;
+    /** {@inheritDoc ICellRanges.toString} */
+    toString(): string;
+    /** {@inheritDoc ITable.toJSON} */
+    toJSON(): ITable.JSON | null;
+    /** {@inheritDoc ITable.getSheet} */
+    getSheet(): ISheet | null;
+    /** @internal */
+    private _createNamed;
+    private _fromJSON;
+    /** {@inheritDoc ITable.close} */
+    close(): void;
+    /** {@inheritDoc ITable.isITable} */
+    get isITable(): true;
+}
+/**
+ * Tables are designed to be instantiated as both standalone and anchored items that represent a table of data on a sheet.
+ */
+export declare namespace AnchoredTable {
+    interface ConstructorOptions extends Anchored.ConstructorOptions {
+        /**
+         * The sheet the table is anchored to.
+         */
+        sheet?: ISheet;
+        /**
+         * Required if there is no sheet. For example when showing table Preview.
+         */
+        styles?: IStyleCollection;
+        /**
+         * If provided then the table will add/remove itself to/from the collection.
+         */
+        names?: INamedCollection | null;
+        /**
+         * JSON state to load.
+         */
+        json?: ITable.JSON;
+        /**
+         * If this is true then this will sync header and footers if they are visible on load.
+         */
+        syncSheet?: boolean;
+        processTableUpdate?: () => void;
+    }
+}
+/** @internal */
+interface State extends AbstractAnchored.State {
+    /** Single rectangle — this type is never anchored to more than one range. */
+    anchorCoords: IRange.Coords;
+    name: string;
+    description: string;
+    headerRowCount: number;
+    totalsRowCount: number;
+    style: ITableStyle.StyleOptions;
+    disabledAutoExpand: boolean;
+    mapColumnById: Map<string | number, ITable.IColumn>;
+    mapColumnByIndex: Map<number, ITable.IColumn>;
+    mapColumnByName: Map<string, ITable.IColumn>;
+    orderedColumns: readonly ITable.IColumn[];
+    mapColumnPropsById: Map<string | number, ColumnPropertiesState>;
+    orderedColumnsProps: readonly ColumnPropertiesState[];
+    sortsActive: readonly ISort[];
+    filtersActive: readonly IFilter[];
+    hiddenButtons: boolean;
+    mapHiddenButtons: Map<number, boolean>;
+    headerRemoveListener: IListener.Remove | null;
+    totalsRemoveListener: IListener.Remove | null;
+    lastColId: number;
+    shownTotalsRow: boolean;
+}
+/** @internal */
+interface CommitView extends AbstractAnchored.CommitView {
+}
+export {};
+//# sourceMappingURL=AnchoredTable.d.ts.map

package/types/src/table/AutoTable.d.ts

@@ -0,0 +1,64 @@
+import { Scalar } from '@sheetxl/primitives';
+import { ICellRange } from '../cellRange';
+import { ITransaction } from '../transaction';
+import { Anchored } from '../anchored/Anchored';
+import { ColumnPropertiesState } from './_TableUtils';
+import { ITableStyle } from './ITableStyle';
+import { ITable } from './ITable';
+import { AnchoredTable } from './AnchoredTable';
+/**
+ * A special ITable that is created just for filter and sorting.
+ *
+ * It is used by:
+ * - `ISheet.addAutoTable()` "AutoTable" (Excel AutoFilter region).
+ * - ITable (named tables with column metadata, styles, etc).
+ *
+ * A sheet-level AutoTable is similar to ITable but does not have:
+ * - Column Names
+ * - Table Name (Structured References)
+ * - Table Styles
+ * - Table Headers / Footers
+ * and is limited to:
+ * - Only 1 AutoTable per sheet.
+ *
+ * It does have:
+ * - Filter State
+ * - Sort State
+ */
+export declare class AutoTable extends AnchoredTable {
+    protected _initialize(options: AnchoredTable.ConstructorOptions): void;
+    protected initializeColumnCreator(table: ITable, getProps: (id: number | string) => ColumnPropertiesState, updateProps: (id: number | string, update: Partial<ITable.ColumnProperties> | null, options?: string | ITransaction.OperationOptions) => void, deleteColumn: (id: number | string, options?: ITransaction.OperationOptions) => void): (id: number | string) => ITable.IColumn;
+    protected _processHeaderListener(): void;
+    protected _readSyncSheet(ignoreBlanks?: boolean): {
+        columns: ITable.ColumnProperties[];
+        converted: boolean;
+    } | null;
+    protected _writeSyncSheet(isRemove?: boolean): void;
+    protected _calcVisible(): void;
+    isShowHeaders(): boolean;
+    addRows(index: number, count?: number, options?: ITransaction.OperationOptions): this;
+    addColumn(index?: number, values?: Scalar[], name?: string, options?: ITransaction.OperationOptions): ITable.IColumn;
+    deleteRowsAt(index: number, count?: number, options?: ITransaction.OperationOptions): this;
+    getColumnByName(name: string): ITable.IColumn | null;
+    convertToRange(maxCells?: number, options?: ITransaction.OperationOptions): ICellRange;
+    setName(name: string, options?: ITransaction.OperationOptions): this;
+    setDescription(description: string, options?: ITransaction.OperationOptions): this;
+    updateStyleOptions(options: ITableStyle.StyleOptions, description?: string): this;
+    setShowTotals(showTotals: boolean, options?: ITransaction.OperationOptions): this;
+    setShowHeaders(showHeaders: boolean, options?: ITransaction.OperationOptions): this;
+    setShowHighlightFirstColumn(showHighlightFirstColumn: boolean, options?: ITransaction.OperationOptions): this;
+    setShowHighlightLastColumn(showHighlightLastColumn: boolean, options?: ITransaction.OperationOptions): this;
+    setShowBandedColumns(showBandedColumns: boolean, options?: ITransaction.OperationOptions): this;
+    setShowBandedRows(showBandedRows: boolean, options?: ITransaction.OperationOptions): this;
+    protected _resize(address: ICellRange.Address, options?: ITransaction.OperationOptions, description?: string): ICellRange;
+    get [Symbol.toStringTag](): string;
+    /** {@inheritDoc ICellRanges.toString} */
+    toString(): string;
+    /** {@inheritDoc ITable.toJSON} */
+    toJSON(): ITable.JSON | null;
+}
+export declare namespace AutoTable {
+    interface ConstructorOptions extends Anchored.ConstructorOptions {
+    }
+}
+//# sourceMappingURL=AutoTable.d.ts.map