ag-grid-community 32.3.2 → 33.0.0

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

@@ -1,231 +0,0 @@
-import type { CellPosition } from '../entities/cellPositionUtils';
-import type { HeaderPosition } from '../headerRendering/common/headerPosition';
-import type { ChartToolbarMenuItemOptions } from './iChartOptions';
-import type { Column } from './iColumn';
-import type { AgGridCommon } from './iCommon';
-import type { IRowNode, RowPinnedType } from './iRowNode';
-import type { ServerSideTransaction } from './serverSideTransaction';
-export interface GetContextMenuItemsParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** Names of the items that would be provided by default. */
-    defaultItems: string[] | undefined;
-    /** The column, if a cell was clicked, otherwise null. */
-    column: Column | null;
-    /** The row node, if a cell was clicked, otherwise null. */
-    node: IRowNode<TData> | null;
-    /** The value, if a cell was clicked, otherwise null.  */
-    value: any;
-}
-export interface GetMainMenuItemsParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** The column that was clicked */
-    column: Column;
-    /** List of the items that would be displayed by default */
-    defaultItems: string[];
-}
-export interface GetChartMenuItemsParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** List of the items that would be displayed by default */
-    defaultItems: string[];
-}
-export interface ProcessUnpinnedColumnsParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    columns: Column[];
-    viewportWidth: number;
-}
-export interface PostProcessPopupParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** If popup is for a column, this gives the Column */
-    column?: Column | null;
-    /** If popup is for a row, this gives the RowNode */
-    rowNode?: IRowNode<TData> | null;
-    /** The popup we are showing */
-    ePopup: HTMLElement;
-    /**
-     * The different types are:
-     * 'contextMenu', 'columnMenu', 'aggFuncSelect', 'popupCellEditor', 'chart',
-     * 'advancedFilterBuilder', 'colorPicker', 'columnChooser', 'subMenu'
-     */
-    type: string;
-    /** If the popup is as a result of a button click (eg menu button),
-     *  this is the component that the user clicked */
-    eventSource?: HTMLElement | null;
-    /** If the popup is as a result of a click or touch,
-     *  this is the event - eg user showing context menu */
-    mouseEvent?: MouseEvent | Touch | null;
-}
-export interface SendToClipboardParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    data: string;
-}
-export interface ProcessDataFromClipboardParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** 2D array of all cells from the clipboard */
-    data: string[][];
-}
-export interface GetChartToolbarItemsParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    defaultItems?: ChartToolbarMenuItemOptions[];
-}
-export interface FocusGridInnerElementParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** This will be true if the focus is coming from and element below the grid in the DOM structure. */
-    fromBottom: boolean;
-}
-export interface NavigateToNextHeaderParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** The key for the arrow key pressed,
-     *  left = 'ArrowLeft', up = 'ArrowUp', right = 'ArrowRight', down = 'ArrowDown' */
-    key: string;
-    /** The header that currently has focus */
-    previousHeaderPosition: HeaderPosition | null;
-    /** The header the grid would normally pick as the next header for this navigation */
-    nextHeaderPosition: HeaderPosition | null;
-    /** The number of header rows present in the grid */
-    headerRowCount: number;
-    event: KeyboardEvent;
-}
-export interface TabToNextHeaderParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** True if the Shift key is also down */
-    backwards: boolean;
-    /** The header that currently has focus */
-    previousHeaderPosition: HeaderPosition | null;
-    /** The header the grid would normally pick as the next header for this navigation */
-    nextHeaderPosition: HeaderPosition | null;
-    /** The number of header rows present in the grid */
-    headerRowCount: number;
-}
-export interface TabToNextCellParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** True if the Shift key is also down */
-    backwards: boolean;
-    /** True if the current cell is editing
-     * (you may want to skip cells that are not editable, as the grid will enter the next cell in editing mode also if tabbing) */
-    editing: boolean;
-    /** The cell that currently has focus */
-    previousCellPosition: CellPosition;
-    /** The cell the grid would normally pick as the next cell for navigation.  */
-    nextCellPosition: CellPosition | null;
-}
-export interface NavigateToNextCellParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** The keycode for the arrow key pressed:
-     *  left = 'ArrowLeft', up = 'ArrowUp', right = 'ArrowRight', down = 'ArrowDown' */
-    key: string;
-    /** The cell that currently has focus */
-    previousCellPosition: CellPosition;
-    /** The cell the grid would normally pick as the next cell for navigation */
-    nextCellPosition: CellPosition | null;
-    event: KeyboardEvent | null;
-}
-export interface PaginationNumberFormatterParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    value: number;
-}
-export interface IsGroupOpenByDefaultParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** The row node being considered. */
-    rowNode: IRowNode<TData>;
-    /** The Column for which this row is grouping. */
-    rowGroupColumn: Column;
-    /** Same as `rowNode.level` - what level the group is at, e.g. 0 for top level, 1 for second etc */
-    level: number;
-    /** Same as `rowNode.field` - the field we are grouping on, e.g. 'country' */
-    field: string;
-    /** Same as `rowNode.key`, the value of this group, e.g. 'Ireland' */
-    key: string;
-}
-export interface GetServerSideGroupLevelParamsParams extends AgGridCommon<any, any> {
-    /** The level of the store. Top level is 0. */
-    level: number;
-    /** The Row Node for the group that got expanded, or undefined if top level (ie no parent) */
-    parentRowNode?: IRowNode;
-    /** Active Row Group Columns, if any. */
-    rowGroupColumns: Column[];
-    /** Active Pivot Columns, if any. */
-    pivotColumns: Column[];
-    /** true if pivot mode is active. */
-    pivotMode: boolean;
-}
-export interface IsServerSideGroupOpenByDefaultParams extends AgGridCommon<any, any> {
-    data: any;
-    rowNode: IRowNode;
-}
-export interface IsApplyServerSideTransactionParams extends AgGridCommon<any, any> {
-    /** The transaction getting applied. */
-    transaction: ServerSideTransaction;
-    /** The parent RowNode, if transaction is applied to a group. */
-    parentNode: IRowNode;
-    /** Store info, if any, as passed via the success() callback when loading data. */
-    groupLevelInfo: any;
-}
-export interface GetRowIdParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** The data item provided to the grid for the row in question */
-    data: TData;
-    /** Pinned state of the row */
-    rowPinned?: RowPinnedType;
-    /** If grouping, the level, ie how many levels from the top. Used by ServerSide Row Model only */
-    level: number;
-    /** If grouping, provides the keys of the parent groups. Used by ServerSide Row Model only */
-    parentKeys?: string[];
-}
-export type RenderedRowEvent = 'virtualRowRemoved';
-export interface ProcessRowParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    eRow: HTMLElement;
-    ePinnedLeftRow?: HTMLElement;
-    ePinnedRightRow?: HTMLElement;
-    rowIndex: number;
-    node: IRowNode<TData>;
-    addRenderedRowListener: (eventType: RenderedRowEvent, listener: (...args: any[]) => any) => void;
-}
-export interface FillOperationParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** The mouse event for the fill operation. */
-    event: MouseEvent;
-    /** The values that have been processed by the fill operation. */
-    values: any[];
-    /** The RowNode of the current cell being changed. */
-    rowNode: IRowNode<TData>;
-    /** The Column of the current cell being changed. */
-    column: Column;
-    /** The values that were present before processing started. */
-    initialValues: any[];
-    /** The values that were present before processing, without the aggregation function. */
-    initialNonAggregatedValues: any[];
-    /** The values that were present before processing, after being formatted by their value formatter */
-    initialFormattedValues: any[];
-    /** The index of the current processed value. */
-    currentIndex: number;
-    /** The value of the cell being currently processed by the Fill Operation. */
-    currentCellValue: any;
-    /** The direction of the Fill Operation. */
-    direction: 'up' | 'down' | 'left' | 'right';
-}
-export interface RowHeightParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** The data associated with this row from rowData. Data is `undefined` for row groups. */
-    data: TData | undefined;
-    /** The RowNode of the row in question. */
-    node: IRowNode<TData>;
-}
-export interface IsExternalFilterPresentParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-}
-export interface InitialGroupOrderComparatorParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    nodeA: IRowNode<TData>;
-    nodeB: IRowNode<TData>;
-}
-export interface GetGroupRowAggParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    nodes: IRowNode<TData>[];
-}
-export interface PostSortRowsParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    nodes: IRowNode<TData>[];
-}
-export interface IsFullWidthRowParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    rowNode: IRowNode<TData>;
-}
-export interface GetLocaleTextParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    key: string;
-    defaultValue: string;
-    variableValues?: string[];
-}
-export interface GetGroupAggFilteringParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    node: IRowNode<TData>;
-}
-export interface GetGroupIncludeFooterParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    node: IRowNode<TData>;
-}
-export interface GetGroupIncludeTotalRowParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    node: IRowNode<TData>;
-}
-export interface IMenuActionParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** The column, if a cell was clicked, otherwise null. */
-    column: Column | null;
-    /** The row node, if a cell was clicked, otherwise null. */
-    node: IRowNode<TData> | null;
-    /** The value, if a cell was clicked, otherwise null.  */
-    value: any;
-}

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

