@finos/legend-data-cube 0.0.2

package/lib/stores/grid/DataCubeGridConfigurationBuilder.d.ts

@@ -0,0 +1,180 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/***************************************************************************************
+ * [GRID]
+ *
+ * These are utilities used to build the configuration for the grid client,
+ * AG Grid, from the query snapshot.
+ ***************************************************************************************/
+import { type DataCubeQuerySnapshot } from '../core/DataCubeQuerySnapshot.js';
+import type { ColGroupDef, GridOptions } from '@ag-grid-community/core';
+import { GridClientSortDirection, GridClientPinnedAlignement } from './DataCubeGridClientEngine.js';
+import type { DataCubeConfiguration } from '../core/DataCubeConfiguration.js';
+import type { DataCubeViewState } from '../DataCubeViewState.js';
+export declare function generateBaseGridOptions(view: DataCubeViewState): GridOptions;
+export declare function generateColumnDefs(snapshot: DataCubeQuerySnapshot, configuration: DataCubeConfiguration, view: DataCubeViewState): (ColGroupDef<any> | {
+    enableRowGroup: boolean;
+    rowGroup: boolean;
+    rowGroupIndex: number | null;
+    enablePivot: boolean;
+    pivot: boolean;
+    pivotIndex: number | null;
+    aggFunc: string | null;
+    enableValue: false;
+    allowedAggFuncs: never[];
+    sortable: true;
+    sort: GridClientSortDirection | null;
+    sortIndex: number | null;
+    colId: string;
+    field: string;
+    type?: string | string[];
+    cellDataType: boolean | string;
+    valueGetter?: string | import("@ag-grid-community/core").ValueGetterFunc<any, any>;
+    valueFormatter: string | ((params: import("@ag-grid-community/core").ValueFormatterParams<any, any>) => any);
+    refData?: {
+        [key: string]: string;
+    };
+    keyCreator?: (params: import("@ag-grid-community/core").KeyCreatorParams<any, any>) => string;
+    equals?: (valueA: any, valueB: any) => boolean;
+    tooltipField?: string;
+    tooltipValueGetter: (params: import("@ag-grid-community/core").ITooltipParams<any, any, any>) => string | any;
+    checkboxSelection?: boolean | import("@ag-grid-community/core").CheckboxSelectionCallback<any, any>;
+    showDisabledCheckboxes?: boolean;
+    icons?: {
+        [key: string]: ((...args: any[]) => any) | string;
+    };
+    suppressNavigable?: boolean | import("@ag-grid-community/core").SuppressNavigableCallback<any, any>;
+    suppressKeyboardEvent?: (params: import("@ag-grid-community/core").SuppressKeyboardEventParams<any, any>) => boolean;
+    suppressPaste?: boolean | import("@ag-grid-community/core").SuppressPasteCallback<any, any>;
+    suppressFillHandle?: boolean;
+    hide: boolean;
+    initialHide?: boolean;
+    lockVisible: boolean;
+    lockPosition?: boolean | "left" | "right";
+    suppressMovable?: boolean;
+    useValueFormatterForExport?: boolean;
+    editable?: boolean | import("@ag-grid-community/core").EditableCallback<any, any>;
+    valueSetter?: string | import("@ag-grid-community/core").ValueSetterFunc<any, any>;
+    valueParser?: string | import("@ag-grid-community/core").ValueParserFunc<any, any>;
+    cellEditor?: any;
+    cellEditorParams?: any;
+    cellEditorSelector?: import("@ag-grid-community/core").CellEditorSelectorFunc<any, any>;
+    singleClickEdit?: boolean;
+    cellEditorPopup?: boolean;
+    cellEditorPopupPosition?: "over" | "under";
+    useValueParserForImport?: boolean;
+    onCellValueChanged?: (event: import("@ag-grid-community/core").NewValueParams<any, any>) => void;
+    onCellClicked?: (event: import("@ag-grid-community/core").CellClickedEvent<any, any>) => void;
+    onCellDoubleClicked?: (event: import("@ag-grid-community/core").CellDoubleClickedEvent<any, any>) => void;
+    onCellContextMenu?: (event: import("@ag-grid-community/core").CellContextMenuEvent<any, any>) => void;
+    getQuickFilterText?: (params: import("@ag-grid-community/core").GetQuickFilterTextParams<any, any>) => string;
+    filterValueGetter?: string | import("@ag-grid-community/core").ValueGetterFunc<any, any>;
+    floatingFilter?: boolean;
+    suppressFloatingFilterButton?: boolean;
+    headerComponent?: any;
+    headerComponentParams?: any;
+    menuTabs: import("@ag-grid-community/core").ColumnMenuTab[];
+    columnChooserParams?: import("@ag-grid-community/core").ColumnChooserParams;
+    columnsMenuParams?: import("@ag-grid-community/core").ColumnsMenuParams;
+    suppressMenu?: boolean;
+    suppressHeaderMenuButton?: boolean;
+    suppressHeaderFilterButton?: boolean;
+    mainMenuItems?: (string | import("@ag-grid-community/core").MenuItemDef<any, any>)[] | import("@ag-grid-community/core").GetMainMenuItems<any, any>;
+    contextMenuItems?: import("@ag-grid-community/core").GetContextMenuItems<any, any> | (string | import("@ag-grid-community/core").MenuItemDef<any, any>)[];
+    headerCheckboxSelection?: boolean | import("@ag-grid-community/core").HeaderCheckboxSelectionCallback<any, any>;
+    headerCheckboxSelectionFilteredOnly?: boolean;
+    headerCheckboxSelectionCurrentPageOnly?: boolean;
+    chartDataType?: "category" | "series" | "time" | "excluded";
+    pinned: boolean | "left" | "right" | GridClientPinnedAlignement | null;
+    initialPinned?: boolean | "left" | "right";
+    lockPinned?: boolean;
+    initialPivot?: boolean;
+    initialPivotIndex?: number;
+    pivotComparator?: (valueA: string, valueB: string) => number;
+    cellStyle?: import("@ag-grid-community/core").CellStyle | import("@ag-grid-community/core").CellStyleFunc<any, any>;
+    cellClass?: string | string[] | import("@ag-grid-community/core").CellClassFunc<any, any>;
+    cellClassRules: import("@ag-grid-community/core").CellClassRules<any, any>;
+    cellRenderer: any;
+    cellRendererParams?: any;
+    cellRendererSelector?: import("@ag-grid-community/core").CellRendererSelectorFunc<any, any>;
+    loadingCellRenderer: any;
+    loadingCellRendererParams?: any;
+    loadingCellRendererSelector?: import("@ag-grid-community/core").CellRendererSelectorFunc<any, any>;
+    autoHeight?: boolean;
+    wrapText?: boolean;
+    enableCellChangeFlash?: boolean;
+    suppressCellFlash?: boolean;
+    rowDrag?: boolean | import("@ag-grid-community/core").RowDragCallback<any, any>;
+    rowDragText?: (params: import("@ag-grid-community/core").IRowDragItem, dragItemCount: number) => string;
+    dndSource?: boolean | import("@ag-grid-community/core").DndSourceCallback<any, any>;
+    dndSourceOnRowDrag?: (params: import("@ag-grid-community/core").DndSourceOnRowDragParams<any>) => void;
+    initialRowGroup?: boolean;
+    initialRowGroupIndex?: number;
+    initialAggFunc?: string | import("@ag-grid-community/core").IAggFunc<any, any>;
+    defaultAggFunc?: string;
+    showRowGroup?: string | boolean;
+    initialSort?: import("@ag-grid-community/core").SortDirection;
+    initialSortIndex?: number;
+    sortingOrder?: import("@ag-grid-community/core").SortDirection[];
+    comparator?: (valueA: any, valueB: any, nodeA: import("@ag-grid-community/core").IRowNode<any>, nodeB: import("@ag-grid-community/core").IRowNode<any>, isDescending: boolean) => number;
+    unSortIcon?: boolean;
+    colSpan?: (params: import("@ag-grid-community/core").ColSpanParams<any, any>) => number;
+    rowSpan?: (params: import("@ag-grid-community/core").RowSpanParams<any, any>) => number;
+    width?: number;
+    initialWidth?: number;
+    minWidth?: number;
+    maxWidth?: number;
+    flex?: number;
+    initialFlex?: number;
+    resizable?: boolean;
+    suppressSizeToFit?: boolean;
+    suppressAutoSize?: boolean;
+    pivotValueColumn?: import("@ag-grid-community/core").Column | null;
+    pivotTotalColumnIds?: string[];
+    suppressSpanHeaderHeight: boolean;
+    headerName: string;
+    headerValueGetter?: string | import("@ag-grid-community/core").HeaderValueGetterFunc<any, any>;
+    headerTooltip: string;
+    headerClass: import("@ag-grid-community/core").HeaderClass<any, any>;
+    suppressHeaderKeyboardEvent?: (params: import("@ag-grid-community/core").SuppressHeaderKeyboardEventParams<any, any>) => boolean;
+    columnGroupShow?: import("@ag-grid-community/core").ColumnGroupShowType;
+    toolPanelClass?: import("@ag-grid-community/core").ToolPanelClass<any, any>;
+    suppressColumnsToolPanel?: boolean;
+    suppressFiltersToolPanel?: boolean;
+    tooltipComponent?: any;
+    tooltipComponentParams?: any;
+    pivotKeys?: string[];
+    cellAriaRole?: string;
+    context?: any;
+    wrapHeaderText?: boolean;
+    autoHeaderHeight?: boolean;
+    suppressHeaderContextMenu?: boolean;
+    filter?: any;
+    filterParams?: any;
+    floatingFilterComponent?: any;
+    floatingFilterComponentParams?: any;
+} | {
+    colId: string;
+    hide: true;
+    enableValue: false;
+    allowedAggFuncs: never[];
+    enablePivot: false;
+    enableRowGroup: false;
+    filter: string;
+    suppressColumnsToolPanel: true;
+})[];
+export declare function generateGridOptionsFromSnapshot(snapshot: DataCubeQuerySnapshot, configuration: DataCubeConfiguration, view: DataCubeViewState): GridOptions;
+//# sourceMappingURL=DataCubeGridConfigurationBuilder.d.ts.map

package/lib/stores/grid/DataCubeGridConfigurationBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataCubeGridConfigurationBuilder.d.ts","sourceRoot":"","sources":["../../../src/stores/grid/DataCubeGridConfigurationBuilder.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;;yFAKyF;AAEzF,OAAO,EAEL,KAAK,qBAAqB,EAE3B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAEV,WAAW,EACX,WAAW,EAEZ,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,uBAAuB,EAUvB,0BAA0B,EAW3B,MAAM,+BAA+B,CAAC;AAYvC,OAAO,KAAK,EAEV,qBAAqB,EACtB,MAAM,kCAAkC,CAAC;AAgB1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAqYjE,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,iBAAiB,GAAG,WAAW,CAmJ5E;AA2JD,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,qBAAqB,EAC/B,aAAa,EAAE,qBAAqB,EACpC,IAAI,EAAE,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAzcE,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAygB7B;AAED,wBAAgB,+BAA+B,CAC7C,QAAQ,EAAE,qBAAqB,EAC/B,aAAa,EAAE,qBAAqB,EACpC,IAAI,EAAE,iBAAiB,GACtB,WAAW,CAwFb"}