@mui/x-data-grid-premium/typeOverloads/modules.d.ts

The Premium plan edition of the Data Grid Components (MUI X).

import { GridValidRowModel } from '@mui/x-data-grid-pro';
import type { GridControlledStateEventLookupPro, GridApiCachesPro, GridEventLookupPro } from '@mui/x-data-grid-pro/typeOverloads';
import type { GridGroupingValueGetter, GridPastedValueParser } from '../models';
import type { GridRowGroupingModel, GridAggregationModel, GridAggregationCellMeta, GridAggregationHeaderMeta, GridCellSelectionModel } from '../hooks';
import { GridRowGroupingInternalCache } from '../hooks/features/rowGrouping/gridRowGroupingInterfaces';
import { GridAggregationInternalCache } from '../hooks/features/aggregation/gridAggregationInterfaces';
export interface GridControlledStateEventLookupPremium {
    /**
     * Fired when the aggregation model changes.
     */
    aggregationModelChange: {
        params: GridAggregationModel;
    };
    /**
     * Fired when the row grouping model changes.
     */
    rowGroupingModelChange: {
        params: GridRowGroupingModel;
    };
    /**
     * Fired when the selection state of one or multiple cells change.
     */
    cellSelectionChange: {
        params: GridCellSelectionModel;
    };
    /**
     * Fired when the state of the Excel export task changes
     */
    excelExportStateChange: {
        params: 'pending' | 'finished';
    };
}
interface GridEventLookupPremium extends GridEventLookupPro {
    /**
     * Fired when the clipboard paste operation starts.
     */
    clipboardPasteStart: {
        params: {
            data: string[][];
        };
    };
    /**
     * Fired when the clipboard paste operation ends.
     */
    clipboardPasteEnd: {};
}
export interface GridColDefPremium<R extends GridValidRowModel = any, V = any, F = V> {
    /**
     * If `true`, the cells of the column can be aggregated based.
     * @default true
     */
    aggregable?: boolean;
    /**
     * Limit the aggregation function usable on this column.
     * By default, the column will have all the aggregation functions that are compatible with its type.
     */
    availableAggregationFunctions?: string[];
    /**
     * Function that transforms a complex cell value into a key that be used for grouping the rows.
     * @returns {GridKeyValue | null | undefined} The cell key.
     */
    groupingValueGetter?: GridGroupingValueGetter<R>;
    /**
     * Function that takes the clipboard-pasted value and converts it to a value used internally.
     * @returns {V} The converted value.
     */
    pastedValueParser?: GridPastedValueParser<R, V, F>;
}
export interface GridRenderCellParamsPremium<R extends GridValidRowModel = any, V = any, F = V> {
    aggregation?: GridAggregationCellMeta;
}
export interface GridColumnHeaderParamsPremium<R extends GridValidRowModel = any, V = any, F = V> {
    aggregation?: GridAggregationHeaderMeta;
}
export interface GridApiCachesPremium extends GridApiCachesPro {
    rowGrouping: GridRowGroupingInternalCache;
    aggregation: GridAggregationInternalCache;
}
declare module '@mui/x-data-grid-pro' {
    interface GridEventLookup extends GridEventLookupPremium {
    }
    interface GridControlledStateEventLookup extends GridControlledStateEventLookupPro, GridControlledStateEventLookupPremium {
    }
    interface GridRenderCellParams<R, V, F> extends GridRenderCellParamsPremium<R, V, F> {
    }
    interface GridColumnHeaderParams<R, V, F> extends GridColumnHeaderParamsPremium<R, V, F> {
    }
    interface GridApiCaches extends GridApiCachesPremium {
    }
}
declare module '@mui/x-data-grid-pro/internals' {
    interface GridApiCaches extends GridApiCachesPremium {
    }
    interface GridBaseColDef<R, V, F> extends GridColDefPremium<R, V, F> {
    }
}
export {};