@revolist/revogrid 4.9.3 → 4.9.5

package/dist/types/plugins/column.stretch.plugin.d.ts

@@ -1,7 +1,5 @@
-import { ColumnItems } from '../services/dimension.provider';
 import { BasePlugin } from './base.plugin';
-import { PluginBaseComponent } from '../';
-import { PluginProviders } from '../';
+import { DimensionCols, PluginBaseComponent, PluginProviders, ColumnRegular } from "../types/index";
 export default class StretchColumn extends BasePlugin {
     providers: PluginProviders;
     private stretchedColumn;
@@ -14,7 +12,7 @@ export default class StretchColumn extends BasePlugin {
     /**
      * Apply stretch changes
      */
-    applyStretch(columns: ColumnItems): void;
+    applyStretch(columns: Record<DimensionCols, ColumnRegular[]>): void;
 }
 /**
  * Check plugin type is Stretch

package/dist/types/services/column.data.provider.d.ts

@@ -1,13 +1,6 @@
-import { ColumnGroupingCollection } from '../plugins/groupingColumn/grouping.col.plugin';
 import { DataStore } from "../store/index";
-import type { ColumnData, ColumnProp, ColumnRegular, ColumnTypes, ViewSettingSizeProp, DimensionCols, DimensionColPin } from "../types/index";
-export type ColumnCollection = {
-    columns: Record<DimensionCols, ColumnRegular[]>;
-    columnByProp: Record<ColumnProp, ColumnRegular[]>;
-    columnGrouping: ColumnGroupingCollection;
-    maxLevel: number;
-    sort: Record<ColumnProp, ColumnRegular>;
-};
+import type { ColumnProp, ColumnRegular, DimensionCols, DimensionColPin } from "../types/index";
+import { ColumnCollection } from '../utils/column.utils';
 export type ColumnDataSources = Record<DimensionCols, DataStore<ColumnRegular, DimensionCols>>;
 type Sorting = Record<ColumnProp, ColumnRegular>;
 type SortingOrder = Record<ColumnProp, 'asc' | 'desc' | undefined>;
@@ -29,9 +22,5 @@ export default class ColumnDataProvider {
     updateColumn(column: ColumnRegular, index: number): void;
     updateColumnSorting(column: ColumnRegular, index: number, sorting: 'asc' | 'desc' | undefined, additive: boolean): ColumnRegular;
     clearSorting(): void;
-    static getSizes(cols: ColumnRegular[]): ViewSettingSizeProp;
-    static getColumnByProp(columns: ColumnData, prop: ColumnProp): ColumnRegular | undefined;
-    static getColumns(columns: ColumnData, level?: number, types?: ColumnTypes): ColumnCollection;
-    static getColumnType(rgCol: ColumnRegular): DimensionCols;
 }
 export {};

package/dist/types/services/dimension.provider.d.ts

@@ -1,7 +1,6 @@
 import ViewportProvider from './viewport.provider';
 import { DimensionStoreCollection, Trimmed } from "../store/index";
 import { DimensionCols, DimensionType, MultiDimensionType, ColumnRegular, DimensionSettingsState, ViewPortScrollEvent, ViewSettingSizeProp } from "../types/index";
-export type ColumnItems = Record<DimensionCols, ColumnRegular[]>;
 export type DimensionConfig = {
     realSizeChanged(k: MultiDimensionType): void;
 };

package/dist/types/types/interfaces.d.ts

@@ -72,15 +72,15 @@ export type RowDrag = boolean | {
 /**
  * `ColumnGrouping` type is used to define a grouping in a column.
  */
-export type ColumnGrouping = {
+export type ColumnGrouping<T = any> = {
     /**
      * An array of objects that represent the children of the grouping.
      */
-    children: (ColumnGrouping | ColumnRegular)[];
+    children: (ColumnGrouping<T> | ColumnRegular)[];
     /**
      * A `DataFormat` object that represents the name of the grouping.
      */
-    name: DataFormat;
+    name: DataFormat<T>;
 };
 /**
  * Configuration for header inner template properties
@@ -178,7 +178,7 @@ export interface ColumnRegular extends ColumnType {
     /**
      * Column header text.
      */
-    name?: DataFormat;
+    name?: any;
     /**
      * Column size would be changed based on space left.
      */
@@ -229,7 +229,7 @@ export interface ColumnTemplateProp extends ColumnRegular {
 }
 export type ColumnPropProp = ColumnGrouping | ColumnTemplateProp;
 export type ColumnProp = string | number;
-export type DataFormat = any;
+export type DataFormat<T = any> = T;
 export type CellProp = string | number | object | boolean | undefined;
 /**
  * Additional properties applied to the cell.
@@ -346,11 +346,11 @@ export type CellCompareFunc = (prop: ColumnProp, a: DataType, b: DataType) => nu
 export type ColumnTemplateFunc = (createElement: HyperFunc<VNode>, props: ColumnTemplateProp, additionalData?: any) => any;
 export type PropertiesFunc = (props: ColumnDataSchemaModel) => CellProps | void | undefined;
 export type ColPropertiesFunc = (props: ColumnPropProp) => CellProps | void | undefined;
-export type DataType = {
-    [T in ColumnProp]: DataFormat;
+export type DataType<D = any> = {
+    [T in ColumnProp]: DataFormat<D>;
 };
-export type DataLookup = {
-    [rowIndex: number]: DataType;
+export type DataLookup<T = any> = {
+    [rowIndex: number]: DataType<T>;
 };
 /**
  * `RowDefinition` is a type that represents a row definition in the
@@ -680,8 +680,8 @@ export type RangeClipboardPasteEvent = {
     range: RangeArea | null;
 } & AllDimensionType;
 /** Range copy. */
-export type RangeClipboardCopyEventProps = {
-    data: DataFormat[][];
+export type RangeClipboardCopyEventProps<T = any> = {
+    data: DataFormat<T>[][];
     range: RangeArea;
     mapping: OldNewRangeMapping;
 } & AllDimensionType;

package/dist/types/utils/column.utils.d.ts

@@ -0,0 +1,46 @@
+import { ColumnData, ColumnGrouping, ColumnProp, ColumnRegular, ColumnTypes, DimensionCols, ViewSettingSizeProp } from "../types/index";
+import { Group as StoreGroup } from "../store/index";
+export type ColumnItems = Record<DimensionCols, ColumnRegular[]>;
+export interface ColumnGroup extends StoreGroup {
+    level: number;
+}
+export type ColumnGroupingCollection = Record<DimensionCols, ColumnGroup[]>;
+/**
+ * Column collection definition.
+ * Used to access indexed data for columns.
+ * Can be accessed via different events.
+ */
+export type ColumnCollection = {
+    /**
+     * Columns as they are in stores
+     */
+    columns: Record<DimensionCols, ColumnRegular[]>;
+    /**
+     * Columns indexed by prop for quick access, it's possible to have multiple columns with same prop but not recommended
+     */
+    columnByProp: Record<ColumnProp, ColumnRegular[]>;
+    /**
+     * Grouped columns
+     */
+    columnGrouping: ColumnGroupingCollection;
+    /**
+     * Max level of grouping
+     */
+    maxLevel: number;
+    /**
+     * Sorting
+     */
+    sort: Record<ColumnProp, ColumnRegular>;
+};
+export declare function getColumnType(rgCol: ColumnRegular): DimensionCols;
+export declare function getColumnSizes(cols: ColumnRegular[]): ViewSettingSizeProp;
+/**
+ * Check if column is grouping column
+ */
+export declare function isColGrouping(colData: ColumnGrouping | ColumnRegular): colData is ColumnGrouping;
+/**
+ * This function is used to create a collection of columns.
+ */
+export declare function getColumns(columns: ColumnData, level?: number, types?: ColumnTypes): ColumnCollection;
+export declare function gatherGroup<T extends ColumnCollection>(res: T, colData: ColumnGrouping, collection: T, level?: number): T;
+export declare function getColumnByProp(columns: ColumnData, prop: ColumnProp): ColumnRegular | undefined;