UNPKG

4.74 kBTypeScriptView Raw
1// Type definitions for ag-grid v18.1.2
2// Project: http://www.ag-grid.com/
3// Definitions by: Niall Crosby <https://github.com/ag-grid/>
4import { ColDef, ColGroupDef } from "../entities/colDef";
5import { ColumnGroupChild } from "../entities/columnGroupChild";
6import { ColumnState } from "./columnController";
7import { OriginalColumnGroup } from "../entities/originalColumnGroup";
8import { ColumnGroup } from "../entities/columnGroup";
9import { Column } from "../entities/column";
10export declare class ColumnApi {
11 private columnController;
12 sizeColumnsToFit(gridWidth: any): void;
13 setColumnGroupOpened(group: OriginalColumnGroup | string, newValue: boolean): void;
14 getColumnGroup(name: string, instanceId?: number): ColumnGroup;
15 getOriginalColumnGroup(name: string): OriginalColumnGroup;
16 getDisplayNameForColumn(column: Column, location: string): string;
17 getDisplayNameForColumnGroup(columnGroup: ColumnGroup, location: string): string;
18 getColumn(key: any): Column;
19 setColumnState(columnState: ColumnState[]): boolean;
20 getColumnState(): ColumnState[];
21 resetColumnState(): void;
22 getColumnGroupState(): {
23 groupId: string;
24 open: boolean;
25 }[];
26 setColumnGroupState(stateItems: ({
27 groupId: string;
28 open: boolean;
29 })[]): void;
30 resetColumnGroupState(): void;
31 isPinning(): boolean;
32 isPinningLeft(): boolean;
33 isPinningRight(): boolean;
34 getDisplayedColAfter(col: Column): Column;
35 getDisplayedColBefore(col: Column): Column;
36 setColumnVisible(key: string | Column, visible: boolean): void;
37 setColumnsVisible(keys: (string | Column)[], visible: boolean): void;
38 setColumnPinned(key: string | Column, pinned: string): void;
39 setColumnsPinned(keys: (string | Column)[], pinned: string): void;
40 getAllColumns(): Column[];
41 getAllGridColumns(): Column[];
42 getDisplayedLeftColumns(): Column[];
43 getDisplayedCenterColumns(): Column[];
44 getDisplayedRightColumns(): Column[];
45 getAllDisplayedColumns(): Column[];
46 getAllDisplayedVirtualColumns(): Column[];
47 moveColumn(key: string | Column, toIndex: number): void;
48 moveColumnByIndex(fromIndex: number, toIndex: number): void;
49 moveColumns(columnsToMoveKeys: (string | Column)[], toIndex: number): void;
50 moveRowGroupColumn(fromIndex: number, toIndex: number): void;
51 setColumnAggFunc(column: Column, aggFunc: string): void;
52 setColumnWidth(key: string | Column, newWidth: number, finished?: boolean): void;
53 setPivotMode(pivotMode: boolean): void;
54 isPivotMode(): boolean;
55 getSecondaryPivotColumn(pivotKeys: string[], valueColKey: string | Column): Column;
56 setValueColumns(colKeys: (string | Column)[]): void;
57 getValueColumns(): Column[];
58 removeValueColumn(colKey: (string | Column)): void;
59 removeValueColumns(colKeys: (string | Column)[]): void;
60 addValueColumn(colKey: (string | Column)): void;
61 addValueColumns(colKeys: (string | Column)[]): void;
62 setRowGroupColumns(colKeys: (string | Column)[]): void;
63 removeRowGroupColumn(colKey: string | Column): void;
64 removeRowGroupColumns(colKeys: (string | Column)[]): void;
65 addRowGroupColumn(colKey: string | Column): void;
66 addRowGroupColumns(colKeys: (string | Column)[]): void;
67 getRowGroupColumns(): Column[];
68 setPivotColumns(colKeys: (string | Column)[]): void;
69 removePivotColumn(colKey: string | Column): void;
70 removePivotColumns(colKeys: (string | Column)[]): void;
71 addPivotColumn(colKey: string | Column): void;
72 addPivotColumns(colKeys: (string | Column)[]): void;
73 getPivotColumns(): Column[];
74 getLeftDisplayedColumnGroups(): ColumnGroupChild[];
75 getCenterDisplayedColumnGroups(): ColumnGroupChild[];
76 getRightDisplayedColumnGroups(): ColumnGroupChild[];
77 getAllDisplayedColumnGroups(): ColumnGroupChild[];
78 autoSizeColumn(key: string | Column): void;
79 autoSizeColumns(keys: (string | Column)[]): void;
80 autoSizeAllColumns(): void;
81 setSecondaryColumns(colDefs: (ColDef | ColGroupDef)[]): void;
82 columnGroupOpened(group: OriginalColumnGroup | string, newValue: boolean): void;
83 hideColumns(colIds: any, hide: any): void;
84 hideColumn(colId: any, hide: any): void;
85 setState(columnState: ColumnState[]): boolean;
86 getState(): ColumnState[];
87 resetState(): void;
88 getAggregationColumns(): Column[];
89 removeAggregationColumn(colKey: (string | Column)): void;
90 removeAggregationColumns(colKeys: (string | Column)[]): void;
91 addAggregationColumn(colKey: (string | Column)): void;
92 addAggregationColumns(colKeys: (string | Column)[]): void;
93 setColumnAggFunction(column: Column, aggFunc: string): void;
94 getDisplayNameForCol(column: any): string;
95}