@adaptabletools/adaptable 18.0.0-canary.1 → 18.0.0-canary.10

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -0,0 +1,351 @@
+import { AdaptableOptions } from '../AdaptableOptions/AdaptableOptions';
+import { ChartRef, Column, GridApi, GridOptions, IRowNode, Module, RowModelType } from '@ag-grid-community/core';
+import { AdaptableLogger } from './AdaptableLogger';
+import { AdaptableApi } from '../Api/AdaptableApi';
+import { DistinctValuesParams, IAdaptable } from '../AdaptableInterfaces/IAdaptable';
+import { EmitterCallback } from '../Utilities/Emitter';
+import { AdaptablePlugin } from '../AdaptableOptions/AdaptablePlugin';
+import { AgGridAdapter } from './AgGridAdapter';
+import { IDataService } from '../Utilities/Services/Interface/IDataService';
+import { IAdaptableStore } from '../Redux/Store/Interface/IAdaptableStore';
+import { ICalculatedColumnExpressionService } from '../Utilities/Services/Interface/ICalculatedColumnExpressionService';
+import { IEntitlementService } from '../Utilities/Services/Interface/IEntitlementService';
+import { IReportService } from '../Utilities/Services/Interface/IReportService';
+import { IModuleService } from '../Utilities/Services/Interface/IModuleService';
+import { IValidationService } from '../Utilities/Services/Interface/IValidationService';
+import { IQueryLanguageService } from '../Utilities/Services/Interface/IQueryLanguageService';
+import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
+import { ITeamSharingService } from '../Utilities/Services/Interface/ITeamSharingService';
+import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelService';
+import { Fdc3Service } from '../Utilities/Services/Fdc3Service';
+import { CellPopupService } from '../Utilities/Services/CellPopupService';
+import { IModuleCollection } from '../Strategy/Interface/IModule';
+import { AgGridMenuAdapter } from './AgGridMenuAdapter';
+import { AdaptableColumn, AdaptableTheme, ChartDefinition, ColumnSort, DataUpdateConfig, GridCell, Layout, ReportData, SelectedCellInfo, SelectedRowInfo } from '../types';
+import { RenderReactRootFn } from '../renderReactRoot';
+import { AgGridOptionsService } from './AgGridOptionsService';
+import { AgGridColumnAdapter } from './AgGridColumnAdapter';
+import { RowEditService } from '../Utilities/Services/RowEditService';
+import { SummaryService } from '../Utilities/Services/SummaryService';
+export type AdaptableVariant = 'vanilla' | 'react' | 'angular';
+export type AdaptableLifecycleState = 'initial' | 'preprocessOptions' | 'initAdaptableState' | 'setupAgGrid' | 'initAgGrid' | 'available' | 'ready' | 'preDestroyed';
+type RenderAgGridFrameworkComponentResult = false | GridApi;
+interface AdaptableInitInternalConfig<TData = any> {
+    variant: AdaptableVariant;
+    adaptableOptions: AdaptableOptions<TData>;
+    gridOptions: GridOptions<TData>;
+    modules?: Module[];
+    /**
+     * Adaptable init hook for rendering the React/Angular AG Grid component
+     */
+    renderAgGridFrameworkComponent?: (gridOptions: GridOptions<TData>) => Promise<RenderAgGridFrameworkComponentResult>;
+}
+export declare class AdaptableAgGrid implements IAdaptable {
+    logger: AdaptableLogger;
+    private _id;
+    lifecycleState: AdaptableLifecycleState;
+    variant: AdaptableVariant;
+    private emitter;
+    /**
+     * Runtime flags
+     */
+    embedColumnMenu: boolean;
+    hasAutogeneratedPrimaryKey: boolean;
+    hasAdaptableToolPanel: boolean;
+    private initWithLazyData;
+    /**
+     * once layouts are properly handled with the new aggrid methods & events
+     * we can remove this hack
+     */
+    private previousAgGridColumnState;
+    _rawAdaptableOptions: AdaptableOptions;
+    adaptableOptions: AdaptableOptions;
+    agGridOptionsService: AgGridOptionsService;
+    agGridAdapter: AgGridAdapter;
+    agGridColumnAdapter: AgGridColumnAdapter;
+    agGridMenuAdapter: AgGridMenuAdapter;
+    private DANGER_USE_GETTER_adaptableContainerElement;
+    private DANGER_USE_GETTER_agGridContainerElement;
+    api: AdaptableApi;
+    adaptableStore: IAdaptableStore;
+    adaptableModules: IModuleCollection;
+    DataService: IDataService;
+    CalculatedColumnExpressionService: ICalculatedColumnExpressionService;
+    EntitlementService: IEntitlementService;
+    ReportService: IReportService;
+    ModuleService: IModuleService;
+    ValidationService: IValidationService;
+    QueryLanguageService: IQueryLanguageService;
+    AlertService: IAlertService;
+    TeamSharingService: ITeamSharingService;
+    MetamodelService: IMetamodelService;
+    RowEditService: RowEditService;
+    Fdc3Service: Fdc3Service;
+    CellPopupService: CellPopupService;
+    SummaryService: SummaryService;
+    private LicenseService;
+    private ChartingService;
+    private ThemeService;
+    private rowListeners;
+    private throttleFilterOnEditDataChange;
+    private throttleFilterOnTickingDataChange;
+    private debouncedSetColumnIntoStore;
+    private debouncedSaveGridLayout;
+    private debouncedSetSelectedRows;
+    private debouncedSetSelectedCells;
+    private agGridListenerKeydown;
+    private agGridListenerMouseEnter;
+    private agGridListenerMouseLeave;
+    private listenerGlobalColumnEventsThatTriggerStateChange;
+    private listenerGlobalColumnEventsThatTriggerAutoLayoutSave;
+    private listenerGlobalRowGroupEventsThatTriggerAutoLayoutSave;
+    private listenerGlobalSetRowSelection;
+    private listenerCellEditingStarted;
+    private listenerFirstDataRendered;
+    private listenerPivotModeChanged;
+    private listenerPivotChanged;
+    private listenerColumnRowGroupChanged;
+    private listenerColumnResized;
+    private listenerRangeSelectionChanged;
+    private listenerSortChanged;
+    private listenerModelUpdated;
+    private columnMinMaxValuesCache;
+    renderReactRoot: RenderReactRootFn;
+    private unmountReactRoot?;
+    private unmountLoadingScreen?;
+    /**
+     * Temporary, these are MIGRATION technical debts, and should be removed as soon as possible
+     */
+    private adaptableStatusPanelKeys;
+    constructor();
+    static forEachAdaptable(fn: (adaptable: AdaptableAgGrid) => void): void;
+    private static collectInstance;
+    private static dismissInstance;
+    get isReady(): boolean;
+    get isAvailable(): boolean;
+    get isDestroyed(): boolean;
+    _emit: (eventName: string, data?: any) => Promise<any>;
+    _emitSync: (eventName: string, data?: any) => any;
+    _on: (eventName: string, callback: EmitterCallback) => (() => void);
+    _onIncludeFired: (eventName: string, callback: EmitterCallback) => (() => void);
+    /**
+     * Internal initializer for Adaptable, directly called by the React and Angular Adaptable wrappers
+     * @private
+     */
+    static _initInternal(config: AdaptableInitInternalConfig): Promise<AdaptableApi>;
+    private _initAdaptableAgGrid;
+    private normaliseLayoutState;
+    private normaliseToolPanelState;
+    refreshQuickFilter(): void;
+    applyColumnFiltering(): void;
+    applyGridFiltering(): void;
+    private refreshColDefs;
+    showQuickFilter(): void;
+    hideQuickFilter(): void;
+    private normalizeAdaptableOptions;
+    private setInitialGridOptions;
+    /**
+     * Either initializes the AG Grid instance or delegates it to the framework wrappers (React/Anglar)
+     */
+    private initializeAgGrid;
+    private getAllColumnDefinitions;
+    private getSpecialColDefs;
+    private enhanceColDefsWithSpecialColumns;
+    useRowNodeLookUp(): boolean;
+    getAgGridContainerElement(): HTMLElement | null;
+    getAdaptableContainerElement(): HTMLElement | null;
+    refreshSelectedCellsState(): SelectedCellInfo | undefined;
+    refreshSelectedRowsState(): SelectedRowInfo | undefined;
+    isGridSelectable(): boolean;
+    private initAdaptableStore;
+    private mapAdaptableStateToAgGridState;
+    private addGridEventListeners;
+    private shouldAutoSizeLayout;
+    private autoSizeLayoutIfNeeded;
+    private performAudit;
+    forPlugins(callback: (plugin: AdaptablePlugin) => any): void;
+    getPluginProperty(pluginId: string, propertyName: string, ...args: any): any;
+    getPlugin(pluginId: string): AdaptablePlugin;
+    private initServices;
+    private initLicenseService;
+    private initModules;
+    /**
+     * This method contains all the updates on the AdaptableState which were made AFTER Adaptbale was ready
+     * This was contidioned because we required AG Grid to be ready before we could make these updates
+     * We should be able to refactor the code, no that we no fore sure that Adaptable State is ready BEFORE AG Grid init
+     */
+    private temporaryAdaptableStateUpdates;
+    private validatePrimaryKey;
+    private deriveAdaptableColumnStateFromAgGrid;
+    private checkShouldClearExistingFiltersOrSearches;
+    getGridCellFromRowNode(rowNode: IRowNode, columnId: string): GridCell | undefined;
+    getPrimaryKeyValueFromRowNode(rowNode: IRowNode, gridApi?: GridApi): string | number;
+    getRawValueFromRowNode(rowNode: IRowNode, columnId: string): any;
+    getDisplayValueFromRowNode(rowNode: IRowNode, columnId: string): string | undefined;
+    getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;
+    private getCleanValue;
+    getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
+    updateColumnModelAndRefreshGrid(config?: {
+        skipColDefsRefresh?: boolean;
+    }): void;
+    redrawBody(): void;
+    refreshHeader(): void;
+    redrawRows(rowNodes?: IRowNode[]): void;
+    redrawRow(rowNode: IRowNode): void;
+    refreshCells(rowNodes: IRowNode[], columns: (string | Column)[], forceUpdate: boolean, suppressFlash?: boolean): void;
+    refreshColumns(columns: (string | Column)[], forceUpdate: boolean, suppressFlash?: boolean): void;
+    jumpToRow(rowNode: IRowNode): void;
+    jumpToColumn(columnId: string): void;
+    jumpToCell(columnId: string, rowNode: IRowNode): void;
+    selectColumn(columnId: string, config?: {
+        keepExistingSelection?: boolean;
+    }): void;
+    selectColumns(columnIds: string[], config?: {
+        keepExistingSelection?: boolean;
+    }): void;
+    selectAll(): void;
+    deselectAll(): void;
+    setGridData(dataSource: any[]): void;
+    getGridData(): any[];
+    private addSyntheticPrimaryKey;
+    private addSyntheticPrimaryKeyIfMissing;
+    getFirstDisplayedRowNode(): IRowNode;
+    getFirstRowNode(): IRowNode | undefined;
+    updateRowGroupsExpandedState(layout?: Layout): void;
+    isGroupRowNode(rowNode: IRowNode): boolean;
+    getFilteredData(): any[];
+    updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;
+    addRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;
+    addOrUpdateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<{
+        added: IRowNode[];
+        updated: IRowNode[];
+    }>;
+    deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;
+    getRowNodeForPrimaryKey(primaryKeyValue: any): any;
+    hideColumn(columnId: string): void;
+    showColumn(columnId: string): void;
+    autoSizeColumn(columnId: string): void;
+    autoSizeColumns(columnIds: string[]): void;
+    autoSizeAllColumns(): void;
+    setColumnOrder(VisibleColumnList: string[]): void;
+    private getSortedColumnStateForVisibleColumns;
+    getDistinctValuesForColumn(column: AdaptableColumn, distinctValuesParams: DistinctValuesParams): GridCell[];
+    private getGridCellsForPermittedValues;
+    private getDistinctGridCellsForColumn;
+    private addDistinctColumnValue;
+    private getUniqueGridCells;
+    getGridCellsForColumn(columnId: string): GridCell[] | undefined;
+    getRowNodesForPrimaryKeys(primaryKeyValues: any[]): any[];
+    getRowNodeByIndex(index: number): IRowNode;
+    getAgGridStatusPanels(): import("@ag-grid-community/core").StatusPanelDef[];
+    setDataValue(value: any, column: AdaptableColumn, primaryKeyValue: any, rowNode?: IRowNode): void;
+    isCellEditable(rowNode: IRowNode, column: Column): boolean;
+    forAllRowNodesDo(func: (rowNode: IRowNode, rowIndex: number) => void, config?: {
+        includeGroupRows?: boolean;
+        filterFn?: (rowNode: IRowNode) => boolean;
+    }): void;
+    forAllVisibleRowNodesDo(func: (rowNode: IRowNode, rowIndex: number) => void, config?: {
+        includeGroupRows?: boolean;
+        filterFn?: (rowNode: IRowNode) => boolean;
+    }): void;
+    getAgGridRowModelType(): RowModelType;
+    getAllRowNodes(config?: {
+        includeGroupRows?: boolean;
+        filterFn?: (rowNode: IRowNode) => boolean;
+    }): IRowNode[];
+    getGroupRowNodes(): IRowNode[];
+    getRowsInViewport(): IRowNode[];
+    isRowNodeVisible(rowNode: IRowNode): boolean;
+    selectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;
+    deSelectNodes(rowNodes: IRowNode[], clearSelection: boolean): void;
+    selectNode(rowNode: IRowNode, clearSelection: boolean): void;
+    deSelectNode(rowNode: IRowNode, clearSelection: boolean): void;
+    selectCells(columnIds: string[], startNode: IRowNode, endNode: IRowNode, clearSelection?: boolean): void;
+    getAgGridColumnType(columnId: string): string | string[];
+    setColumnSort(columnSorts: ColumnSort[]): void;
+    clearColumnSort(): void;
+    hideFilterFormPopup: Function;
+    hideColumnFilterForm(): void;
+    clearColumnFiltering(): void;
+    clearColumnFilteringForColumns(columnIds: string[]): void;
+    canGenerateCharts(): boolean;
+    canDisplaySparklines(): boolean;
+    showCharts(chartsDefinitions: ChartDefinition[], chartContainer?: HTMLElement): ChartRef[];
+    showChart(chartDefinition: ChartDefinition, container?: HTMLElement): ChartRef;
+    updateChart(chart: ChartDefinition): void;
+    getChartModels(): import("@ag-grid-community/core").ChartModel[];
+    getRowCount(): number;
+    getColumnCount(): number;
+    getVisibleColumnCount(): number;
+    isGridGroupable(): boolean;
+    isGridGroupingActive(): boolean;
+    setAgGridQuickSearch(searchText: string): void;
+    getAgGridCurrentThemeName(): string;
+    private getAgGridLightThemeName;
+    applyAdaptableTheme(theme: AdaptableTheme | string): void;
+    setRowGroupColumns(columnIds: string[]): void;
+    getAgGridAllGridColumns(): Column<any>[];
+    clearRowGroupColumns(): void;
+    expandAllRowGroups(): void;
+    closeAllRowGroups(): void;
+    expandRowGroupsForValues(columnValues: any[]): void;
+    getExpandRowGroupsKeys(): any[];
+    getAgGridColumnForColumnId(columnId: string): Column;
+    getMinMaxCachedValueForColumn(column: AdaptableColumn, minMax: 'min' | 'max'): number;
+    getAgGridRegisteredModules(): Module[];
+    destroy(config?: {
+        unmount: boolean;
+        destroyApi?: boolean;
+    }): void;
+    canExportToExcel(): boolean;
+    exportToExcel(reportData: ReportData, fileName: string): void;
+    exportVisualDataToExcel(): void;
+    isQuickFilterAvailable(): boolean;
+    private hasFloatingFilterOnAtLeastOneColumn;
+    getChartRef(chartId: string): ChartRef;
+    setLayout(layout?: Layout): void;
+    private getActiveAdaptableAggFuncForCol;
+    /**
+     * Setting layout works by modifing the column state.
+     * The column state is based on the current existing columns.
+     * At this point the column groups do not exist, and the widths from layout are not applied.
+     *
+     * After the col sate is applied and the column groups are created we need
+     * to apply the state again to update the widths of the group columns.
+     */
+    private applyGroupColumnWidth;
+    private onRowDataChanged;
+    private onCellDataChanged;
+    private isUndoChange;
+    /**
+     * There are a few things that we need to do AFTER we edit a cell and it makes sense to put them in one place
+     */
+    private performPostEditChecks;
+    private refreshCellsBasedOnCellDataChange;
+    private refreshColumnForRelativeRangeStyledColumns;
+    private getStyledColumnComparisonChanges;
+    private getFormatColumnPredicateStyleChanges;
+    private getFormatColumnExpressionStylesChanges;
+    private checkChangedCellCurrentlySelected;
+    private resetMinMaxCachedValueForColumn;
+    private filterOnTickingDataChange;
+    private filterOnEditDataChange;
+    private shouldCreateDefaultLayout;
+    private createDefaultLayout;
+    private updateLayoutFromGrid;
+    private persistLayout;
+    /**
+     * When reading the state from the grid, we have to make sure 'avg' is not overriden with the 'avg' string.
+     */
+    private mapAggregationColumnsFromGrid;
+    private persistColumnIndexBeforeGrouping;
+    /**
+     * Restores the order previous grouping order.
+     */
+    private restoreUnGroupColumnOrder;
+    private onSortChanged;
+    private getColumnSorts;
+    setPinnedRows(pinnedRows: any, location: 'top' | 'bottom'): void;
+    setupRowSummaries(): void;
+}
+export {};