@deephaven/iris-grid 0.15.5 → 0.15.6-beta.0

package/dist/IrisGridModel.d.ts

@@ -210,7 +210,7 @@ declare abstract class IrisGridModel<TEventMap extends Record<string, Event<stri
      */
     get isRollupAvailable(): boolean;
     /**
-     * @return True if select distinct functionality is available
+     * @returns True if select distinct functionality is available
      */
     get isSelectDistinctAvailable(): boolean;
     /**

package/dist/IrisGridModel.js

@@ -210,7 +210,7 @@ class IrisGridModel extends GridModel {
     return false;
   }
   /**
-   * @return True if select distinct functionality is available
+   * @returns True if select distinct functionality is available
    */
 
 

package/dist/IrisGridModel.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/IrisGridModel.ts"],"names":["GridModel","IrisGridModel","constructor","listenerCount","addEventListener","type0","callback0","options0","startListening","removeEventListener","stopListening","originalColumns","columns","movedColumns","movedRows","layoutHints","frontColumns","backColumns","frozenColumns","isColumnFrozen","index","isFilterRequired","isReversible","isColumnStatisticsAvailable","description","isCustomColumnsAvailable","isFormatColumnsAvailable","isExportAvailable","isValuesTableAvailable","isChartBuilderAvailable","isRollupAvailable","isSelectDistinctAvailable","isTotalsAvailable","isFilterable","columnIndex","close","isRowMovable","Object","freeze","UPDATED","FORMATTER_UPDATED","REQUEST_FAILED","COLUMNS_CHANGED","TABLE_CHANGED","FILTERS_CHANGED","SORTS_CHANGED","DISCONNECT","RECONNECT","TOTALS_UPDATED","PENDING_DATA_UPDATED"],"mappings":";;AAAA;AAEA,SACEA,SADF,QAMO,iBANP;;AA8BA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAeC,aAAf,SAMUD,SANV,CAM8D;AAe5DE,EAAAA,WAAW,GAAG;AACZ;;AADY;;AAGZ,SAAKC,aAAL,GAAqB,CAArB;AACD;;AAID;AACA;AACA;AACAC,EAAAA,gBAAgB,CACdC,KADc,EAEdC,SAFc,EAGdC,QAHc,EAIR;AACN,UAAMH,gBAAN,CAAuBC,KAAvB,EAA8BC,SAA9B,EAAkDC,QAAlD;AAEA,SAAKJ,aAAL,IAAsB,CAAtB;;AACA,QAAI,KAAKA,aAAL,KAAuB,CAA3B,EAA8B;AAC5B,WAAKK,cAAL;AACD;AACF;;AAEDC,EAAAA,mBAAmB,CACjBJ,KADiB,EAEjBC,SAFiB,EAGjBC,QAHiB,EAIX;AACN,UAAME,mBAAN,CAA0BJ,KAA1B,EAAiCC,SAAjC,EAAqDC,QAArD;AAEA,SAAKJ,aAAL,IAAsB,CAAtB;;AACA,QAAI,KAAKA,aAAL,KAAuB,CAA3B,EAA8B;AAC5B,WAAKO,aAAL;AACD;AACF;AAED;AACF;AACA;AACA;;;AACEF,EAAAA,cAAc,GAAS,CACrB;AACD;AAED;AACF;AACA;AACA;;;AACEE,EAAAA,aAAa,GAAS,CACpB;AACD;AAED;AACF;AACA;AACA;;;AAUE;AACF;AACA;AACA;AACqB,MAAfC,eAAe,GAAa;AAC9B,WAAO,KAAKC,OAAZ;AACD;AAED;;;AACgB,MAAZC,YAAY,GAAoB;AAClC,WAAO,EAAP;AACD;AAED;;;AACa,MAATC,SAAS,GAAoB;AAC/B,WAAO,EAAP;AACD;AAED;AACF;AACA;AACA;;;AAqGE;AACF;AACA;AACiB,MAAXC,WAAW,GAAuB;AACpC,WAAO,IAAP;AACD;AAED;AACF;AACA;;;AACkB,MAAZC,YAAY,GAAiB;AAC/B,WAAO,EAAP;AACD;AAED;AACF;AACA;;;AACiB,MAAXC,WAAW,GAAiB;AAC9B,WAAO,EAAP;AACD;AAED;AACF;AACA;;;AACmB,MAAbC,aAAa,GAAiB;AAChC,WAAO,EAAP;AACD;AAED;AACF;AACA;AACA;;;AACEC,EAAAA,cAAc,CAACC,KAAD,EAA6B;AACzC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AACsB,MAAhBC,gBAAgB,GAAY;AAC9B,WAAO,KAAP;AACD;;AAEe,MAAZC,YAAY,GAAY;AAC1B,WAAO,IAAP;AACD;AAED;AACF;AACA;;;AAGE;AACF;AACA;AACiC,MAA3BC,2BAA2B,GAAY;AACzC,WAAO,KAAP;AACD;AAED;AACF;AACA;AACA;;;AACiB,MAAXC,WAAW,GAAW;AACxB,WAAO,EAAP;AACD;AAED;AACF;AACA;AACA;;;AAGE;AACF;AACA;AAC8B,MAAxBC,wBAAwB,GAAY;AACtC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AAC8B,MAAxBC,wBAAwB,GAAY;AACtC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AACuB,MAAjBC,iBAAiB,GAAY;AAC/B,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AAC4B,MAAtBC,sBAAsB,GAAY;AACpC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AAC6B,MAAvBC,uBAAuB,GAAY;AACrC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AACuB,MAAjBC,iBAAiB,GAAY;AAC/B,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AAC+B,MAAzBC,yBAAyB,GAAY;AACvC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AACuB,MAAjBC,iBAAiB,GAAY;AAC/B,WAAO,KAAP;AACD;AAED;AACF;AACA;AACA;;;AA2CE;AACF;AACA;AACA;AACA;AACEC,EAAAA,YAAY,CAACC,WAAD,EAAmC;AAC7C,WAAO,KAAP;AACD;AAED;AACF;AACA;AACA;AACA;AACA;;;AAgCE;AACF;AACA;AACEC,EAAAA,KAAK,GAAS,CACZ;AACD;AAED;AACF;AACA;;;AACEC,EAAAA,YAAY,GAAY;AACtB,WAAO,KAAP;AACD;AAED;AACF;AACA;AACA;AACA;;;AA1b8D;;gBAN/CnC,a,WAOEoC,MAAM,CAACC,MAAP,CAAc;AAC3BC,EAAAA,OAAO,EAAE,SADkB;AAE3BC,EAAAA,iBAAiB,EAAE,mBAFQ;AAG3BC,EAAAA,cAAc,EAAE,gBAHW;AAI3BC,EAAAA,eAAe,EAAE,iBAJU;AAK3BC,EAAAA,aAAa,EAAE,eALY;AAM3BC,EAAAA,eAAe,EAAE,iBANU;AAO3BC,EAAAA,aAAa,EAAE,eAPY;AAQ3BC,EAAAA,UAAU,EAAE,YARe;AAS3BC,EAAAA,SAAS,EAAE,WATgB;AAU3BC,EAAAA,cAAc,EAAE,gBAVW;AAW3BC,EAAAA,oBAAoB,EAAE;AAXK,CAAd,C;;AA6bjB,eAAehD,aAAf","sourcesContent":["/* eslint-disable class-methods-use-this */\nimport type { Event, EventTarget } from 'event-target-shim';\nimport {\n  GridModel,\n  GridRange,\n  ModelIndex,\n  MoveOperation,\n  VisibleIndex,\n} from '@deephaven/grid';\nimport type {\n  Column,\n  ColumnStatistics,\n  CustomColumn,\n  FilterCondition,\n  Format,\n  LayoutHints,\n  RollupConfig,\n  Row,\n  Sort,\n  Table,\n} from '@deephaven/jsapi-shim';\nimport { Formatter } from '@deephaven/jsapi-utils';\nimport { ColumnName, UITotalsTableConfig, PendingDataMap } from './CommonTypes';\n\ntype RowIndex = ModelIndex;\n\ntype IrisGridModelEventNames = typeof IrisGridModel.EVENT[keyof typeof IrisGridModel.EVENT];\n\ntype IrisGridModelEventMap = {\n  [E in IrisGridModelEventNames]: Event<E>;\n};\n\n/**\n * Abstract class that extends the GridModel to have more functionality, like filtering and sorting.\n * For use from IrisGrid.\n * Provides some abstraction from the dh.Table and dh.TreeTable classes, so we can treat them somewhat the same.\n * Note that it still uses dh.Column, dh.FilterCondition, dh.Sort, etc., still. Theoretically should abstract\n * those out as well, so there's no dependency on IrisAPI at all, but it's a lot of work for no real gain at this time.\n */\nabstract class IrisGridModel<\n  TEventMap extends Record<string, Event<string>> = Record<\n    string,\n    Event<string>\n  >,\n  TMode extends 'standard' | 'strict' = 'standard'\n> extends GridModel<TEventMap & IrisGridModelEventMap, TMode> {\n  static EVENT = Object.freeze({\n    UPDATED: 'UPDATED',\n    FORMATTER_UPDATED: 'FORMATTER_UPDATED',\n    REQUEST_FAILED: 'REQUEST_FAILED',\n    COLUMNS_CHANGED: 'COLUMNS_CHANGED',\n    TABLE_CHANGED: 'TABLE_CHANGED',\n    FILTERS_CHANGED: 'FILTERS_CHANGED',\n    SORTS_CHANGED: 'SORTS_CHANGED',\n    DISCONNECT: 'DISCONNECT',\n    RECONNECT: 'RECONNECT',\n    TOTALS_UPDATED: 'TOTALS_UPDATED',\n    PENDING_DATA_UPDATED: 'PENDING_DATA_UPDATED',\n  } as const);\n\n  constructor() {\n    super();\n\n    this.listenerCount = 0;\n  }\n\n  listenerCount: number;\n\n  // Pulled directly from event-target-shim implementation signature\n  // https://github.com/mysticatea/event-target-shim/blob/master/src/lib/event-target.ts#L99\n  // Using Parameters<GridModel['addEventListener']> doesn't work\n  addEventListener<T extends string & keyof TEventMap>(\n    type0: T,\n    callback0?: EventTarget.EventListener<this, TEventMap[T]> | null,\n    options0?: boolean | EventTarget.AddOptions\n  ): void {\n    super.addEventListener(type0, callback0 as never, options0 as never);\n\n    this.listenerCount += 1;\n    if (this.listenerCount === 1) {\n      this.startListening();\n    }\n  }\n\n  removeEventListener<T extends string & keyof TEventMap>(\n    type0: T,\n    callback0?: EventTarget.EventListener<this, TEventMap[T]> | null,\n    options0?: boolean | EventTarget.Options\n  ): void {\n    super.removeEventListener(type0, callback0 as never, options0 as never);\n\n    this.listenerCount -= 1;\n    if (this.listenerCount === 0) {\n      this.stopListening();\n    }\n  }\n\n  /**\n   * Function called when first listener is added.\n   * Override for implementation specific behaviour.\n   */\n  startListening(): void {\n    // no-op\n  }\n\n  /**\n   * Function called when last listener is removed.\n   * Override for implementation specific behaviour.\n   */\n  stopListening(): void {\n    // no-op\n  }\n\n  /**\n   * Gets the columns for this model\n   * @returns All columns in the model\n   */\n  abstract get columns(): Column[];\n\n  /**\n   * Gets the column index for this model\n   * @param name The model column name.\n   * @returns The numeric index of the requested column.\n   */\n  abstract getColumnIndexByName(name: string): ModelIndex | undefined;\n\n  /**\n   * Gets the columns for the model before any transformations (such as rollups) are applied.\n   * @returns All original columns in the model.\n   */\n  get originalColumns(): Column[] {\n    return this.columns;\n  }\n\n  /** List of column movements defined by the model. Used as initial movements for IrisGrid */\n  get movedColumns(): MoveOperation[] {\n    return [];\n  }\n\n  /** List of row movements defined by the model. Used as initial movements for IrisGrid */\n  get movedRows(): MoveOperation[] {\n    return [];\n  }\n\n  /**\n   * Retrieve the grouped columns for this model\n   * @returns The columns that are groupe\n   */\n  abstract get groupedColumns(): Column[];\n\n  /**\n   * @param column The model column index\n   * @param row The model row index\n   * @returns The format stored for that cell\n   */\n  abstract formatForCell(\n    column: ModelIndex,\n    row: ModelIndex\n  ): Format | undefined;\n\n  /**\n   * @param column The model column index\n   * @param row The model row index\n   * @returns The value stored for that cell\n   */\n  abstract valueForCell(column: ModelIndex, row: ModelIndex): unknown;\n\n  /**\n   * @returns The filters set on this model\n   */\n  abstract get filter(): FilterCondition[];\n\n  /**\n   * @param filter The filters to set\n   */\n  abstract set filter(filter: FilterCondition[]);\n\n  /**\n   * @returns The formatter used when formatting data\n   */\n  abstract get formatter(): Formatter;\n\n  /**\n   * @param formatter The formatter to set\n   */\n  abstract set formatter(formatter: Formatter);\n\n  /**\n   * @param value The value to format\n   * @param columnType The column type to format\n   * @param columnName The column name to format\n   */\n  abstract displayString(\n    value: unknown,\n    columnType: string,\n    columnName?: ColumnName\n  ): string;\n\n  /**\n   * @returns The sorts used on this model\n   */\n  abstract get sort(): Sort[];\n\n  /**\n   * @param sort The sorts to use on this model\n   */\n  abstract set sort(sort: Sort[]);\n\n  /**\n  /**\n   * @returns The custom columns on this model\n   */\n  abstract get customColumns(): ColumnName[];\n\n  /**\n   * @param customColumns The custom columns to use\n   */\n  abstract set customColumns(customColumns: ColumnName[]);\n\n  /**\n   * @returns The format columns on this model\n   */\n  abstract get formatColumns(): CustomColumn[];\n\n  /**\n   * @param formatColumns The format columns to use\n   */\n  abstract set formatColumns(formatColumns: CustomColumn[]);\n\n  /**\n   * @param columns The columns to treat as frozen\n   */\n  abstract updateFrozenColumns(columns: ColumnName[]): void;\n\n  /**\n   * @returns The config to use for rolling up this table\n   */\n  abstract get rollupConfig(): RollupConfig | null;\n\n  abstract set rollupConfig(rollupConfig: RollupConfig | null);\n\n  /**\n   * @returns The config to use for the totals table of this model\n   */\n  abstract get totalsConfig(): UITotalsTableConfig | null;\n\n  abstract set totalsConfig(totalsConfig: UITotalsTableConfig | null);\n\n  /**\n   * @returns The LayoutHints to use for the columns of this table model\n   */\n  get layoutHints(): LayoutHints | null {\n    return null;\n  }\n\n  /**\n   * @returns Names of columns which should be locked to the front, but not floating\n   */\n  get frontColumns(): ColumnName[] {\n    return [];\n  }\n\n  /**\n   * @returns Names of columns which should be locked to the back, but not floating\n   */\n  get backColumns(): ColumnName[] {\n    return [];\n  }\n\n  /**\n   * @returns Names of columns which should be frozen to the front and floating\n   */\n  get frozenColumns(): ColumnName[] {\n    return [];\n  }\n\n  /**\n   * @param index The column index to check\n   * @returns Whether the column is one of LayoutHints' frozen columns\n   */\n  isColumnFrozen(index: ModelIndex): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model requires a filter to be set\n   */\n  get isFilterRequired(): boolean {\n    return false;\n  }\n\n  get isReversible(): boolean {\n    return true;\n  }\n\n  /**\n   * @returns Returns a raw table that is frozen and can be used for exporting data\n   */\n  abstract export(): Promise<Table>;\n\n  /**\n   * @returns True if this model supports the columnStatistics(column) function\n   */\n  get isColumnStatisticsAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * The description for this model.\n   * @returns The description of the model\n   */\n  get description(): string {\n    return '';\n  }\n\n  /**\n   * @param column The column to get statistics for\n   * @returns The column statistics\n   */\n  abstract columnStatistics(column: Column): Promise<ColumnStatistics>;\n\n  /**\n   * @returns True if this model supports customColumns\n   */\n  get isCustomColumnsAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model supports customColumns\n   */\n  get isFormatColumnsAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model supports the export() function\n   */\n  get isExportAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model supports the valuesTable(column) function\n   */\n  get isValuesTableAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model should allow the chart builder\n   */\n  get isChartBuilderAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if the rollup rows functionality is available\n   */\n  get isRollupAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @return True if select distinct functionality is available\n   */\n  get isSelectDistinctAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if the totals functionality is available\n   */\n  get isTotalsAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * The names of columns with select distinct enabled\n   * @returns An array of column names\n   */\n  abstract get selectDistinctColumns(): ColumnName[];\n\n  /**\n   * Set the columns with select distinct enabled\n   * @param names The array of column names to enable select distinct on\n   */\n  abstract set selectDistinctColumns(names: ColumnName[]);\n\n  /**\n   * The pending data for this model\n   * @returns A map of row index to a map of column name/value pairs\n   */\n  abstract get pendingDataMap(): PendingDataMap;\n\n  /**\n   * Set the pending data for this model\n   * @param A map of row index to a map of column name/value pairs\n   */\n  abstract set pendingDataMap(map: PendingDataMap);\n\n  /**\n   * @returns The count of pending rows to show\n   */\n  abstract get pendingRowCount(): number;\n\n  /**\n   * Set the count of pending rows to show\n   * @param count The count of pending rows to show\n   */\n  abstract set pendingRowCount(count: number);\n\n  /**\n   * Errors for the pending data\n   * @returns Map from row number to the error\n   */\n  abstract get pendingDataErrors(): Map<RowIndex, Error[]>;\n\n  /**\n   * Commit pending data and save all data to the table\n   */\n  abstract commitPending(): Promise<void>;\n\n  /**\n   * Check if a column is filterable\n   * @param columnIndex The column index to check for filterability\n   * @returns True if the current provided column index is filterable, false otherwise\n   */\n  isFilterable(columnIndex: ModelIndex): boolean {\n    return false;\n  }\n\n  /**\n   * Set the indices of the viewport\n   * @param top Top of viewport\n   * @param bottom Bottom of viewport\n   * @param columns The columns in the viewport. `null` for all columns\n   */\n  abstract setViewport(\n    top: VisibleIndex,\n    bottom: VisibleIndex,\n    columns: Column[] | null\n  ): void;\n\n  /**\n   * Takes a snapshot of the provided ranges\n   * @param ranges The model ranges to take the snapshot of\n   * @returns Returns the data in a row/column matrix\n   */\n  abstract snapshot(ranges: GridRange[]): Promise<unknown[][]>;\n\n  /**\n   * @param ranges The ranges to take a snapshot of\n   * @param includeHeaders Whether to include the headers in the snapshot or not\n   * @param formatValue A function to format a value for a cell. Defaults to model format value.\n   * @returns A text formatted snapshot of the data for the specified range set\n   */\n  abstract textSnapshot(\n    ranges: GridRange[],\n    includeHeaders?: boolean,\n    formatValue?: (value: unknown, column: Column, row?: Row) => string\n  ): Promise<string>;\n\n  /**\n   * @param column The column to get the distinct values for\n   * @returns A table partitioned on the column specified\n   */\n  abstract valuesTable(column: Column): Promise<Table>;\n\n  /**\n   * Close this model. It can no longer be used after being closed\n   */\n  close(): void {\n    // no-op\n  }\n\n  /**\n   * Don't allow any rows to be movable in any IrisGrids by default. Just columns.\n   */\n  isRowMovable(): boolean {\n    return false;\n  }\n\n  /**\n   * Delete ranges from an input grid. Will delete the entire row, causing data to shift up\n   * @param ranges The ranges to delete\n   * @returns A promise that resolves successfully when the operation is complete or rejects if there's an error\n   */\n  abstract delete(ranges: GridRange[]): Promise<void>;\n}\n\nexport default IrisGridModel;\n"],"file":"IrisGridModel.js"}
+{"version":3,"sources":["../src/IrisGridModel.ts"],"names":["GridModel","IrisGridModel","constructor","listenerCount","addEventListener","type0","callback0","options0","startListening","removeEventListener","stopListening","originalColumns","columns","movedColumns","movedRows","layoutHints","frontColumns","backColumns","frozenColumns","isColumnFrozen","index","isFilterRequired","isReversible","isColumnStatisticsAvailable","description","isCustomColumnsAvailable","isFormatColumnsAvailable","isExportAvailable","isValuesTableAvailable","isChartBuilderAvailable","isRollupAvailable","isSelectDistinctAvailable","isTotalsAvailable","isFilterable","columnIndex","close","isRowMovable","Object","freeze","UPDATED","FORMATTER_UPDATED","REQUEST_FAILED","COLUMNS_CHANGED","TABLE_CHANGED","FILTERS_CHANGED","SORTS_CHANGED","DISCONNECT","RECONNECT","TOTALS_UPDATED","PENDING_DATA_UPDATED"],"mappings":";;AAAA;AAEA,SACEA,SADF,QAMO,iBANP;;AA8BA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAeC,aAAf,SAMUD,SANV,CAM8D;AAe5DE,EAAAA,WAAW,GAAG;AACZ;;AADY;;AAGZ,SAAKC,aAAL,GAAqB,CAArB;AACD;;AAID;AACA;AACA;AACAC,EAAAA,gBAAgB,CACdC,KADc,EAEdC,SAFc,EAGdC,QAHc,EAIR;AACN,UAAMH,gBAAN,CAAuBC,KAAvB,EAA8BC,SAA9B,EAAkDC,QAAlD;AAEA,SAAKJ,aAAL,IAAsB,CAAtB;;AACA,QAAI,KAAKA,aAAL,KAAuB,CAA3B,EAA8B;AAC5B,WAAKK,cAAL;AACD;AACF;;AAEDC,EAAAA,mBAAmB,CACjBJ,KADiB,EAEjBC,SAFiB,EAGjBC,QAHiB,EAIX;AACN,UAAME,mBAAN,CAA0BJ,KAA1B,EAAiCC,SAAjC,EAAqDC,QAArD;AAEA,SAAKJ,aAAL,IAAsB,CAAtB;;AACA,QAAI,KAAKA,aAAL,KAAuB,CAA3B,EAA8B;AAC5B,WAAKO,aAAL;AACD;AACF;AAED;AACF;AACA;AACA;;;AACEF,EAAAA,cAAc,GAAS,CACrB;AACD;AAED;AACF;AACA;AACA;;;AACEE,EAAAA,aAAa,GAAS,CACpB;AACD;AAED;AACF;AACA;AACA;;;AAUE;AACF;AACA;AACA;AACqB,MAAfC,eAAe,GAAa;AAC9B,WAAO,KAAKC,OAAZ;AACD;AAED;;;AACgB,MAAZC,YAAY,GAAoB;AAClC,WAAO,EAAP;AACD;AAED;;;AACa,MAATC,SAAS,GAAoB;AAC/B,WAAO,EAAP;AACD;AAED;AACF;AACA;AACA;;;AAqGE;AACF;AACA;AACiB,MAAXC,WAAW,GAAuB;AACpC,WAAO,IAAP;AACD;AAED;AACF;AACA;;;AACkB,MAAZC,YAAY,GAAiB;AAC/B,WAAO,EAAP;AACD;AAED;AACF;AACA;;;AACiB,MAAXC,WAAW,GAAiB;AAC9B,WAAO,EAAP;AACD;AAED;AACF;AACA;;;AACmB,MAAbC,aAAa,GAAiB;AAChC,WAAO,EAAP;AACD;AAED;AACF;AACA;AACA;;;AACEC,EAAAA,cAAc,CAACC,KAAD,EAA6B;AACzC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AACsB,MAAhBC,gBAAgB,GAAY;AAC9B,WAAO,KAAP;AACD;;AAEe,MAAZC,YAAY,GAAY;AAC1B,WAAO,IAAP;AACD;AAED;AACF;AACA;;;AAGE;AACF;AACA;AACiC,MAA3BC,2BAA2B,GAAY;AACzC,WAAO,KAAP;AACD;AAED;AACF;AACA;AACA;;;AACiB,MAAXC,WAAW,GAAW;AACxB,WAAO,EAAP;AACD;AAED;AACF;AACA;AACA;;;AAGE;AACF;AACA;AAC8B,MAAxBC,wBAAwB,GAAY;AACtC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AAC8B,MAAxBC,wBAAwB,GAAY;AACtC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AACuB,MAAjBC,iBAAiB,GAAY;AAC/B,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AAC4B,MAAtBC,sBAAsB,GAAY;AACpC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AAC6B,MAAvBC,uBAAuB,GAAY;AACrC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AACuB,MAAjBC,iBAAiB,GAAY;AAC/B,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AAC+B,MAAzBC,yBAAyB,GAAY;AACvC,WAAO,KAAP;AACD;AAED;AACF;AACA;;;AACuB,MAAjBC,iBAAiB,GAAY;AAC/B,WAAO,KAAP;AACD;AAED;AACF;AACA;AACA;;;AA2CE;AACF;AACA;AACA;AACA;AACEC,EAAAA,YAAY,CAACC,WAAD,EAAmC;AAC7C,WAAO,KAAP;AACD;AAED;AACF;AACA;AACA;AACA;AACA;;;AAgCE;AACF;AACA;AACEC,EAAAA,KAAK,GAAS,CACZ;AACD;AAED;AACF;AACA;;;AACEC,EAAAA,YAAY,GAAY;AACtB,WAAO,KAAP;AACD;AAED;AACF;AACA;AACA;AACA;;;AA1b8D;;gBAN/CnC,a,WAOEoC,MAAM,CAACC,MAAP,CAAc;AAC3BC,EAAAA,OAAO,EAAE,SADkB;AAE3BC,EAAAA,iBAAiB,EAAE,mBAFQ;AAG3BC,EAAAA,cAAc,EAAE,gBAHW;AAI3BC,EAAAA,eAAe,EAAE,iBAJU;AAK3BC,EAAAA,aAAa,EAAE,eALY;AAM3BC,EAAAA,eAAe,EAAE,iBANU;AAO3BC,EAAAA,aAAa,EAAE,eAPY;AAQ3BC,EAAAA,UAAU,EAAE,YARe;AAS3BC,EAAAA,SAAS,EAAE,WATgB;AAU3BC,EAAAA,cAAc,EAAE,gBAVW;AAW3BC,EAAAA,oBAAoB,EAAE;AAXK,CAAd,C;;AA6bjB,eAAehD,aAAf","sourcesContent":["/* eslint-disable class-methods-use-this */\nimport type { Event, EventTarget } from 'event-target-shim';\nimport {\n  GridModel,\n  GridRange,\n  ModelIndex,\n  MoveOperation,\n  VisibleIndex,\n} from '@deephaven/grid';\nimport type {\n  Column,\n  ColumnStatistics,\n  CustomColumn,\n  FilterCondition,\n  Format,\n  LayoutHints,\n  RollupConfig,\n  Row,\n  Sort,\n  Table,\n} from '@deephaven/jsapi-shim';\nimport { Formatter } from '@deephaven/jsapi-utils';\nimport { ColumnName, UITotalsTableConfig, PendingDataMap } from './CommonTypes';\n\ntype RowIndex = ModelIndex;\n\ntype IrisGridModelEventNames = typeof IrisGridModel.EVENT[keyof typeof IrisGridModel.EVENT];\n\ntype IrisGridModelEventMap = {\n  [E in IrisGridModelEventNames]: Event<E>;\n};\n\n/**\n * Abstract class that extends the GridModel to have more functionality, like filtering and sorting.\n * For use from IrisGrid.\n * Provides some abstraction from the dh.Table and dh.TreeTable classes, so we can treat them somewhat the same.\n * Note that it still uses dh.Column, dh.FilterCondition, dh.Sort, etc., still. Theoretically should abstract\n * those out as well, so there's no dependency on IrisAPI at all, but it's a lot of work for no real gain at this time.\n */\nabstract class IrisGridModel<\n  TEventMap extends Record<string, Event<string>> = Record<\n    string,\n    Event<string>\n  >,\n  TMode extends 'standard' | 'strict' = 'standard'\n> extends GridModel<TEventMap & IrisGridModelEventMap, TMode> {\n  static EVENT = Object.freeze({\n    UPDATED: 'UPDATED',\n    FORMATTER_UPDATED: 'FORMATTER_UPDATED',\n    REQUEST_FAILED: 'REQUEST_FAILED',\n    COLUMNS_CHANGED: 'COLUMNS_CHANGED',\n    TABLE_CHANGED: 'TABLE_CHANGED',\n    FILTERS_CHANGED: 'FILTERS_CHANGED',\n    SORTS_CHANGED: 'SORTS_CHANGED',\n    DISCONNECT: 'DISCONNECT',\n    RECONNECT: 'RECONNECT',\n    TOTALS_UPDATED: 'TOTALS_UPDATED',\n    PENDING_DATA_UPDATED: 'PENDING_DATA_UPDATED',\n  } as const);\n\n  constructor() {\n    super();\n\n    this.listenerCount = 0;\n  }\n\n  listenerCount: number;\n\n  // Pulled directly from event-target-shim implementation signature\n  // https://github.com/mysticatea/event-target-shim/blob/master/src/lib/event-target.ts#L99\n  // Using Parameters<GridModel['addEventListener']> doesn't work\n  addEventListener<T extends string & keyof TEventMap>(\n    type0: T,\n    callback0?: EventTarget.EventListener<this, TEventMap[T]> | null,\n    options0?: boolean | EventTarget.AddOptions\n  ): void {\n    super.addEventListener(type0, callback0 as never, options0 as never);\n\n    this.listenerCount += 1;\n    if (this.listenerCount === 1) {\n      this.startListening();\n    }\n  }\n\n  removeEventListener<T extends string & keyof TEventMap>(\n    type0: T,\n    callback0?: EventTarget.EventListener<this, TEventMap[T]> | null,\n    options0?: boolean | EventTarget.Options\n  ): void {\n    super.removeEventListener(type0, callback0 as never, options0 as never);\n\n    this.listenerCount -= 1;\n    if (this.listenerCount === 0) {\n      this.stopListening();\n    }\n  }\n\n  /**\n   * Function called when first listener is added.\n   * Override for implementation specific behaviour.\n   */\n  startListening(): void {\n    // no-op\n  }\n\n  /**\n   * Function called when last listener is removed.\n   * Override for implementation specific behaviour.\n   */\n  stopListening(): void {\n    // no-op\n  }\n\n  /**\n   * Gets the columns for this model\n   * @returns All columns in the model\n   */\n  abstract get columns(): Column[];\n\n  /**\n   * Gets the column index for this model\n   * @param name The model column name.\n   * @returns The numeric index of the requested column.\n   */\n  abstract getColumnIndexByName(name: string): ModelIndex | undefined;\n\n  /**\n   * Gets the columns for the model before any transformations (such as rollups) are applied.\n   * @returns All original columns in the model.\n   */\n  get originalColumns(): Column[] {\n    return this.columns;\n  }\n\n  /** List of column movements defined by the model. Used as initial movements for IrisGrid */\n  get movedColumns(): MoveOperation[] {\n    return [];\n  }\n\n  /** List of row movements defined by the model. Used as initial movements for IrisGrid */\n  get movedRows(): MoveOperation[] {\n    return [];\n  }\n\n  /**\n   * Retrieve the grouped columns for this model\n   * @returns The columns that are groupe\n   */\n  abstract get groupedColumns(): Column[];\n\n  /**\n   * @param column The model column index\n   * @param row The model row index\n   * @returns The format stored for that cell\n   */\n  abstract formatForCell(\n    column: ModelIndex,\n    row: ModelIndex\n  ): Format | undefined;\n\n  /**\n   * @param column The model column index\n   * @param row The model row index\n   * @returns The value stored for that cell\n   */\n  abstract valueForCell(column: ModelIndex, row: ModelIndex): unknown;\n\n  /**\n   * @returns The filters set on this model\n   */\n  abstract get filter(): FilterCondition[];\n\n  /**\n   * @param filter The filters to set\n   */\n  abstract set filter(filter: FilterCondition[]);\n\n  /**\n   * @returns The formatter used when formatting data\n   */\n  abstract get formatter(): Formatter;\n\n  /**\n   * @param formatter The formatter to set\n   */\n  abstract set formatter(formatter: Formatter);\n\n  /**\n   * @param value The value to format\n   * @param columnType The column type to format\n   * @param columnName The column name to format\n   */\n  abstract displayString(\n    value: unknown,\n    columnType: string,\n    columnName?: ColumnName\n  ): string;\n\n  /**\n   * @returns The sorts used on this model\n   */\n  abstract get sort(): Sort[];\n\n  /**\n   * @param sort The sorts to use on this model\n   */\n  abstract set sort(sort: Sort[]);\n\n  /**\n  /**\n   * @returns The custom columns on this model\n   */\n  abstract get customColumns(): ColumnName[];\n\n  /**\n   * @param customColumns The custom columns to use\n   */\n  abstract set customColumns(customColumns: ColumnName[]);\n\n  /**\n   * @returns The format columns on this model\n   */\n  abstract get formatColumns(): CustomColumn[];\n\n  /**\n   * @param formatColumns The format columns to use\n   */\n  abstract set formatColumns(formatColumns: CustomColumn[]);\n\n  /**\n   * @param columns The columns to treat as frozen\n   */\n  abstract updateFrozenColumns(columns: ColumnName[]): void;\n\n  /**\n   * @returns The config to use for rolling up this table\n   */\n  abstract get rollupConfig(): RollupConfig | null;\n\n  abstract set rollupConfig(rollupConfig: RollupConfig | null);\n\n  /**\n   * @returns The config to use for the totals table of this model\n   */\n  abstract get totalsConfig(): UITotalsTableConfig | null;\n\n  abstract set totalsConfig(totalsConfig: UITotalsTableConfig | null);\n\n  /**\n   * @returns The LayoutHints to use for the columns of this table model\n   */\n  get layoutHints(): LayoutHints | null {\n    return null;\n  }\n\n  /**\n   * @returns Names of columns which should be locked to the front, but not floating\n   */\n  get frontColumns(): ColumnName[] {\n    return [];\n  }\n\n  /**\n   * @returns Names of columns which should be locked to the back, but not floating\n   */\n  get backColumns(): ColumnName[] {\n    return [];\n  }\n\n  /**\n   * @returns Names of columns which should be frozen to the front and floating\n   */\n  get frozenColumns(): ColumnName[] {\n    return [];\n  }\n\n  /**\n   * @param index The column index to check\n   * @returns Whether the column is one of LayoutHints' frozen columns\n   */\n  isColumnFrozen(index: ModelIndex): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model requires a filter to be set\n   */\n  get isFilterRequired(): boolean {\n    return false;\n  }\n\n  get isReversible(): boolean {\n    return true;\n  }\n\n  /**\n   * @returns Returns a raw table that is frozen and can be used for exporting data\n   */\n  abstract export(): Promise<Table>;\n\n  /**\n   * @returns True if this model supports the columnStatistics(column) function\n   */\n  get isColumnStatisticsAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * The description for this model.\n   * @returns The description of the model\n   */\n  get description(): string {\n    return '';\n  }\n\n  /**\n   * @param column The column to get statistics for\n   * @returns The column statistics\n   */\n  abstract columnStatistics(column: Column): Promise<ColumnStatistics>;\n\n  /**\n   * @returns True if this model supports customColumns\n   */\n  get isCustomColumnsAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model supports customColumns\n   */\n  get isFormatColumnsAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model supports the export() function\n   */\n  get isExportAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model supports the valuesTable(column) function\n   */\n  get isValuesTableAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if this model should allow the chart builder\n   */\n  get isChartBuilderAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if the rollup rows functionality is available\n   */\n  get isRollupAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if select distinct functionality is available\n   */\n  get isSelectDistinctAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * @returns True if the totals functionality is available\n   */\n  get isTotalsAvailable(): boolean {\n    return false;\n  }\n\n  /**\n   * The names of columns with select distinct enabled\n   * @returns An array of column names\n   */\n  abstract get selectDistinctColumns(): ColumnName[];\n\n  /**\n   * Set the columns with select distinct enabled\n   * @param names The array of column names to enable select distinct on\n   */\n  abstract set selectDistinctColumns(names: ColumnName[]);\n\n  /**\n   * The pending data for this model\n   * @returns A map of row index to a map of column name/value pairs\n   */\n  abstract get pendingDataMap(): PendingDataMap;\n\n  /**\n   * Set the pending data for this model\n   * @param A map of row index to a map of column name/value pairs\n   */\n  abstract set pendingDataMap(map: PendingDataMap);\n\n  /**\n   * @returns The count of pending rows to show\n   */\n  abstract get pendingRowCount(): number;\n\n  /**\n   * Set the count of pending rows to show\n   * @param count The count of pending rows to show\n   */\n  abstract set pendingRowCount(count: number);\n\n  /**\n   * Errors for the pending data\n   * @returns Map from row number to the error\n   */\n  abstract get pendingDataErrors(): Map<RowIndex, Error[]>;\n\n  /**\n   * Commit pending data and save all data to the table\n   */\n  abstract commitPending(): Promise<void>;\n\n  /**\n   * Check if a column is filterable\n   * @param columnIndex The column index to check for filterability\n   * @returns True if the current provided column index is filterable, false otherwise\n   */\n  isFilterable(columnIndex: ModelIndex): boolean {\n    return false;\n  }\n\n  /**\n   * Set the indices of the viewport\n   * @param top Top of viewport\n   * @param bottom Bottom of viewport\n   * @param columns The columns in the viewport. `null` for all columns\n   */\n  abstract setViewport(\n    top: VisibleIndex,\n    bottom: VisibleIndex,\n    columns: Column[] | null\n  ): void;\n\n  /**\n   * Takes a snapshot of the provided ranges\n   * @param ranges The model ranges to take the snapshot of\n   * @returns Returns the data in a row/column matrix\n   */\n  abstract snapshot(ranges: GridRange[]): Promise<unknown[][]>;\n\n  /**\n   * @param ranges The ranges to take a snapshot of\n   * @param includeHeaders Whether to include the headers in the snapshot or not\n   * @param formatValue A function to format a value for a cell. Defaults to model format value.\n   * @returns A text formatted snapshot of the data for the specified range set\n   */\n  abstract textSnapshot(\n    ranges: GridRange[],\n    includeHeaders?: boolean,\n    formatValue?: (value: unknown, column: Column, row?: Row) => string\n  ): Promise<string>;\n\n  /**\n   * @param column The column to get the distinct values for\n   * @returns A table partitioned on the column specified\n   */\n  abstract valuesTable(column: Column): Promise<Table>;\n\n  /**\n   * Close this model. It can no longer be used after being closed\n   */\n  close(): void {\n    // no-op\n  }\n\n  /**\n   * Don't allow any rows to be movable in any IrisGrids by default. Just columns.\n   */\n  isRowMovable(): boolean {\n    return false;\n  }\n\n  /**\n   * Delete ranges from an input grid. Will delete the entire row, causing data to shift up\n   * @param ranges The ranges to delete\n   * @returns A promise that resolves successfully when the operation is complete or rejects if there's an error\n   */\n  abstract delete(ranges: GridRange[]): Promise<void>;\n}\n\nexport default IrisGridModel;\n"],"file":"IrisGridModel.js"}

package/dist/IrisGridTableModelTemplate.d.ts

@@ -209,7 +209,7 @@ declare class IrisGridTableModelTemplate<T extends TableTemplate<T> = Table, R e
      */
     getTableAreaRange(): GridRange;
     /**
-     * @returns {GridRange} A range corresponding to the pending new rows
+     * @returns A range corresponding to the pending new rows
      */
     getPendingAreaRange(): GridRange;
     /**

package/dist/IrisGridTableModelTemplate.js

@@ -1467,7 +1467,7 @@ class IrisGridTableModelTemplate extends IrisGridModel {
     return new GridRange(null, this.floatingTopRowCount, null, this.floatingTopRowCount + this.table.size - 1);
   }
   /**
-   * @returns {GridRange} A range corresponding to the pending new rows
+   * @returns A range corresponding to the pending new rows
    */