@@ -1,94 +0,0 @@
-import type { ColDef } from '../entities/colDef';
-import type { Column } from '../interfaces/iColumn';
-import type { AgGridCommon } from './iCommon';
-import type { IPopupComponent } from './iPopupComponent';
-import type { IRowNode } from './iRowNode';
-export interface BaseCellEditor {
-    /** Optional: Gets called once after initialised. If you return true, the editor will not be
-     * used and the grid will continue editing. Use this to make a decision on editing
-     * inside the init() function, eg maybe you want to only start editing if the user
-     * hits a numeric key, but not a letter, if the editor is for numbers.
-     */
-    isCancelBeforeStart?(): boolean;
-    /** Optional: Gets called once after editing is complete. If your return true, then the new
-     * value will not be used. The editing will have no impact on the record. Use this
-     * if you do not want a new value from your gui, i.e. you want to cancel the editing.
-     */
-    isCancelAfterEnd?(): boolean;
-    /**
-     * Optional: If doing full line edit, then gets called when focus should be put into the editor
-     */
-    focusIn?(): void;
-    /**
-     * Optional: If doing full line edit, then gets called when focus is leaving the editor
-     */
-    focusOut?(): void;
-}
-export interface ICellEditor<TValue = any> extends BaseCellEditor {
-    /**
-     * Return the final value - called by the grid once after editing is complete
-     */
-    getValue(): TValue | null | undefined;
-    /**
-     * Optional: Gets called with the latest cell editor params every time they update
-     */
-    refresh?(params: ICellEditorParams<any, TValue>): void;
-    /**
-     * Optional: A hook to perform any necessary operation just after the GUI for this component has been rendered on the screen.
-     * This method is called each time the edit component is activated.
-     * This is useful for any logic that requires attachment before executing, such as putting focus on a particular DOM element.
-     */
-    afterGuiAttached?(): void;
-    /** Optional: Gets called once after initialised. If you return true, the editor will
-     * appear in a popup, so is not constrained to the boundaries of the cell.
-     * This is great if you want to, for example, provide you own custom dropdown list
-     * for selection. Default is false (ie if you don't provide the method).
-     */
-    isPopup?(): boolean;
-    /** Optional: Gets called once, only if isPopup() returns true. Return "over" if the popup
-     * should cover the cell, or "under" if it should be positioned below leaving the
-     * cell value visible. If this method is not present, the default is "over".
-     */
-    getPopupPosition?(): 'over' | 'under' | undefined;
-}
-export interface ICellEditorParams<TData = any, TValue = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /** Current value of the cell */
-    value: TValue | null | undefined;
-    /** Key value of key that started the edit, eg 'Enter' or 'F2' - non-printable
-     *  characters appear here */
-    eventKey: string | null;
-    /** Grid column */
-    column: Column<TValue>;
-    /** Column definition */
-    colDef: ColDef<TData, TValue>;
-    /** Row node for the cell */
-    node: IRowNode<TData>;
-    /** Row data */
-    data: TData;
-    /** Editing row index */
-    rowIndex: number;
-    /** If doing full row edit, this is true if the cell is the one that started the edit
-     *  (eg it is the cell the use double clicked on, or pressed a key on etc). */
-    cellStartedEdit: boolean;
-    /** callback to tell grid a key was pressed - useful to pass control key events (tab,
-     *  arrows etc) back to grid - however you do */
-    onKeyDown: (event: KeyboardEvent) => void;
-    /** Callback to tell grid to stop editing the current cell. Call with input parameter
-     * true to prevent focus from moving to the next cell after editing stops in case the
-     * grid property `enterNavigatesVerticallyAfterEdit=true` */
-    stopEditing: (suppressNavigateAfterEdit?: boolean) => void;
-    /** A reference to the DOM element representing the grid cell that your component
-     *  will live inside. Useful if you want to add event listeners or classes at this level.
-     *  This is the DOM element that gets browser focus when selecting cells. */
-    eGridCell: HTMLElement;
-    /** Utility function to parse a value using the column's `colDef.valueParser` */
-    parseValue: (value: string) => TValue | null | undefined;
-    /** Utility function to format a value using the column's `colDef.valueFormatter` */
-    formatValue: (value: TValue | null | undefined) => string;
-}
-export interface ICellEditorComp<TData = any, TValue = any, TContext = any> extends ICellEditor<TValue>, IPopupComponent<ICellEditorParams<TData, TValue, TContext>> {
-}
-/** This is only used internally within the grid */
-export interface DefaultProvidedCellEditorParams {
-    suppressPreventDefault?: boolean;
-}

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

