ag-grid-community 32.3.2 → 33.0.0

package/dist/types/src/entities/agColumn.d.ts

@@ -0,0 +1,149 @@
+import type { ColumnState } from '../columns/columnStateUtils';
+import { BeanStub } from '../context/beanStub';
+import type { ColumnEvent, ColumnEventType } from '../events';
+import type { Column, ColumnEventName, ColumnGroup, ColumnGroupShowType, ColumnHighlightPosition, ColumnInstanceId, ColumnPinnedType, HeaderColumnId, ProvidedColumnGroup } from '../interfaces/iColumn';
+import type { IRowNode } from '../interfaces/iRowNode';
+import type { AgColumnGroup } from './agColumnGroup';
+import type { AgProvidedColumnGroup } from './agProvidedColumnGroup';
+import type { AbstractColDef, ColDef, ColumnFunctionCallbackParams, IAggFunc, SortDirection } from './colDef';
+export declare function getNextColInstanceId(): ColumnInstanceId;
+export declare function isColumn(col: Column | ColumnGroup | ProvidedColumnGroup): col is AgColumn;
+export declare class AgColumn<TValue = any> extends BeanStub<ColumnEventName> implements Column {
+    colDef: ColDef<any, TValue>;
+    userProvidedColDef: ColDef<any, TValue> | null;
+    private readonly colId;
+    private readonly primary;
+    readonly isColumn: true;
+    private frameworkEventListenerService?;
+    private instanceId;
+    private actualWidth;
+    private autoHeaderHeight;
+    private visible;
+    pinned: ColumnPinnedType;
+    private left;
+    private oldLeft;
+    aggFunc: string | IAggFunc | null | undefined;
+    sort: SortDirection | undefined;
+    sortIndex: number | null | undefined;
+    moving: boolean;
+    menuVisible: boolean;
+    highlighted: ColumnHighlightPosition | null;
+    private lastLeftPinned;
+    private firstRightPinned;
+    minWidth: number;
+    private maxWidth;
+    filterActive: boolean;
+    private readonly colEventSvc;
+    private fieldContainsDots;
+    private tooltipFieldContainsDots;
+    tooltipEnabled: boolean;
+    rowGroupActive: boolean;
+    pivotActive: boolean;
+    aggregationActive: boolean;
+    flex: number | null;
+    parent: AgColumnGroup | null;
+    originalParent: AgProvidedColumnGroup | null;
+    constructor(colDef: ColDef<any, TValue>, userProvidedColDef: ColDef<any, TValue> | null, colId: string, primary: boolean);
+    getInstanceId(): ColumnInstanceId;
+    private setState;
+    setColDef(colDef: ColDef<any, TValue>, userProvidedColDef: ColDef<any, TValue> | null, source: ColumnEventType): void;
+    getUserProvidedColDef(): ColDef<any, TValue> | null;
+    getParent(): AgColumnGroup | null;
+    getOriginalParent(): AgProvidedColumnGroup | null;
+    postConstruct(): void;
+    private initDotNotation;
+    private initMinAndMaxWidths;
+    private initTooltip;
+    resetActualWidth(source: ColumnEventType): void;
+    private calculateColInitialWidth;
+    isEmptyGroup(): boolean;
+    isRowGroupDisplayed(colId: string): boolean;
+    isPrimary(): boolean;
+    isFilterAllowed(): boolean;
+    isFieldContainsDots(): boolean;
+    isTooltipEnabled(): boolean;
+    isTooltipFieldContainsDots(): boolean;
+    getHighlighted(): ColumnHighlightPosition | null;
+    addEventListener<T extends ColumnEventName>(eventType: T, userListener: (params: ColumnEvent<T>) => void): void;
+    removeEventListener<T extends ColumnEventName>(eventType: T, userListener: (params: ColumnEvent<T>) => void): void;
+    createColumnFunctionCallbackParams(rowNode: IRowNode): ColumnFunctionCallbackParams;
+    isSuppressNavigable(rowNode: IRowNode): boolean;
+    isCellEditable(rowNode: IRowNode): boolean;
+    isSuppressFillHandle(): boolean;
+    isAutoHeight(): boolean;
+    isAutoHeaderHeight(): boolean;
+    isRowDrag(rowNode: IRowNode): boolean;
+    isDndSource(rowNode: IRowNode): boolean;
+    isCellCheckboxSelection(rowNode: IRowNode): boolean;
+    isSuppressPaste(rowNode: IRowNode): boolean;
+    isResizable(): boolean;
+    /** Get value from ColDef or default if it exists. */
+    private getColDefValue;
+    isColumnFunc(rowNode: IRowNode, value?: boolean | ((params: ColumnFunctionCallbackParams) => boolean) | null): boolean;
+    private createColumnEvent;
+    isMoving(): boolean;
+    getSort(): SortDirection | undefined;
+    isSortable(): boolean;
+    /** @deprecated v32 use col.getSort() === 'asc */
+    isSortAscending(): boolean;
+    /** @deprecated v32 use col.getSort() === 'desc */
+    isSortDescending(): boolean;
+    /** @deprecated v32 use col.getSort() === undefined */
+    isSortNone(): boolean;
+    /** @deprecated v32 use col.getSort() !== undefined */
+    isSorting(): boolean;
+    getSortIndex(): number | null | undefined;
+    isMenuVisible(): boolean;
+    getAggFunc(): string | IAggFunc | null | undefined;
+    getLeft(): number | null;
+    getOldLeft(): number | null;
+    getRight(): number;
+    setLeft(left: number | null, source: ColumnEventType): void;
+    isFilterActive(): boolean;
+    /** @deprecated v33 Use `api.isColumnHovered(column)` instead. */
+    isHovered(): boolean;
+    setFirstRightPinned(firstRightPinned: boolean, source: ColumnEventType): void;
+    setLastLeftPinned(lastLeftPinned: boolean, source: ColumnEventType): void;
+    isFirstRightPinned(): boolean;
+    isLastLeftPinned(): boolean;
+    isPinned(): boolean;
+    isPinnedLeft(): boolean;
+    isPinnedRight(): boolean;
+    getPinned(): ColumnPinnedType;
+    setVisible(visible: boolean, source: ColumnEventType): void;
+    isVisible(): boolean;
+    isSpanHeaderHeight(): boolean;
+    getColumnGroupPaddingInfo(): {
+        numberOfParents: number;
+        isSpanningTotal: boolean;
+    };
+    getColDef(): ColDef<any, TValue>;
+    getDefinition(): AbstractColDef<any, TValue>;
+    getColumnGroupShow(): ColumnGroupShowType | undefined;
+    getColId(): string;
+    getId(): string;
+    getUniqueId(): HeaderColumnId;
+    getActualWidth(): number;
+    getAutoHeaderHeight(): number | null;
+    /** Returns true if the header height has changed */
+    setAutoHeaderHeight(height: number): boolean;
+    private createBaseColDefParams;
+    getColSpan(rowNode: IRowNode): number;
+    getRowSpan(rowNode: IRowNode): number;
+    setActualWidth(actualWidth: number, source: ColumnEventType, silent?: boolean): void;
+    fireColumnWidthChangedEvent(source: ColumnEventType): void;
+    isGreaterThanMax(width: number): boolean;
+    getMinWidth(): number;
+    getMaxWidth(): number;
+    getFlex(): number | null;
+    isRowGroupActive(): boolean;
+    isPivotActive(): boolean;
+    isAnyFunctionActive(): boolean;
+    isAnyFunctionAllowed(): boolean;
+    isValueActive(): boolean;
+    isAllowPivot(): boolean;
+    isAllowValue(): boolean;
+    isAllowRowGroup(): boolean;
+    dispatchColEvent(type: ColumnEventName, source: ColumnEventType, additionalEventAttributes?: any): void;
+    dispatchStateUpdatedEvent(key: keyof ColumnState): void;
+}

