ag-grid-community 32.3.2 → 33.0.0

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

@@ -1,48 +0,0 @@
-import type { RowNode } from '../entities/rowNode';
-import type { SelectionEventSourceType } from '../events';
-import type { ChangedPath } from '../utils/changedPath';
-import type { ServerSideRowGroupSelectionState, ServerSideRowSelectionState } from './selectionState';
-export interface ISelectionService {
-    getSelectionState(): string[] | ServerSideRowSelectionState | ServerSideRowGroupSelectionState | null;
-    setSelectionState(state: string[] | ServerSideRowSelectionState | ServerSideRowGroupSelectionState, source: SelectionEventSourceType): void;
-    getSelectedNodes(): RowNode<any>[];
-    getSelectedRows(): any[];
-    getSelectionCount(): number;
-    setNodesSelected(params: ISetNodesSelectedParams): number;
-    filterFromSelection(predicate: (node: RowNode) => boolean): void;
-    updateGroupsFromChildrenSelections(source: SelectionEventSourceType, changedPath?: ChangedPath): boolean;
-    syncInRowNode(rowNode: RowNode, oldNode: RowNode | null): void;
-    reset(source: SelectionEventSourceType): void;
-    getBestCostNodeSelection(): RowNode[] | undefined;
-    isEmpty(): boolean;
-    /**
-     * @param justFiltered whether to just include nodes which have passed the filter
-     * @param justCurrentPage whether to just include nodes on the current page
-     * @returns all nodes including unselectable nodes which are the target of this selection attempt
-     */
-    getSelectAllState(justFiltered?: boolean, justCurrentPage?: boolean): boolean | null;
-    hasNodesToSelect(justFiltered?: boolean, justCurrentPage?: boolean): boolean;
-    selectAllRowNodes(params: {
-        source: SelectionEventSourceType;
-        justFiltered?: boolean;
-        justCurrentPage?: boolean;
-    }): void;
-    deselectAllRowNodes(params: {
-        source: SelectionEventSourceType;
-        justFiltered?: boolean;
-        justCurrentPage?: boolean;
-    }): void;
-}
-interface INodeSelectionParams {
-    newValue: boolean;
-    clearSelection?: boolean;
-    suppressFinishActions?: boolean;
-    rangeSelect?: boolean;
-    groupSelectsFiltered?: boolean;
-    source: SelectionEventSourceType;
-    event?: Event;
-}
-export interface ISetNodesSelectedParams extends INodeSelectionParams {
-    nodes: RowNode[];
-}
-export {};

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

@@ -1,59 +0,0 @@
-import type { LoadSuccessParams } from '../rowNodeCache/iRowNodeBlock';
-import type { SortModelItem } from '../sortController';
-import type { AdvancedFilterModel } from './advancedFilterModel';
-import type { ColumnVO } from './iColumnVO';
-import type { AgGridCommon } from './iCommon';
-import type { FilterModel } from './iFilter';
-import type { IRowNode } from './iRowNode';
-export interface IServerSideGetRowsRequest {
-    /** First row requested or undefined for all rows. */
-    startRow: number | undefined;
-    /** Index after the last row required row or undefined for all rows. */
-    endRow: number | undefined;
-    /** Columns that are currently row grouped.  */
-    rowGroupCols: ColumnVO[];
-    /** Columns that have aggregations on them.  */
-    valueCols: ColumnVO[];
-    /** Columns that have pivot on them.  */
-    pivotCols: ColumnVO[];
-    /** Defines if pivot mode is on or off.  */
-    pivotMode: boolean;
-    /** What groups the user is viewing.  */
-    groupKeys: string[];
-    /**
-     * If filtering, what the filter model is.
-     * If Advanced Filter is enabled, will be of type `AdvancedFilterModel | null`.
-     * If Advanced Filter is disabled, will be of type `FilterModel`.
-     */
-    filterModel: FilterModel | AdvancedFilterModel | null;
-    /** If sorting, what the sort model is.  */
-    sortModel: SortModelItem[];
-}
-export interface IServerSideGetRowsParams<TData = any, TContext = any> extends AgGridCommon<TData, TContext> {
-    /**
-     * Details for the request. A simple object that can be converted to JSON.
-     */
-    request: IServerSideGetRowsRequest;
-    /**
-     * The parent row node. The RootNode (level -1) if request is top level.
-     * This is NOT part fo the request as it cannot be serialised to JSON (a rowNode has methods).
-     */
-    parentNode: IRowNode;
-    /**
-     * Success callback, pass the rows back to the grid that were requested.
-     */
-    success(params: LoadSuccessParams): void;
-    /**
-     * Fail callback, tell the grid the call failed so it can adjust it's state.
-     */
-    fail(): void;
-}
-export interface IServerSideDatasource {
-    /**
-     * Grid calls `getRows` when it requires more rows as specified in the params.
-     * Params object contains callbacks for responding to the request.
-     */
-    getRows(params: IServerSideGetRowsParams): void;
-    /** Optional method, if your datasource has state it needs to clean up. */
-    destroy?(): void;
-}

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