@@ -1,95 +0,0 @@
-export interface ChartGroupsDef {
-    columnGroup?: ('column' | 'stackedColumn' | 'normalizedColumn')[];
-    barGroup?: ('bar' | 'stackedBar' | 'normalizedBar')[];
-    pieGroup?: ('pie' | 'donut' | 'doughnut')[];
-    lineGroup?: 'line'[];
-    scatterGroup?: ('scatter' | 'bubble')[];
-    areaGroup?: ('area' | 'stackedArea' | 'normalizedArea')[];
-    combinationGroup?: ('columnLineCombo' | 'areaColumnCombo' | 'customCombo')[];
-    polarGroup?: ('radarLine' | 'radarArea' | 'nightingale' | 'radialColumn' | 'radialBar')[];
-    statisticalGroup?: ('boxPlot' | 'histogram' | 'rangeBar' | 'rangeArea')[];
-    hierarchicalGroup?: ('treemap' | 'sunburst')[];
-    specializedGroup?: ('heatmap' | 'waterfall')[];
-}
-export type ChartToolPanelName = 'settings' | 'data' | 'format';
-/** Configuration for the `Chart` panel */
-export interface ChartSettingsPanel {
-    /** Chart groups customisations for which charts are displayed in the chart panel */
-    chartGroupsDef?: ChartGroupsDef;
-}
-export type ChartFormatPanelGroup = 'chart' | 'titles' | 'legend' | 'axis' | 'horizontalAxis' | 'verticalAxis' | 'series' | 'navigator';
-export type ChartDataPanelGroup = 'categories' | 'series' | 'seriesChartType' | 'chartSpecific';
-export interface ChartPanelGroupDef<GroupType> {
-    /** The panel group type */
-    type: GroupType;
-    /** Whether the panel group is open by default. If not specified, it is closed */
-    isOpen?: boolean;
-}
-/** Configuration for the `Customize` panel */
-export interface ChartFormatPanel {
-    /** The customize panel group configurations, their order and whether they are shown. If not specified shows all groups */
-    groups?: ChartPanelGroupDef<ChartFormatPanelGroup>[];
-}
-/** Configuration for the `Set Up` panel */
-export interface ChartDataPanel {
-    /** The set up panel group configurations, their order and whether they are shown. If not specified shows all groups */
-    groups?: ChartPanelGroupDef<ChartDataPanelGroup>[];
-}
-export interface ChartToolPanelsDef {
-    /** Customisations for the chart panel and chart menu items in the Context Menu. */
-    settingsPanel?: ChartSettingsPanel;
-    /** Customisations for the customize panel */
-    formatPanel?: ChartFormatPanel;
-    /** Customisations for the set up panel */
-    dataPanel?: ChartDataPanel;
-    /** The ordered list of panels to show in the chart tool panels. If none specified, all panels are shown */
-    panels?: ChartToolPanelName[];
-    /** The panel to open by default when the chart loads. If none specified, the tool panel is hidden by default and the first panel is open when triggered. */
-    defaultToolPanel?: ChartToolPanelName;
-}
-export type CrossFilterChartType = 'column' | 'bar' | 'line' | 'scatter' | 'bubble' | 'pie' | 'donut' | 'doughnut' | 'area';
-export type ChartToolPanelMenuOptions = 'chartSettings' | 'chartData' | 'chartFormat';
-export type ChartToolbarMenuItemOptions = 'chartLink' | 'chartUnlink' | 'chartDownload' | 'chartMenu';
-export interface SeriesChartType {
-    colId: string;
-    chartType: ChartType;
-    secondaryAxis?: boolean;
-}
-export declare class ChartMappings {
-    static readonly CHART_TYPE_TO_SERIES_TYPE: {
-        readonly column: "bar";
-        readonly groupedColumn: "bar";
-        readonly stackedColumn: "bar";
-        readonly normalizedColumn: "bar";
-        readonly bar: "bar";
-        readonly groupedBar: "bar";
-        readonly stackedBar: "bar";
-        readonly normalizedBar: "bar";
-        readonly line: "line";
-        readonly scatter: "scatter";
-        readonly bubble: "bubble";
-        readonly pie: "pie";
-        readonly donut: "donut";
-        readonly doughnut: "donut";
-        readonly area: "area";
-        readonly stackedArea: "area";
-        readonly normalizedArea: "area";
-        readonly histogram: "histogram";
-        readonly radarLine: "radar-line";
-        readonly radarArea: "radar-area";
-        readonly nightingale: "nightingale";
-        readonly radialColumn: "radial-column";
-        readonly radialBar: "radial-bar";
-        readonly sunburst: "sunburst";
-        readonly rangeBar: "range-bar";
-        readonly rangeArea: "range-area";
-        readonly boxPlot: "box-plot";
-        readonly treemap: "treemap";
-        readonly heatmap: "heatmap";
-        readonly waterfall: "waterfall";
-    };
-    static readonly COMBO_CHART_TYPES: readonly ["columnLineCombo", "areaColumnCombo", "customCombo"];
-    static readonly SERIES_GROUP_TYPES: readonly ["grouped", "stacked", "normalized"];
-}
-export type ChartType = keyof typeof ChartMappings.CHART_TYPE_TO_SERIES_TYPE | (typeof ChartMappings.COMBO_CHART_TYPES)[number];
-export type SeriesGroupType = (typeof ChartMappings.SERIES_GROUP_TYPES)[number];

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