package/dist/types/src/entities/agColumnGroup.d.ts

@@ -0,0 +1,57 @@
+import { BeanStub } from '../context/beanStub';
+import type { AgColumnGroupEvent, Column, ColumnGroup, ColumnGroupShowType, ColumnPinnedType, HeaderColumnId } from '../interfaces/iColumn';
+import type { AgColumn } from './agColumn';
+import type { AgProvidedColumnGroup } from './agProvidedColumnGroup';
+import type { AbstractColDef, ColGroupDef } from './colDef';
+export declare function createUniqueColumnGroupId(groupId: string, instanceId: number): HeaderColumnId;
+export declare function isColumnGroup(col: Column | ColumnGroup | string): col is AgColumnGroup;
+export declare class AgColumnGroup<TValue = any> extends BeanStub<AgColumnGroupEvent> implements ColumnGroup<TValue> {
+    private readonly providedColumnGroup;
+    private readonly groupId;
+    private readonly partId;
+    private readonly pinned;
+    readonly isColumn: false;
+    private children;
+    private displayedChildren;
+    private autoHeaderHeight;
+    private left;
+    private oldLeft;
+    parent: AgColumnGroup | null;
+    constructor(providedColumnGroup: AgProvidedColumnGroup, groupId: string, partId: number, pinned: ColumnPinnedType);
+    reset(): void;
+    getParent(): AgColumnGroup | null;
+    getUniqueId(): HeaderColumnId;
+    isEmptyGroup(): boolean;
+    isMoving(): boolean;
+    checkLeft(): void;
+    getLeft(): number | null;
+    getOldLeft(): number | null;
+    setLeft(left: number | null): void;
+    getPinned(): ColumnPinnedType;
+    getGroupId(): string;
+    getPartId(): number;
+    getActualWidth(): number;
+    isResizable(): boolean;
+    getMinWidth(): number;
+    addChild(child: AgColumn | AgColumnGroup): void;
+    getDisplayedChildren(): (AgColumn | AgColumnGroup)[] | null;
+    getLeafColumns(): AgColumn[];
+    getDisplayedLeafColumns(): AgColumn[];
+    getDefinition(): AbstractColDef | null;
+    getColGroupDef(): ColGroupDef | null;
+    isPadding(): boolean;
+    isExpandable(): boolean;
+    isExpanded(): boolean;
+    setExpanded(expanded: boolean): void;
+    isAutoHeaderHeight(): boolean;
+    getAutoHeaderHeight(): number | null;
+    /** Returns true if the header height has changed */
+    setAutoHeaderHeight(height: number): boolean;
+    private addDisplayedLeafColumns;
+    private addLeafColumns;
+    getChildren(): (AgColumn | AgColumnGroup)[] | null;
+    getColumnGroupShow(): ColumnGroupShowType | undefined;
+    getProvidedColumnGroup(): AgProvidedColumnGroup;
+    getPaddingLevel(): number;
+    calculateDisplayedColumns(): void;
+}