@@ -1,38 +0,0 @@
-import type { LoadSuccessParams } from '../rowNodeCache/iRowNodeBlock';
-import type { ServerSideGroupLevelState } from './IServerSideStore';
-import type { IRowModel } from './iRowModel';
-import type { IRowNode } from './iRowNode';
-import type { IServerSideDatasource } from './iServerSideDatasource';
-import type { ServerSideTransaction, ServerSideTransactionResult } from './serverSideTransaction';
-export interface IServerSideRowModel extends IRowModel {
-    refreshStore(params?: RefreshServerSideParams): void;
-    onRowHeightChanged(): void;
-    onRowHeightChangedDebounced(): void;
-    getStoreState(): ServerSideGroupLevelState[];
-    retryLoads(): void;
-    expandAll(value: boolean): void;
-    setDatasource(datasource: IServerSideDatasource): void;
-    forEachNodeAfterFilterAndSort(callback: (node: IRowNode, index: number) => void, includeFooterNodes?: boolean): void;
-    resetRootStore(): void;
-    getBlockStates(): void;
-    setRowCount(rowCount: number, isLastRowIndexKnown?: boolean): void;
-    applyRowData(rowDataParams: LoadSuccessParams, startRow: number, route: string[]): void;
-}
-export interface IServerSideTransactionManager {
-    applyTransaction(transaction: ServerSideTransaction): ServerSideTransactionResult | undefined;
-    applyTransactionAsync(transaction: ServerSideTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
-    flushAsyncTransactions(): void;
-}
-export interface RefreshServerSideParams {
-    /**
-     * List of group keys, pointing to the level to refresh.
-     * For example, to purge two levels down under 'Canada'and then '2002', pass in the string array ['Canada','2002'].
-     * If no route is passed, or an empty array, then the top level is refreshed.
-     */
-    route?: string[];
-    /**
-     * If true, then all rows at the level getting refreshed are immediately destroyed and 'loading' rows will appear.
-     * If false, then all rows at the level getting refreshed are kept until rows are loaded (no 'loading' rows appear).
-     */
-    purge?: boolean;
-}

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

@@ -1,203 +0,0 @@
-import type { ColDef, KeyCreatorParams, ValueFormatterParams } from '../entities/colDef';
-import type { IProvidedFilter, IProvidedFilterParams } from '../filter/provided/iProvidedFilter';
-import type { Column } from '../interfaces/iColumn';
-import type { ITooltipParams } from '../rendering/tooltipComponent';
-import type { AgPromise } from '../utils/promise';
-import type { AgGridCommon } from './iCommon';
-import type { IFilterParams, ProvidedFilterModel } from './iFilter';
-export type SetFilterModelValue = (string | null)[];
-export interface SetFilterModel extends ProvidedFilterModel {
-    filterType?: 'set';
-    values: SetFilterModelValue;
-}
-/**
- * Interface contract for the public aspects of the SetFilter implementation.
- * @param V type of value in the Set Filter
- */
-export interface ISetFilter<V = string> extends IProvidedFilter {
-    /**
-     * Returns a model representing the current state of the filter, or `null` if the filter is
-     * not active.
-     */
-    getModel(): SetFilterModel | null;
-    /**
-     * Sets the state of the filter using the supplied model. Providing `null` as the model will
-     * de-activate the filter.
-     *
-     * **Note:** if you are [providing values asynchronously](/filter-set-filter-list/#asynchronous-values)
-     * to the Set Filter, you need to wait for these changes to be applied before performing any further
-     * actions by waiting on the returned grid promise, e.g.
-     * `filter.setModel({ values: ['a', 'b'] }).then(function() { gridApi.onFilterChanged(); });`
-     */
-    setModel(model: SetFilterModel | null): AgPromise<void>;
-    /** Returns the full list of unique keys used by the Set Filter. */
-    getFilterKeys(): SetFilterModelValue;
-    /** Returns the full list of unique values used by the Set Filter. */
-    getFilterValues(): (V | null)[];
-    /** Sets the values used in the Set Filter on the fly. */
-    setFilterValues(values: (V | null)[]): void;
-    /**
-     * Refreshes the values shown in the filter from the original source. For example, if a
-     * callback was provided, the callback will be executed again and the filter will refresh using
-     * the values returned.
-     */
-    refreshFilterValues(): void;
-    /**
-     * Resets the Set Filter to use values from the grid, rather than any values that have been
-     * provided directly.
-     */
-    resetFilterValues(): void;
-    /** Returns the current mini-filter text. */
-    getMiniFilter(): string | null;
-    /** Sets the text in the Mini Filter at the top of the filter (the 'quick search' in the popup). */
-    setMiniFilter(newMiniFilter: string | null): void;
-    /** Returns the current UI state (potentially un-applied). */
-    getModelFromUi(): SetFilterModel | null;
-}
-/**
- * @param TData type of data row
- * @param V type of value in the Set Filter
- */
-export interface SetFilterValuesFuncParams<TData = any, V = string> extends AgGridCommon<TData, any> {
-    /** The function to call with the values to load into the filter once they are ready. */
-    success: (values: (V | null)[]) => void;
-    /** The column definition from which the set filter is invoked. */
-    colDef: ColDef<TData>;
-    /** Column from which the set filter is invoked. */
-    column: Column;
-}
-/**
- * @param TData type of data row
- * @param V type of value in the Set Filter
- */
-export type SetFilterValuesFunc<TData = any, V = string> = (params: SetFilterValuesFuncParams<TData, V>) => void;
-/**
- * @param TData type of data row
- * @param V type of value in the Set Filter
- */
-export type SetFilterValues<TData = any, V = string> = SetFilterValuesFunc<TData, V> | (V | null)[];
-/**
- * Parameters provided by the grid to the `init` method of a `SetFilter`.
- * Do not use in `colDef.filterParams` - see `ISetFilterParams` instead.
- */
-export type SetFilterParams<TData = any, V = string> = ISetFilterParams<TData, V> & IFilterParams<TData>;
-/**
- * Parameters used in `colDef.filterParams` to configure a Set Filter (`agSetColumnFilter`).
- * @param TData type of data row
- * @param V type of value in the Set Filter
- */
-export interface ISetFilterParams<TData = any, V = string> extends IProvidedFilterParams {
-    /**
-     * The values to display in the Filter List. If this is not set, the filter will takes its
-     * values from what is loaded in the table.
-     */
-    values?: SetFilterValues<TData, V>;
-    /**
-     * Refresh the values every time the Set filter is opened.
-     */
-    refreshValuesOnOpen?: boolean;
-    /** The height of values in the Filter List in pixels. */
-    cellHeight?: number;
-    /**
-     * If `true`, the Set Filter values will not be sorted. Use this if you are providing your own
-     * values and don't want them sorted as you are providing in the order you want.
-     *
-     * @default false
-     */
-    suppressSorting?: boolean;
-    /**
-     * Similar to the Cell Renderer for the grid. Setting it separately here allows for the value to
-     * be rendered differently in the filter.
-     */
-    cellRenderer?: any;
-    /**
-     * Set to `true` to hide the Mini Filter.
-     *
-     * @default false
-     */
-    suppressMiniFilter?: boolean;
-    /**
-     * Set to `true` to apply the Set Filter immediately when the user is typing in the Mini Filter.
-     *
-     * @default false
-     */
-    applyMiniFilterWhileTyping?: boolean;
-    /**
-     * Set to `true` to remove the Select All checkbox.
-     * @default false
-     */
-    suppressSelectAll?: boolean;
-    /**
-     * By default, when the Set Filter is opened all values are shown selected. Set this to `true`
-     * to instead show all values as de-selected by default.
-     *
-     * This does not work when `excelMode` is enabled.
-     */
-    defaultToNothingSelected?: boolean;
-    /**
-     * Comparator for sorting. If not provided, the Column Definition comparator is used. If Column
-     * Definition comparator is also not provided, the default (grid provided) comparator is used.
-     */
-    comparator?: (a: V | null, b: V | null) => number;
-    /**
-     * If specified, this formats the text before applying the Mini Filter compare logic, useful for
-     * instance to substitute accented characters.
-     */
-    textFormatter?: (from: string) => string;
-    /**
-     * If specified, this formats the value before it is displayed in the Filter List.
-     * If a Key Creator is provided (see `keyCreator`), this must also be provided.
-     */
-    valueFormatter?: (params: ValueFormatterParams) => string;
-    /**
-     * Function to return a string key for a value. This is required when the filter values are complex objects,
-     * or when `treeList = true` and the column is a group column with Tree Data or Grouping enabled.
-     * If not provided, the Column Definition Key Creator is used.
-     */
-    keyCreator?: (params: KeyCreatorParams<TData>) => string;
-    /**
-     * If `true`, hovering over a value in the Set Filter will show a tooltip containing the full,
-     * untruncated value.
-     *
-     * @default false
-     */
-    showTooltips?: boolean;
-    /**
-     * If `true`, enables case-sensitivity in the SetFilter Mini-Filter and Filter List.
-     * @default false
-     */
-    caseSensitive?: boolean;
-    /**
-     * Changes the behaviour of the Set Filter to match that of Excel's AutoFilter.
-     */
-    excelMode?: 'mac' | 'windows';
-    /**
-     * If `true`, the Set Filter List will be displayed in a tree format. If enabled, one of the following must be true:
-     *
-     * - A `treeListPathGetter` is provided to get the tree path for the column values.
-     * - The column values are of type `Date`, in which case the tree will be year -> month -> day.
-     * - Tree Data mode is enabled and the column is the group column. The Filter List will match the tree structure. A Key Creator must be supplied.
-     * - Grouping is enabled and the column is the group column. The Filter List will match the group structure. A Key Creator must be supplied.
-     */
-    treeList?: boolean;
-    /**
-     * Requires `treeList = true`. If provided, this gets the tree path to display in the Set Filter List based on the column values.
-     * Each row must map to a leaf value in the tree.
-     */
-    treeListPathGetter?: (value: V | null) => string[] | null;
-    /**
-     * Requires `treeList = true`. If specified, this formats the tree values before they are displayed in the Filter List.
-     * @param pathKey - The key for the current node in the tree.
-     * @param level - The level of the current node in the tree (starting at 0).
-     * @param parentPathKeys - The keys of the parent nodes up until the current node (exclusive).
-     * This will be an empty array if the node is at the root level.
-     */
-    treeListFormatter?: (pathKey: string | null, level: number, parentPathKeys: (string | null)[]) => string;
-}
-/**
- * Tooltip params used with the Set Filter Tree List.
- */
-export interface ISetFilterTreeListTooltipParams extends ITooltipParams {
-    /** Level of the tree (starting at 0). */
-    level: number;
-}

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

@@ -1,10 +0,0 @@
-import type { AgColumn } from '../entities/agColumn';
-import type { ComponentSelector } from '../widgets/component';
-export interface IShowRowGroupColsService {
-    refresh(): void;
-    getShowRowGroupCols(): AgColumn[];
-    getShowRowGroupCol(id: string): AgColumn | undefined;
-}
-export interface IColumnDropZonesService {
-    getDropZoneSelector(): ComponentSelector;
-}

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

@@ -1,62 +0,0 @@
-import type { ComponentSelector } from '../widgets/component';
-import type { SideBarState } from './gridState';
-import type { IToolPanel } from './iToolPanel';
-export interface ISideBarService {
-    getSideBarComp(): ISideBar;
-    getSideBarSelector(): ComponentSelector;
-}
-export interface ISideBar {
-    refresh(): void;
-    setDisplayed(show: boolean): void;
-    setSideBarPosition(position?: 'left' | 'right'): void;
-    isToolPanelShowing(): boolean;
-    openToolPanel(key: string, source?: 'sideBarButtonClicked' | 'sideBarInitializing' | 'api'): void;
-    getToolPanelInstance(key: string): IToolPanel | undefined;
-    close(source?: 'sideBarButtonClicked' | 'sideBarInitializing' | 'api'): void;
-    openedItem(): string | null;
-    isDisplayed(): boolean;
-    getDef(): SideBarDef | undefined;
-    getState(): SideBarState;
-}
-export interface ToolPanelDef {
-    /** The unique ID for this panel. Used in the API and elsewhere to refer to the panel. */
-    id: string;
-    /** The key used for localisation for displaying the label. The label is displayed in the tab button. */
-    labelKey: string;
-    /** The default label if `labelKey` is missing or does not map to valid text through localisation. */
-    labelDefault: string;
-    /**
-     * The min width of the tool panel.
-     * @default 100
-     */
-    minWidth?: number;
-    /** The max width of the tool panel. */
-    maxWidth?: number;
-    /**
-     * The initial width of the tool panel.
-     * @default $side-bar-panel-width (theme variable)
-     */
-    width?: number;
-    /** The key of the icon to be used as a graphical aid beside the label in the side bar. */
-    iconKey: string;
-    /**
-     * The tool panel component to use as the panel.
-     * The provided panels use components `agColumnsToolPanel` and `agFiltersToolPanel`.
-     * To provide your own custom panel component, you reference it here.
-     */
-    toolPanel?: any;
-    /** Customise the parameters provided to the `toolPanel` component. */
-    toolPanelParams?: any;
-}
-export interface SideBarDef {
-    /**
-     * A list of all the panels to place in the side bar. The panels will be displayed in the provided order from top to bottom.
-     */
-    toolPanels?: (ToolPanelDef | string)[];
-    /** The panel (identified by ID) to open by default. If none specified, the side bar is initially displayed closed. */
-    defaultToolPanel?: string;
-    /** To hide the side bar by default, set this to `true`. If left undefined the side bar will be shown. */
-    hiddenByDefault?: boolean;
-    /** Sets the side bar position relative to the grid. */
-    position?: 'left' | 'right';
-}