@@ -1,52 +0,0 @@
-import type { RowNode } from '../entities/rowNode';
-import type { RowHighlightPosition } from '../interfaces/iRowNode';
-import type { ChangedPath } from '../utils/changedPath';
-import type { IRowModel } from './iRowModel';
-import type { RowDataTransaction } from './rowDataTransaction';
-import type { RowNodeTransaction } from './rowNodeTransaction';
-export type ClientSideRowModelStep = 'everything' | 'group' | 'filter' | 'sort' | 'map' | 'aggregate' | 'filter_aggregates' | 'pivot' | 'nothing';
-export declare enum ClientSideRowModelSteps {
-    EVERYTHING = "group",
-    FILTER = "filter",
-    SORT = "sort",
-    MAP = "map",
-    AGGREGATE = "aggregate",
-    FILTER_AGGREGATES = "filter_aggregates",
-    PIVOT = "pivot",
-    NOTHING = "nothing"
-}
-export interface IClientSideRowModel<TData = any> extends IRowModel {
-    onRowGroupOpened(): void;
-    updateRowData(rowDataTran: RowDataTransaction<TData>): RowNodeTransaction<TData> | null;
-    setRowData(rowData: any[]): void;
-    refreshModel(paramsOrStep: RefreshModelParams | ClientSideRowModelStep | undefined): void;
-    expandOrCollapseAll(expand: boolean): void;
-    forEachLeafNode(callback: (node: RowNode, index: number) => void): void;
-    forEachNodeAfterFilter(callback: (node: RowNode, index: number) => void, includeFooterNodes?: boolean): void;
-    forEachNodeAfterFilterAndSort(callback: (node: RowNode, index: number) => void, includeFooterNodes?: boolean): void;
-    forEachPivotNode(callback: (node: RowNode, index: number) => void, includeFooterNodes?: boolean): void;
-    resetRowHeights(): void;
-    onRowHeightChanged(): void;
-    onRowHeightChangedDebounced(): void;
-    batchUpdateRowData(rowDataTransaction: RowDataTransaction<TData>, callback?: (res: RowNodeTransaction<TData>) => void): void;
-    flushAsyncTransactions(): void;
-    getRootNode(): RowNode;
-    doAggregate(changedPath?: ChangedPath): void;
-    getTopLevelNodes(): RowNode[] | null;
-    ensureRowsAtPixel(rowNode: RowNode[], pixel: number, increment: number): boolean;
-    highlightRowAtPixel(rowNode: RowNode | null, pixel?: number): void;
-    getHighlightPosition(pixel: number, rowNode?: RowNode): RowHighlightPosition;
-    getLastHighlightedRowNode(): RowNode | null;
-    isRowDataLoaded(): boolean;
-}
-export interface RefreshModelParams<TData = any> {
-    step: ClientSideRowModelSteps;
-    keepRenderedRows?: boolean;
-    animate?: boolean;
-    keepEditingRows?: boolean;
-    rowNodeTransactions?: RowNodeTransaction<TData>[];
-    rowNodesOrderChanged?: boolean;
-    newData?: boolean;
-    afterColumnsChanged?: boolean;
-    keepUndoRedoStack?: boolean;
-}