rowvia 0.1.0

package/dist/types/types.d.ts

@@ -0,0 +1,889 @@
+/**
+ * rowvia public types — API mirrors ag-grid Community/Enterprise.
+ */
+export type RowModelType = 'clientSide' | 'infinite' | 'serverSide' | 'viewport';
+export type RowSelectionMode = 'single' | 'multiple';
+export type SortDirection = 'asc' | 'desc' | null;
+export type ColType = 'textColumn' | 'numberColumn' | 'numericColumn' | 'dateColumn' | 'booleanColumn' | 'dateStringColumn' | 'rightAligned';
+export type PinPosition = 'left' | 'right' | null;
+export type AggFunc = string | ((params: AggFuncParams) => any);
+export interface AggFuncParams {
+    values: any[];
+    column: Column;
+    rowNode: RowNode;
+    data: any;
+}
+export type FilterType = 'text' | 'number' | 'date' | 'set' | 'boolean' | 'floating';
+export interface ColumnFilterParams {
+    values?: any[];
+    suppressSorting?: boolean;
+    buttons?: string[];
+    closeOnApply?: boolean;
+    debounceMs?: number;
+    valueFormatter?: (params: any) => string;
+    cellRenderer?: any;
+    cellRendererParams?: any;
+    inRangeInclusive?: boolean;
+}
+export interface CellEditorParams {
+    values?: any[];
+    min?: number;
+    max?: number;
+    precision?: number;
+    step?: number;
+    showStepperButtons?: boolean;
+    allowTyping?: boolean;
+    searchType?: 'matchAny' | 'matchAll';
+    filterList?: boolean;
+    highlightMatch?: boolean;
+    cellRenderer?: any;
+    [key: string]: any;
+}
+export interface ValueFormatterParams {
+    value: any;
+    data: any;
+    node: RowNode;
+    column: Column;
+    api: GridApi;
+    colDef: ColDef;
+}
+export interface ValueGetterParams {
+    data: any;
+    node: RowNode;
+    column: Column;
+    api: GridApi;
+    colDef: ColDef;
+    getValue: (field: string) => any;
+}
+export interface ValueSetterParams {
+    oldValue: any;
+    newValue: any;
+    data: any;
+    node: RowNode;
+    column: Column;
+    api: GridApi;
+    colDef: ColDef;
+}
+export interface CellClassParams {
+    value: any;
+    data: any;
+    node: RowNode;
+    column: Column;
+    rowIndex: number;
+    api: GridApi;
+}
+export interface ComparatorParams {
+    valueA: any;
+    valueB: any;
+    nodeA: RowNode;
+    nodeB: RowNode;
+}
+export interface CellRendererParams {
+    value: any;
+    valueFormatted: string | null;
+    data: any;
+    node: RowNode;
+    column: Column;
+    rowIndex: number;
+    api: GridApi;
+    colDef: ColDef;
+    eGridCell: HTMLElement;
+    registerRowDragger?: (cb: (e: MouseEvent) => void) => void;
+}
+export interface ICellRenderer {
+    getGui(): HTMLElement;
+    refresh?(params: CellRendererParams): boolean;
+    destroy?(): void;
+}
+export type CellRendererFunc = (params: CellRendererParams) => HTMLElement | ICellRenderer | string | void;
+export interface ICellEditor {
+    getGui(): HTMLElement;
+    getValue(): any;
+    isCancelBeforeStart?(): boolean;
+    isCancelAfterEnd?(): boolean;
+    focusIn?(): void;
+    afterGuiAttached?(): void;
+    destroy?(): void;
+}
+export type CellEditorFunc = (params: any) => HTMLElement | ICellEditor | string;
+export interface TooltipParams {
+    value: any;
+    valueFormatted: string | null;
+    data: any;
+    node: RowNode;
+    column: Column;
+    api: GridApi;
+    colDef: ColDef;
+}
+export interface ColDef {
+    /** column group children (spanning headers) */
+    children?: ColDef[];
+    /** id of this column group (spanning headers) */
+    groupId?: string;
+    openByDefault?: boolean;
+    columnGroupShow?: 'open' | 'closed';
+    field?: string;
+    colId?: string;
+    headerName?: string;
+    headerTooltip?: string;
+    width?: number;
+    minWidth?: number;
+    maxWidth?: number;
+    flex?: number;
+    /** initial flex when sizeColumnsToFit is used */
+    initialFlex?: number;
+    pinned?: PinPosition;
+    hide?: boolean;
+    initialHide?: boolean;
+    lockPosition?: 'left' | 'right' | true | false;
+    type?: ColType;
+    sortable?: boolean;
+    unSortIcon?: boolean;
+    sort?: SortDirection;
+    sortIndex?: number | null;
+    resizable?: boolean;
+    filter?: boolean | FilterType | string;
+    floatingFilter?: boolean;
+    filterParams?: ColumnFilterParams;
+    editable?: boolean | ((params: any) => boolean);
+    cellEditor?: CellEditorFunc | string;
+    cellEditorParams?: CellEditorParams;
+    cellEditorPopup?: boolean;
+    singleClickEdit?: boolean;
+    valueSetter?: (params: ValueSetterParams) => boolean;
+    valueGetter?: string | ((params: ValueGetterParams) => any);
+    valueFormatter?: string | ((params: ValueFormatterParams) => string | null);
+    valueParser?: string | ((params: any) => any);
+    tooltipField?: string;
+    tooltipValueGetter?: (params: TooltipParams) => string;
+    comparator?: (valueA: any, valueB: any, nodeA?: RowNode, nodeB?: RowNode) => number;
+    aggFunc?: AggFunc;
+    /** Show Values As — display the value as a percentage of the column total */
+    showValueAs?: 'percentOfTotal' | 'percentOfParent';
+    enableRowGroup?: boolean;
+    rowGroup?: boolean;
+    rowGroupIndex?: number | null;
+    enablePivot?: boolean;
+    pivot?: boolean;
+    pivotIndex?: number | null;
+    enableValue?: boolean;
+    allowedAggFuncs?: string[];
+    showRowGroup?: boolean | string;
+    suppressCount?: boolean;
+    /** span this cell across N columns (column spanning) */
+    colSpan?: (params: CellClassParams) => number;
+    /** reference data shared between editors and filters */
+    refData?: Record<string, any>;
+    /** expression field (evaluated, e.g. 'price * quantity') */
+    expression?: boolean;
+    /** cell note text (or a function returning it) */
+    note?: string | ((params: any) => string | undefined);
+    cellRenderer?: CellRendererFunc | string;
+    cellRendererParams?: any;
+    cellClass?: string | string[] | ((params: CellClassParams) => string | string[] | undefined);
+    cellStyle?: Record<string, any> | ((params: CellClassParams) => Record<string, any>);
+    cellDataType?: boolean;
+    cellClassRules?: Record<string, (params: CellClassParams) => boolean>;
+    rowDrag?: boolean;
+    checkboxSelection?: boolean;
+    headerCheckboxSelection?: boolean;
+    headerCheckboxSelectionFilteredOnly?: boolean;
+    headerCheckboxSelectionCurrentPageOnly?: boolean;
+    headerComponent?: any;
+    headerClass?: string | string[];
+    menuTabs?: string[];
+    suppressMenu?: boolean;
+    suppressSizeToFit?: boolean;
+    suppressMovable?: boolean;
+    wrapText?: boolean;
+    autoHeight?: boolean;
+    tooltipComponent?: any;
+    icons?: Record<string, any>;
+    /** rowvia extension: number of decimals for numberColumn */
+    decimals?: number;
+}
+export interface DefaultColDef extends ColDef {
+    enableCellChangeFlash?: boolean;
+    enableCellTextSelection?: boolean;
+    openByDefault?: boolean;
+    columnGroupShow?: 'open' | 'closed';
+    groupId?: string;
+}
+export interface SideBarDef {
+    toolPanels?: Array<{
+        id: string;
+        labelDefault: string;
+        labelKey?: string;
+        iconKey?: string;
+        toolPanel: any;
+        width?: number;
+        minWidth?: number;
+        maxWidth?: number;
+    } | string>;
+    defaultToolPanel?: string;
+    position?: 'left' | 'right';
+    hiddenByDefault?: boolean;
+}
+export interface StatusPanelDef {
+    statusPanel?: any;
+    align?: 'left' | 'center' | 'right';
+    key?: string;
+}
+export interface RowNode {
+    id: string;
+    /** unique key from getRowId, or generated */
+    __id: string;
+    data: any;
+    parent: RowNode | null;
+    children: RowNode[] | null;
+    group: boolean;
+    /** group key when this is a group node */
+    key: string | null;
+    /** depth in group tree */
+    level: number;
+    uiLevel: number;
+    rowGroupIndex?: number;
+    expanded: boolean;
+    selectable: boolean;
+    selected: boolean;
+    /** pinned top/bottom/null */
+    rowPinned: 'top' | 'bottom' | null;
+    /** master/detail */
+    detailNode: RowNode | null;
+    masterNode: RowNode | null;
+    /** true when this row is the auto-created group footer */
+    footer: boolean;
+    /** group aggregated values keyed by column id */
+    groupData: Record<string, any> | null;
+    /** row height in px (when set by grid) */
+    rowHeight: number | null;
+    /** tree data leaf info */
+    allChildrenCount: number | null;
+    /** stub node for server-side */
+    stub: boolean;
+    /** whether node passes the current filter (set by row model) */
+    __passesFilter: boolean;
+    /** depth-first child count including all descendants */
+    __childCount: number;
+    /** whether children were already loaded for this group */
+    __childrenLoaded: boolean;
+    /** index within the rows-after-filter (client side) */
+    rowIndex: number | null;
+    /** display index after pagination, set by row model */
+    __displayIndex?: number;
+    /** set when node created for the "select all" header checkbox */
+    setSelected: (selected: boolean, clearSelection?: boolean, source?: string) => number;
+    isSelected: () => boolean;
+    setData: (data: any) => void;
+    setDataValue: (colKey: string, newValue: any) => void;
+    setExpanded: (expanded: boolean) => void;
+    setPinned: (pinned: 'top' | 'bottom' | null) => void;
+    setSelectedNodes?: never;
+}
+export interface Column {
+    colId: string;
+    field?: string;
+    headerName: string;
+    headerTooltip?: string;
+    colDef: ColDef;
+    width: number;
+    minWidth: number;
+    maxWidth: number;
+    flex: number | null;
+    pinned: PinPosition;
+    hide: boolean;
+    visible: boolean;
+    lockPosition: 'left' | 'right' | true | false;
+    type: ColType | undefined;
+    sortable: boolean;
+    sort: SortDirection;
+    sortIndex: number | null;
+    resizable: boolean;
+    filter: boolean | string;
+    floatingFilter: boolean;
+    filterParams: ColumnFilterParams;
+    editable: boolean | ((params: any) => boolean);
+    cellEditor?: CellEditorFunc | string;
+    cellEditorParams: CellEditorParams;
+    singleClickEdit: boolean;
+    valueSetter?: (params: ValueSetterParams) => boolean;
+    valueGetter?: string | ((params: ValueGetterParams) => any);
+    valueFormatter?: string | ((params: ValueFormatterParams) => string | null);
+    valueParser?: string | ((params: any) => any);
+    comparator?: (valueA: any, valueB: any, nodeA?: RowNode, nodeB?: RowNode) => number;
+    aggFunc?: AggFunc;
+    allowedAggFuncs: string[];
+    rowGroup: boolean;
+    rowGroupIndex: number | null;
+    pivot: boolean;
+    pivotIndex: number | null;
+    enableRowGroup: boolean;
+    enablePivot: boolean;
+    enableValue: boolean;
+    cellRenderer?: CellRendererFunc | string;
+    cellRendererParams: any;
+    cellClass?: string | string[] | ((params: CellClassParams) => string | string[] | undefined);
+    cellStyle?: Record<string, any> | ((params: CellClassParams) => Record<string, any>);
+    cellDataType: boolean;
+    cellClassRules?: Record<string, (params: CellClassParams) => boolean>;
+    rowDrag: boolean;
+    headerClass?: string | string[];
+    checkboxSelection: boolean;
+    headerCheckboxSelection: boolean;
+    headerCheckboxSelectionFilteredOnly: boolean;
+    headerCheckboxSelectionCurrentPageOnly: boolean;
+    menuTabs: string[];
+    suppressMenu: boolean;
+    suppressMovable: boolean;
+    wrapText: boolean;
+    autoHeight: boolean;
+    tooltipField?: string;
+    tooltipValueGetter?: (params: TooltipParams) => string;
+    decimals: number;
+    /** index in columnDefs order */
+    defIndex: number;
+    /** parent column group id (spanning headers) */
+    groupId: string | null;
+    /** pivot metadata for generated pivot result columns */
+    __pivot?: {
+        pivotColumnId: string;
+        pivotField: string;
+        pivotValue: any;
+        valueColumnId: string;
+        valueField: string;
+    };
+    /** element */
+    eHeaderCell?: HTMLElement;
+    /** floating filter instance */
+    floatingFilterComp?: any;
+    /** filter active? */
+    filterActive: boolean;
+    /** actual left offset in px (set during layout) */
+    left: number;
+}
+export interface ColumnState {
+    colId: string;
+    hide?: boolean;
+    pinned?: PinPosition;
+    width?: number;
+    flex?: number;
+    sort?: SortDirection;
+    sortIndex?: number | null;
+    rowGroupIndex?: number | null;
+    pivotIndex?: number | null;
+    aggFunc?: string | AggFunc;
+}
+export interface SortModelItem {
+    colId: string;
+    sort: 'asc' | 'desc';
+}
+export interface FilterModelItem {
+    filterType: string;
+    type?: string;
+    filter?: any;
+    filterTo?: any;
+    dateFrom?: string;
+    dateTo?: string;
+    values?: any[];
+    operator?: 'AND' | 'OR';
+    condition1?: any;
+    condition2?: any;
+    filterModels?: FilterModelItem[];
+}
+export interface GridApi {
+    setRowData(rowData: any[]): void;
+    applyTransaction(transaction: RowDataTransaction): RowNodeTransactionResult | null;
+    getRowNode(id: string): RowNode | undefined;
+    getDisplayedRowCount(): number;
+    getDisplayedRowAtIndex(index: number): RowNode | undefined;
+    getFirstDisplayedRow(): RowNode | undefined;
+    getLastDisplayedRow(): RowNode | undefined;
+    forEachNode(callback: (node: RowNode, index: number) => void): void;
+    forEachLeafNode(callback: (node: RowNode, index: number) => void): void;
+    getModel(): any;
+    isRowPresent?(rowNode: RowNode): boolean;
+    getValue(colKey: string | Column, rowNode: RowNode): any;
+    setValue?(colKey: string | Column, rowNode: RowNode, value: any): void;
+    getSelectedRows(): any[];
+    getSelectedNodes(): RowNode[];
+    selectAll(): void;
+    deselectAll(): void;
+    selectAllFiltered(): void;
+    deselectAllFiltered(): void;
+    getSelectionModule?(): any;
+    selectNode?(node: RowNode, clearSelection?: boolean): void;
+    deselectNode?(node: RowNode): void;
+    setQuickFilter(newFilter: string): void;
+    isQuickFilterPresent(): boolean;
+    resetQuickFilter(): void;
+    getSortModel(): SortModelItem[];
+    setSortModel(model: SortModelItem[]): void;
+    getFilterModel(): Record<string, FilterModelItem>;
+    setFilterModel(model: Record<string, FilterModelItem>): void;
+    getColumnFilterModel(key: string | Column): FilterModelItem | null;
+    setColumnFilterModel(key: string | Column, model: FilterModelItem | null): void;
+    getAdvancedFilterModel(): any;
+    setAdvancedFilterModel(model: any): void;
+    onFilterChanged(): void;
+    onSortChanged(): void;
+    expandAll(): void;
+    collapseAll(): void;
+    onGroupExpandedOrCollapsed(): void;
+    getRowGroupColumns(): Column[];
+    addAggFunc?(): void;
+    setRowNodePinned(node: RowNode, pinned: 'top' | 'bottom' | null): void;
+    getColumnDefs?(): ColDef[];
+    setColumnDefs(colDefs: ColDef[], source?: string): void;
+    updateGridOptions?(options: Partial<GridOptions>): void;
+    setGridOption?(key: string, value: any): void;
+    sizeColumnsToFit(): void;
+    autoSizeAllColumns(): void;
+    autoSizeColumns?(colKeys: Array<string | Column>): void;
+    moveColumn?(key: string | Column, toIndex: number): void;
+    moveColumnByIndex?(fromIndex: number, toIndex: number): void;
+    setColumnVisible?(colKey: string | Column, visible: boolean): void;
+    setColumnsPinned?(keys: Array<string | Column>, pinned: PinPosition): void;
+    setColumnsVisible?(keys: Array<string | Column>, visible: boolean): void;
+    getColumns?(): Column[];
+    getAllColumns(): Column[];
+    getAllGridColumns?(): Column[];
+    getColumn?(key: string | Column): Column | null;
+    getDisplayedColAfter?(col: Column): Column | null;
+    getDisplayedColBefore?(col: Column): Column | null;
+    getDisplayedLeftColumns(): Column[];
+    getDisplayedCenterColumns(): Column[];
+    getDisplayedRightColumns(): Column[];
+    getColumnState(): ColumnState[];
+    applyColumnState?(state: ColumnState[], applyOrder?: boolean): void;
+    resetColumnState?(): void;
+    openColumnMenu?(column?: Column): void;
+    setSideBarVisible(visible: boolean): void;
+    isSideBarVisible(): boolean;
+    setSideBarPosition(position: 'left' | 'right'): void;
+    openToolPanel(id: string): void;
+    closeToolPanel?(): void;
+    getToolPanel?(): any;
+    setStatusBarVisible?(visible: boolean): void;
+    getStatusPanel?(key: string): any;
+    paginationIsLastPageFound(): boolean;
+    paginationGetPageSize(): number;
+    paginationGetCurrentPage(): number;
+    paginationGetTotalPages(): number;
+    paginationGetRowCount(): number;
+    paginationGoToPage(page: number): void;
+    paginationGoToNextPage(): void;
+    paginationGoToPreviousPage(): void;
+    paginationGoToFirstPage(): void;
+    paginationGoToLastPage(): void;
+    paginationSetPageSize(size: number): void;
+    startEditingCell(params: {
+        rowIndex: number;
+        colKey: string;
+    }): void;
+    stopEditing(cancel?: boolean): void;
+    getEditingCells(): Array<{
+        rowIndex: number;
+        colId: string;
+    }>;
+    setFocusedCell(rowIndex: number, colKey: string): void;
+    getFocusedCell(): {
+        rowIndex: number;
+        column: Column;
+        rowNode: RowNode;
+    } | null;
+    clearFocusedCell(): void;
+    tabToNextCell(backwards?: boolean): void;
+    tabToPreviousCell(): void;
+    refreshCells(params?: {
+        rowNodes?: RowNode[];
+        columns?: (string | Column)[];
+        force?: boolean;
+    }): void;
+    redrawRows(params?: {
+        rowNodes?: RowNode[];
+    }): void;
+    flashCells(params?: {
+        rowNodes?: RowNode[];
+        columns?: (string | Column)[];
+        flashDelay?: number;
+        fadeDelay?: number;
+    }): void;
+    setRowHeight?(height: number): void;
+    setHeaderHeight?(height: number): void;
+    ensureIndexVisible(index: number, position?: 'top' | 'bottom' | 'middle'): void;
+    ensureNodeVisible?(node: RowNode, position?: 'top' | 'bottom' | 'middle'): void;
+    ensureColumnVisible?(key: string | Column, position?: 'auto' | 'start' | 'middle' | 'end'): void;
+    getFirstDisplayedRowIndex?(): number;
+    getLastDisplayedRowIndex?(): number;
+    copyToClipboard(params?: any): void;
+    cutToClipboard(params?: any): void;
+    pasteFromClipboard(): void;
+    copySelectedRangeToClipboard?(): void;
+    copySelectedRowsToClipboard?(): void;
+    copySelectedColumnsToClipboard?(): void;
+    exportToCsv(params?: ExportParams): void;
+    exportToExcel(params?: ExportParams): void;
+    exportToPdf(params?: ExportParams & {
+        pageSize?: string;
+        title?: string;
+    }): void;
+    importExcel(file: Blob | ArrayBuffer, params?: {
+        sheetIndex?: number;
+        onSuccess?: (rows: any[]) => void;
+    }): Promise<any[]>;
+    getDataAsCsv?(params?: ExportParams): string;
+    getDataAsExcel?(params?: ExportParams): Blob;
+    getDataAsPdf?(params?: ExportParams & {
+        pageSize?: string;
+        title?: string;
+    }): Blob;
+    getChartData?(params?: any): any;
+    getChartModels?(): any[];
+    createChart?(): void;
+    getCellRanges(): CellRange[];
+    clearRangeSelection(): void;
+    addCellRange(range: CellRange): void;
+    onRangeSelectionChanged(): void;
+    onCellsSelectionChanged?(): void;
+    getRangeSelections(): CellRange[];
+    setRangeSelections?(ranges: CellRange[]): void;
+    showLoadingOverlay(): void;
+    showNoRowsOverlay(): void;
+    hideOverlay(): void;
+    setServerSideDatasource(datasource: any): void;
+    setDatasource(datasource: any): void;
+    setViewportDatasource(datasource: any): void;
+    setViewportRange(firstRow: number, lastRow: number): void;
+    refreshServerSide(params?: {
+        purge?: boolean;
+    }): void;
+    purgeServerSideCache(): void;
+    getServerSideStoreState(): any;
+    setRowCount(count: number, maxRowFound?: boolean): void;
+    isServerSideStoreLoading?(): boolean;
+    undoCellEditing(): number;
+    redoCellEditing(): number;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    getUndoRedoStackSize(): {
+        undo: number;
+        redo: number;
+    };
+    startBatchEdit(): void;
+    endBatchEdit(cancel?: boolean): void;
+    cancelBatchEdit(): void;
+    isBatchEditing(): boolean;
+    getState(): any;
+    setState(state: any): void;
+    setNote(rowNode: RowNode, colKey: string | Column, note: string | undefined): void;
+    getNote(rowNode: RowNode, colKey: string | Column): string | undefined;
+    isNodeSelected?(node: RowNode): boolean;
+    getGridId(): string;
+    destroy(): void;
+    resetRowHeights?(): void;
+    setSuppressRowDrag?(value: boolean): void;
+    setSuppressColumnVirtualisation?(value: boolean): void;
+    setAlwaysShowHorizontalScroll?(value: boolean): void;
+    setSuppressHorizontalScroll?(value: boolean): void;
+    setDomData?(key: string, value: any): void;
+    getDomData?(key: string): any;
+    setRowDataTransaction?(): never;
+    refreshClientSideRowModel?(): void;
+    onRowHeightChanged?(): void;
+    showColumnMenuAfterButtonClick?(colKey: string | Column, buttonElement: HTMLElement): void;
+    getSideBar?(): any;
+    setPivotMode?(value: boolean): void;
+    isPivotMode?(): boolean;
+    setFunctionsReadOnly?(readonly: boolean): void;
+    isAnimationFrameQueue?(): never;
+    executeEvery?(): never;
+    addAggressiveValue?(value: string): void;
+}
+export interface ExportParams {
+    fileName?: string;
+    sheetName?: string;
+    onlySelected?: boolean;
+    onlySelectedAllPages?: boolean;
+    skipHeader?: boolean;
+    columnKeys?: Array<string | Column>;
+    skipFooters?: boolean;
+    skipGroups?: boolean;
+    skipPinnedTop?: boolean;
+    skipPinnedBottom?: boolean;
+    suppressQuotes?: boolean;
+    columnSeparator?: string;
+    allColumns?: boolean;
+    exportedRows?: 'all' | 'filteredAndSorted' | 'visible';
+    processCellCallback?: (params: any) => string;
+    processHeaderCallback?: (params: any) => string;
+    shouldRowBeSkipped?: (params: any) => boolean;
+    exportMode?: 'xlsx' | 'xml';
+    headerRowHeight?: number;
+    rowHeight?: number;
+    margins?: any;
+    pageSetup?: any;
+    addImageToCell?: (rowIndex: number, colIndex: number, value: any) => any;
+    embeddedFormatDefs?: any;
+    mimeType?: string;
+    fileVersion?: string;
+    getCustomContentBelowRow?: (params: any) => any;
+}
+export interface CellRange {
+    id?: string;
+    rowStartIndex: number;
+    rowEndIndex: number;
+    columns: Array<string | Column>;
+}
+export interface RowDataTransaction {
+    add?: any[];
+    update?: any[];
+    remove?: any[];
+    addIndex?: number;
+}
+export interface RowNodeTransactionResult {
+    add: RowNode[];
+    remove: RowNode[];
+    update: RowNode[];
+}
+export interface RowDataUpdatedEvent {
+    type: 'transaction';
+    api: GridApi;
+}
+export type GridEventType = 'gridReady' | 'gridSizeChanged' | 'firstDataRendered' | 'modelUpdated' | 'rowDataUpdated' | 'cellValueChanged' | 'cellEditRequest' | 'rowValueChanged' | 'selectionChanged' | 'cellClicked' | 'cellDoubleClicked' | 'cellFocused' | 'rowClicked' | 'rowDoubleClicked' | 'cellEditingStarted' | 'cellEditingStopped' | 'cellKeyDown' | 'sortChanged' | 'filterChanged' | 'columnVisible' | 'columnPinned' | 'columnResized' | 'columnMoved' | 'columnEverythingChanged' | 'columnRowGroupChanged' | 'columnValueChanged' | 'columnPivotModeChanged' | 'displayedColumnsChanged' | 'virtualColumnsChanged' | 'columnHeaderClicked' | 'columnHeaderContextMenu' | 'componentStateChanged' | 'dragStopped' | 'rowDragEnter' | 'rowDragMove' | 'rowDragLeave' | 'rowDragEnd' | 'rowGroupOpened' | 'expandOrCollapseAll' | 'paginationChanged' | 'bodyScroll' | 'bodyScrollEnd' | 'rangeSelectionChanged' | 'rangeSelectionDeleted' | 'cutStart' | 'cutEnd' | 'pasteStart' | 'pasteEnd' | 'fillStart' | 'fillEnd' | 'cellContextMenu' | 'rowEditingStarted' | 'rowEditingStopped' | 'filterModified' | 'filterUiChanged' | 'filterOpened' | 'floatingFilterUiChanged' | 'advancedFilterBuilderVisibleChanged' | 'toolPanelVisibleChanged' | 'toolPanelSizeChanged' | 'sideBarUpdated' | 'chartCreated' | 'chartRangeSelectionChanged' | 'chartOptionsChanged' | 'chartDestroyed' | 'cellFocusCleared' | 'fullWidthCellKeyDown' | 'rowResize?' | 'itemsAdded' | 'itemsRemoved' | 'storeRefreshed' | 'asyncTransactionsFlushed' | 'newColumnsLoaded' | 'rowCountReady' | 'storeUpdated' | 'keyShortcutChangedCell' | 'cellShiftDown?';
+export interface GridOptions {
+    columnDefs?: ColDef[];
+    rowData?: any[];
+    defaultColDef?: DefaultColDef;
+    defaultColGroupDef?: any;
+    columnTypes?: Record<string, Partial<ColDef>>;
+    getRowId?: (params: {
+        data: any;
+        level: number;
+        parentKeys?: string[];
+    }) => string;
+    getRowClass?: string | ((params: any) => string | string[] | undefined);
+    getRowStyle?: Record<string, any> | ((params: any) => Record<string, any>);
+    getRowHeight?: number | ((params: {
+        data: any;
+        node: RowNode;
+        api: GridApi;
+    }) => number);
+    rowHeight?: number;
+    headerHeight?: number;
+    floatingFiltersHeight?: number;
+    groupHeaderHeight?: number;
+    pivotHeaderHeight?: number;
+    rowModelType?: RowModelType;
+    rowBuffer?: number;
+    pagination?: boolean;
+    paginationPageSize?: number;
+    paginationPageSizeSelector?: number[] | boolean;
+    paginationAutoPageSize?: boolean;
+    suppressPaginationPanel?: boolean;
+    cacheBlockSize?: number;
+    maxBlocksInCache?: number;
+    infiniteInitialRowCount?: number;
+    serverSideStoreType?: 'full' | 'partial';
+    serverSideDatasource?: any;
+    maxConcurrentDatasourceRequests?: number;
+    rowSelection?: RowSelectionMode;
+    suppressRowClickSelection?: boolean;
+    suppressRowDeselection?: boolean;
+    rowMultiSelectWithClick?: boolean;
+    groupSelectsChildren?: boolean;
+    groupSelectsFiltered?: boolean;
+    isRowSelectable?: (node: RowNode) => boolean;
+    rowGroupPanelShow?: 'always' | 'onlyWhenGrouping' | 'never';
+    groupDefaultExpanded?: number;
+    groupAllowUnsort?: boolean;
+    groupSuppressBlankColumn?: boolean;
+    groupIncludeFooter?: boolean;
+    groupIncludeTotalFooter?: boolean;
+    groupRemoveSingleChildren?: boolean;
+    groupRemoveLowestSingleChildren?: boolean;
+    groupDisplayType?: 'singleColumn' | 'multipleColumns' | 'custom';
+    groupHideOpenParents?: boolean;
+    /** set to true to prevent group rows from sticking to the top of the grid while scrolling */
+    suppressGroupRowsSticky?: boolean;
+    suppressAggFuncInHeader?: boolean;
+    autoGroupColumnDef?: ColDef;
+    showOpenedGroup?: boolean;
+    masterDetail?: boolean;
+    detailRowHeight?: number;
+    detailRowAutoHeight?: boolean;
+    isRowMaster?: (params: {
+        data: any;
+        node: RowNode;
+    }) => boolean;
+    keepDetailRows?: boolean;
+    keepDetailRowsCount?: number;
+    treeData?: boolean;
+    getDataPath?: (data: any) => string[];
+    treeDataChildrenField?: string;
+    treeDataParentIdField?: string;
+    excludeChildrenWhenTreeDataFiltering?: boolean;
+    sortingOrder?: SortDirection[];
+    multiSortKey?: 'ctrl';
+    accentedSort?: boolean;
+    suppressMultiSort?: boolean;
+    enableRangeSelection?: boolean;
+    enableCharts?: boolean;
+    chartStorageKey?: string;
+    enableCellChangeFlash?: boolean;
+    enableCellTextSelection?: boolean;
+    suppressClickEdit?: boolean;
+    readOnlyEdit?: boolean;
+    stopEditingWhenCellsLoseFocus?: boolean;
+    enterNavigatesVertically?: boolean;
+    enterNavigatesVerticallyAfterEdit?: boolean;
+    editType?: 'fullRow';
+    singleClickEdit?: boolean;
+    suppressKeyboardEvent?: (params: any) => boolean;
+    ensureDomOrder?: boolean;
+    quickFilterText?: string;
+    cacheQuickFilter?: boolean;
+    includeHiddenColumnsInQuickFilter?: boolean;
+    excludeHiddenColumnsFromQuickFilter?: boolean;
+    alwaysShowHorizontalScroll?: boolean;
+    suppressHorizontalScroll?: boolean;
+    alwaysShowVerticalScroll?: boolean;
+    suppressColumnVirtualisation?: boolean;
+    suppressAnimationFrame?: boolean;
+    animateRows?: boolean;
+    enableBrowserTooltips?: boolean;
+    tooltipShowDelay?: number;
+    tooltipHideDelay?: number;
+    suppressMovableColumns?: boolean;
+    suppressMenuHide?: boolean;
+    allowContextMenuWithControlKey?: boolean;
+    preventDefaultOnContextMenu?: boolean;
+    suppressContextMenu?: boolean;
+    suppressCopyRowsToClipboard?: boolean;
+    suppressCopySingleCellRanges?: boolean;
+    suppressLastEmptyLineOnPaste?: boolean;
+    suppressClipboardPaste?: boolean;
+    suppressClipboardApi?: boolean;
+    clipboardDeliminator?: string;
+    sideBar?: boolean | SideBarDef | string;
+    statusBar?: {
+        statusPanels: Array<StatusPanelDef | string>;
+    };
+    contextMenuItems?: string[] | ((params: any) => (string | any)[]);
+    columnMenu?: 'new' | 'legacy' | any;
+    suppressMenu?: boolean;
+    popupParent?: HTMLElement;
+    /** overrides for the built-in English UI strings (menus, popups, panels) */
+    localeText?: Record<string, string>;
+    onGridReady?: (params: any) => void;
+    onGridSizeChanged?: (params: any) => void;
+    onFirstDataRendered?: (params: any) => void;
+    onModelUpdated?: (params: any) => void;
+    onRowDataUpdated?: (params: RowDataUpdatedEvent) => void;
+    onRowDataChanged?: (params: any) => void;
+    onCellValueChanged?: (params: CellValueChangedEvent) => void;
+    onRowValueChanged?: (params: any) => void;
+    onSelectionChanged?: (params: any) => void;
+    onCellClicked?: (params: any) => void;
+    onCellDoubleClicked?: (params: any) => void;
+    onCellFocused?: (params: any) => void;
+    onRowClicked?: (params: any) => void;
+    onRowDoubleClicked?: (params: any) => void;
+    onCellEditingStarted?: (params: any) => void;
+    onCellEditingStopped?: (params: any) => void;
+    onSortChanged?: (params: any) => void;
+    onFilterChanged?: (params: any) => void;
+    onColumnVisible?: (params: any) => void;
+    onColumnPinned?: (params: any) => void;
+    onColumnResized?: (params: any) => void;
+    onColumnMoved?: (params: any) => void;
+    onColumnEverythingChanged?: (params: any) => void;
+    onDisplayedColumnsChanged?: (params: any) => void;
+    onColumnHeaderClicked?: (params: any) => void;
+    onRowGroupOpened?: (params: any) => void;
+    onExpandOrCollapseAll?: (params: any) => void;
+    onPaginationChanged?: (params: any) => void;
+    onBodyScroll?: (params: any) => void;
+    onRangeSelectionChanged?: (params: any) => void;
+    onCellContextMenu?: (params: any) => void;
+    onToolPanelVisibleChanged?: (params: any) => void;
+    onSideBarUpdated?: (params: any) => void;
+    onChartCreated?: (params: any) => void;
+    onChartOptionsChanged?: (params: any) => void;
+    onChartDestroyed?: (params: any) => void;
+    onStateUpdated?: (params: any) => void;
+    rowClass?: string;
+    rowStyle?: Record<string, any>;
+    headerClass?: string;
+    icons?: Record<string, any>;
+    suppressFieldDotNotation?: boolean;
+    rowNumbers?: boolean;
+    rowDragManaged?: boolean;
+    autoGenerateColumns?: boolean;
+    isExternalFilterPresent?: () => boolean;
+    doesExternalFilterPass?: (node: RowNode) => boolean;
+    rowDragMultiRow?: boolean;
+    undoRedoCellEditing?: boolean | number;
+    suppressTouch?: boolean;
+    theme?: string;
+    copyHeadersToClipboard?: boolean;
+    enableRtl?: boolean;
+    copyGroupHeadersToClipboard?: boolean;
+    cellFlashDuration?: number;
+    cellFadeDuration?: number;
+    deltaSort?: boolean;
+    mainMenuItems?: string[];
+    [key: string]: any;
+}
+export interface CellValueChangedEvent {
+    oldValue: any;
+    newValue: any;
+    value: any;
+    data: any;
+    node: RowNode;
+    column: Column;
+    colDef: ColDef;
+    api: GridApi;
+    context?: any;
+    source?: string;
+}
+export interface GridParams {
+    api: GridApi;
+    columnApi: ColumnApi;
+    context?: any;
+}
+export interface ColumnApi {
+    getAllColumns(): Column[];
+    getColumn(key: string | Column): Column | null;
+    getColumnState(): ColumnState[];
+    applyColumnState(state: ColumnState[], applyOrder?: boolean): void;
+    resetColumnState(): void;
+    setColumnVisible(colKey: string | Column, visible: boolean): void;
+    setColumnsVisible(keys: Array<string | Column>, visible: boolean): void;
+    setColumnPinned(colKey: string | Column, pinned: PinPosition): void;
+    setColumnsPinned(keys: Array<string | Column>, pinned: PinPosition): void;
+    moveColumn(key: string | Column, toIndex: number): void;
+    moveColumnByIndex(fromIndex: number, toIndex: number): void;
+    autoSizeColumn(key: string | Column, skipHeader?: boolean): void;
+    autoSizeColumns(keys: Array<string | Column>, skipHeader?: boolean): void;
+    autoSizeAllColumns(skipHeader?: boolean): void;
+    sizeColumnsToFit(): void;
+    setRowGroupColumns(keys: Array<string | Column>, source?: string): void;
+    removeRowGroupColumns(keys: Array<string | Column>, source?: string): void;
+    addRowGroupColumn?(key: string | Column, source?: string): void;
+    setPivotColumns?(keys: Array<string | Column>, source?: string): void;
+    removePivotColumns?(keys: Array<string | Column>, source?: string): void;
+    setValueColumns?(keys: Array<string | Column>, source?: string): void;
+    removeValueColumn?(key: string | Column, source?: string): void;
+    getRowGroupColumns(): Column[];
+    getValueColumns(): Column[];
+    getPivotColumns(): Column[];
+    setPivotMode(pivotMode: boolean, source?: string): void;
+    isPivotMode(): boolean;
+    getPrimaryColumns?(): Column[];
+}
+export interface ColumnGroup {
+    groupId: string;
+    headerName?: string;
+    children: (Column | ColumnGroup)[];
+    marryChildren?: boolean;
+}