@omegagrid/grid-core 0.10.2 → 0.10.5

package/dist/model/gridModel.d.ts

@@ -0,0 +1,181 @@
+import { Matrix, CustomProperties, Location, Model } from "@omegagrid/core";
+import { log } from "@omegagrid/core";
+import { ShiftOptions, SpillOptions, SpillResult, TabOptions } from "../types";
+import { CalculationModel } from "./calculationModel";
+import { CellRange } from "../common/range";
+import { ConditionalFormats, ConditionalFormatSource } from "./conditionalFormats";
+import { Sparklines, SparklineSource } from "../sparklines/sparklines";
+import { CellModel, CellSource } from "./cellModel";
+import { ColumnModel, ColumnHeaderModel, ColumnSource } from "./columnModel";
+import { GroupModel } from "./groupModel";
+import { CommentModel, CommentSource } from "./commentModel";
+import { IterableAxisRange, IterableRange } from "./iterableRange";
+import { NameSource, NamingModel } from "./namingModel";
+import { Options, OptionSource } from "./options";
+import { RowModel, RowSource } from "./rowModel";
+import { Style } from "./style";
+import { StyleModel } from "./styleModel";
+import { TableTheme } from "./tableTheme";
+import { SortingModel } from "./sortingModel";
+import { Merge, Merges } from "./merges";
+import { FilterModel } from "./filterModel";
+/** Source object type for grid */
+export type GridSource = {
+    /** grid index with group (readonly) */
+    index?: number;
+    /** sheet name */
+    name?: string;
+    /** row array */
+    rows?: RowSource[];
+    /** column array */
+    columns?: ColumnSource[];
+    /** cell array */
+    cells?: CellSource[];
+    /** grid options */
+    options?: OptionSource;
+    /** sprakline definitions */
+    sparklines?: SparklineSource[];
+    /** conditional format definitions */
+    rules?: ConditionalFormatSource;
+    /** comment array */
+    comments?: CommentSource[];
+    /** style array */
+    styles?: Style[];
+    /** renge names */
+    names?: NameSource[];
+    /** custom properties */
+    props?: CustomProperties;
+    /** tab settings used when grid is within group */
+    tab?: TabOptions;
+    /** table theme */
+    theme?: TableTheme;
+    /** additional properties */
+    [key: string]: unknown;
+};
+export type Viewport = {
+    rows: RowModel[];
+    columns: ColumnModel[];
+};
+export declare class GridModel implements Model<GridSource> {
+    index: number;
+    name: string;
+    tab: TabOptions;
+    rows: RowModel[];
+    visibleRows: RowModel[];
+    rowRoot: RowModel;
+    colRoot: ColumnModel;
+    columns: ColumnModel[];
+    visibleColumns: ColumnModel[];
+    visibleColumnIndex: Record<number, number>;
+    otherSourceData: Record<string, unknown>;
+    otherModels: Record<string, Set<Model>>;
+    autofitColumns: Set<number>;
+    autofitRows: Set<number>;
+    readonly merges: Merges;
+    readonly styles: StyleModel;
+    readonly comments: CommentModel;
+    readonly calculations: CalculationModel;
+    readonly names: NamingModel;
+    readonly sorting: SortingModel;
+    readonly filter: FilterModel;
+    readonly sparklines: Sparklines;
+    readonly conditionalFormats: ConditionalFormats;
+    private _mergedHeaders;
+    get mergedHeaders(): (Merge & {
+        h: ColumnHeaderModel;
+    })[];
+    private _filter;
+    get hasFilter(): boolean;
+    private _maxRowLevel;
+    get hasRowTree(): boolean;
+    get hasRowTreeEnabled(): boolean;
+    get maxRowLevel(): number;
+    private _maxColumnLevel;
+    get hasColumnTree(): boolean;
+    get hasColumnTreeEnabled(): boolean;
+    get maxColumnLevel(): number;
+    private _headerCount;
+    private _headerHeights;
+    get headerCount(): number;
+    get columnHeaderCount(): number;
+    private _viewport;
+    private _levelBasedRowTree;
+    private _levelBasedColTree;
+    protected _properties: CustomProperties;
+    get properties(): CustomProperties;
+    set properties(v: CustomProperties);
+    protected _theme: TableTheme;
+    get theme(): TableTheme;
+    set theme(v: TableTheme);
+    readonly logger: log.Logger;
+    options: Options;
+    group: GroupModel;
+    constructor(source: GridSource, options?: Options, logger?: log.Logger);
+    getConnectedModel(name: string): GridModel;
+    getModelByRange(range: CellRange): GridModel;
+    getCellByA1(a1: string): CellModel;
+    getCellByRange(r: CellRange): CellModel;
+    getCellByCoords(r: number, c: number): CellModel;
+    cell(coord1: string | number | CellRange, coord2?: number): CellModel;
+    createRows(source: RowSource[], root?: RowModel, indexOffset?: number): [RowModel, RowModel[], number, boolean];
+    insertRowData(parent: RowModel, offset: number, source: RowSource[]): void;
+    applyTheme(theme: TableTheme, invalidateCellStyles?: boolean): void;
+    populate(source: GridSource): void;
+    getSourceData(): GridSource;
+    calcHeaderHeights(): void;
+    indexRows(): void;
+    indexVisibleRows(): void;
+    indexRowsByTree(): void;
+    indexColumns(): void;
+    indexVisibleColumns(): void;
+    indexHeaders(): void;
+    removeHeader(r: number): void;
+    clearRows: () => RowModel[];
+    clearColumns: () => ColumnModel[];
+    clear(): void;
+    resetViewport(): this;
+    getViewport(offset: {
+        c: number;
+        r: number;
+    }, viewportSize: {
+        w: number;
+        h: number;
+    }, freeze: {
+        t: number;
+        l: number;
+        b: number;
+        r: number;
+    }): Viewport;
+    calculateViewport(): CellModel[];
+    getValuesInRange(range: CellRange, formattedValues?: boolean): Matrix<unknown>;
+    setRowExpandLevel(level: number): void;
+    setColumnExpandLevel(level: number): void;
+    getViewportRange(): CellRange;
+    get gridRange(): CellRange;
+    getRangeIterator(range: CellRange, withinViewport?: boolean): IterableRange;
+    getInitializedCellIterator(): IterableRange;
+    getRowIterator(range: CellRange, withinViewport?: boolean): IterableAxisRange<RowModel>;
+    getColumnIterator(range: CellRange, withinViewport?: boolean): IterableAxisRange<ColumnModel>;
+    getCellArray(range: CellRange): CellModel[];
+    transformRangeToMatrix<T>(range: CellRange, transform: (cell: CellModel) => T): Matrix<T>;
+    getCellMatrix(range: CellRange): Matrix<CellModel>;
+    getValueMatrix(range: CellRange): Matrix<unknown>;
+    shift(options: ShiftOptions): void;
+    clearCalculations(all?: boolean): void;
+    refreshSparklines(): void;
+    clearCalculatedStyles(): void;
+    insertColumns(index: number, count: number, after?: boolean): ColumnModel[];
+    deleteColumns(index: number, count: number): ColumnModel[];
+    insertRows(index: number, rows: number | RowModel[], after?: boolean): RowModel[];
+    deleteRows(index: number, count: number): RowModel[];
+    moveRows(index: number, count: number, targetIndex: number): RowModel[];
+    moveColumns(index: number, count: number, targetIndex: number): ColumnModel[];
+    spillValues(opt: SpillOptions): SpillResult;
+    getCellByName(name: string, contextRange: CellRange, searchGroup?: boolean): CellModel;
+    getRangeByName(name: string, searchGroup?: boolean): CellRange;
+    getValueMatrixByName(name: string, searchGroup?: boolean): Matrix<unknown>;
+    rebuildRowTree(): void;
+    rebuildColumnTree(): void;
+    calculateCellOffset(cell: CellRange): Location;
+}
+//# sourceMappingURL=gridModel.d.ts.map