package/dist/types/src/entities/agProvidedColumnGroup.d.ts

@@ -0,0 +1,42 @@
+import { BeanStub } from '../context/beanStub';
+import type { Column, ColumnGroupShowType, ColumnInstanceId, ProvidedColumnGroup } from '../interfaces/iColumn';
+import type { AgColumn } from './agColumn';
+import type { ColGroupDef } from './colDef';
+export declare function isProvidedColumnGroup(col: Column | ProvidedColumnGroup | string | null): col is AgProvidedColumnGroup;
+export type AgProvidedColumnGroupEvent = 'expandedChanged' | 'expandableChanged';
+export declare class AgProvidedColumnGroup extends BeanStub<AgProvidedColumnGroupEvent> implements ProvidedColumnGroup {
+    private colGroupDef;
+    private readonly groupId;
+    private padding;
+    private level;
+    readonly isColumn: false;
+    originalParent: AgProvidedColumnGroup | null;
+    private children;
+    private expandable;
+    private expanded;
+    private instanceId;
+    private expandableListenerRemoveCallback;
+    constructor(colGroupDef: ColGroupDef | null, groupId: string, padding: boolean, level: number);
+    destroy(): void;
+    private reset;
+    getInstanceId(): ColumnInstanceId;
+    getOriginalParent(): AgProvidedColumnGroup | null;
+    getLevel(): number;
+    isVisible(): boolean;
+    isPadding(): boolean;
+    setExpanded(expanded: boolean | undefined): void;
+    isExpandable(): boolean;
+    isExpanded(): boolean;
+    getGroupId(): string;
+    getId(): string;
+    setChildren(children: (AgColumn | AgProvidedColumnGroup)[]): void;
+    getChildren(): (AgColumn | AgProvidedColumnGroup)[];
+    getColGroupDef(): ColGroupDef | null;
+    getLeafColumns(): AgColumn[];
+    private addLeafColumns;
+    getColumnGroupShow(): ColumnGroupShowType | undefined;
+    setupExpandable(): void;
+    setExpandable(): void;
+    private findChildrenRemovingPadding;
+    private onColumnVisibilityChanged;
+}