package/dist/model/gridModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gridModel.d.ts","sourceRoot":"","sources":["../../src/model/gridModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAQ,gBAAgB,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAClF,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAiB,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC9F,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,WAAW,EAAG,iBAAiB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAe,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAA6C,MAAM,cAAc,CAAC;AACrF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,kCAAkC;AAClC,MAAM,MAAM,UAAU,GAAG;IACxB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB;IAChB,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB,mBAAmB;IACnB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,iBAAiB;IACjB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;IACrB,mBAAmB;IACnB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,qCAAqC;IACrC,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,oBAAoB;IACpB,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,kBAAkB;IAClB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,kBAAkB;IAClB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;IACrB,wBAAwB;IACxB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,kDAAkD;IAClD,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,kBAAkB;IAClB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,4BAA4B;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACtB,CAAC;AAOF,MAAM,MAAM,QAAQ,GAAG;IACtB,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,OAAO,EAAE,WAAW,EAAE,CAAC;CACvB,CAAC;AAEF,qBAAa,SAAU,YAAW,KAAK,CAAC,UAAU,CAAC;IAElD,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,UAAU,CAAC;IAChB,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,WAAW,EAAE,QAAQ,EAAE,CAAC;IACxB,OAAO,EAAE,QAAQ,CAAC;IAClB,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,cAAc,EAAE,WAAW,EAAE,CAAC;IAC9B,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAM;IAC7C,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAa;IACxC,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAa;IAErC,QAAQ,CAAC,MAAM,SAAoB;IACnC,QAAQ,CAAC,MAAM,aAAwB;IACvC,QAAQ,CAAC,QAAQ,eAA0B;IAC3C,QAAQ,CAAC,YAAY,mBAA8B;IACnD,QAAQ,CAAC,KAAK,cAAyB;IACvC,QAAQ,CAAC,OAAO,eAA0B;IAC1C,QAAQ,CAAC,MAAM,cAAyB;IACxC,QAAQ,CAAC,UAAU,aAAwB;IAC3C,QAAQ,CAAC,kBAAkB,qBAAgC;IAE3D,OAAO,CAAC,cAAc,CAAqC;IAC3D,IAAI,aAAa;WADoB,iBAAiB;SACJ;IAElD,OAAO,CAAC,OAAO,CAAQ;IACvB,IAAI,SAAS,YAA0B;IAEvC,OAAO,CAAC,YAAY,CAAK;IACzB,IAAI,UAAU,YAAmC;IACjD,IAAI,iBAAiB,YAA6D;IAClF,IAAI,WAAW,WAA+B;IAE9C,OAAO,CAAC,eAAe,CAAK;IAC5B,IAAI,aAAa,YAAsC;IACvD,IAAI,oBAAoB,YAAmE;IAC3F,IAAI,cAAc,WAAkC;IAEpD,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,cAAc,CAAW;IACjC,IAAI,WAAW,WAA+B;IAC9C,IAAI,iBAAiB,WAA+F;IAEpH,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,kBAAkB,CAAQ;IAClC,OAAO,CAAC,kBAAkB,CAAQ;IAElC,SAAS,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACxC,IAAI,UAAU,IACI,gBAAgB,CADU;IAC5C,IAAI,UAAU,CAAC,CAAC,EAAE,gBAAgB,EAA0B;IAE5D,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC;IAC7B,IAAI,KAAK,IACI,UAAU,CADW;IAClC,IAAI,KAAK,CAAC,CAAC,EAAE,UAAU,EAAqB;IAE5C,SAAgB,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,UAAU,CAAC;gBAEb,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM;IAMtE,iBAAiB,CAAC,IAAI,EAAE,MAAM;IAI9B,eAAe,CAAC,KAAK,EAAE,SAAS;IAIhC,WAAW,CAAC,EAAE,EAAE,MAAM;IAItB,cAAc,CAAC,CAAC,EAAE,SAAS;IAI3B,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;IAIpC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAC,MAAM,GAAC,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM;IAOrD,UAAU,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,IAAI,WAA8B,EAAE,WAAW,SAAI,GAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC;IA2B9H,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE;IAYnE,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,oBAAoB,CAAC,EAAE,OAAO;IAS5D,QAAQ,CAAC,MAAM,EAAE,UAAU;IAmI3B,aAAa;IA+Cb,iBAAiB;IAkBjB,SAAS;IAYT,gBAAgB;IAgChB,eAAe;IAWf,YAAY;IAQZ,mBAAmB;IA0BnB,YAAY;IA6BZ,YAAY,CAAC,CAAC,EAAE,MAAM;IAOtB,SAAS,QAAQ,QAAQ,EAAE,CAI1B;IAED,YAAY,QAAQ,WAAW,EAAE,CAAsB;IAEvD,KAAK;IAML,aAAa;IAKb,WAAW,CACV,MAAM,EAAE;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAC,EAC9B,YAAY,EAAE;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAC,EACpC,MAAM,EAAE;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAC,GACjD,QAAQ;IAkEZ,iBAAiB;IAIjB,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,eAAe,UAAQ;IAoB1D,iBAAiB,CAAC,KAAK,EAAE,MAAM;IAQ/B,oBAAoB,CAAC,KAAK,EAAE,MAAM;IAKlC,gBAAgB;IAShB,IAAI,SAAS,cAEZ;IAED,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,cAAc,UAAQ;IAOzD,0BAA0B;IAI1B,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,cAAc,UAAQ;IAOvD,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,cAAc,UAAQ;IAO1D,YAAY,CAAC,KAAK,EAAE,SAAS;IAQ7B,sBAAsB,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAiBzF,aAAa,CAAC,KAAK,EAAE,SAAS;IAI9B,cAAc,CAAC,KAAK,EAAE,SAAS;IAI/B,KAAK,CAAC,OAAO,EAAE,YAAY;IAS3B,iBAAiB,CAAC,GAAG,UAAQ;IAK7B,iBAAiB;IAOjB,qBAAqB;IASrB,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,UAAQ;IAazD,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAe1C,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAC,QAAQ,EAAE,EAAE,KAAK,UAAQ;IAkBhE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAUvC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAS1D,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAS7D,WAAW,CAAC,GAAG,EAAE,YAAY,GAAG,WAAW;IA8C3C,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,UAAO,GAAG,SAAS;IAOnF,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,UAAO,GAAG,SAAS;IAO3D,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,UAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAOvE,cAAc;IAQd,iBAAiB;IAQjB,mBAAmB,CAAC,IAAI,EAAE,SAAS,GAAI,QAAQ;CAa/C"}