UNPKG

5.46 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 { ColumnGroupChild } from "./columnGroupChild";
5import { OriginalColumnGroupChild } from "./originalColumnGroupChild";
6import { AbstractColDef, ColDef, IAggFunc } from "./colDef";
7import { RowNode } from "./rowNode";
8import { IEventEmitter } from "../interfaces/iEventEmitter";
9import { ColumnEventType } from "../events";
10import { ColumnGroup } from "./columnGroup";
11export declare class Column implements ColumnGroupChild, OriginalColumnGroupChild, IEventEmitter {
12 static EVENT_MOVING_CHANGED: string;
13 static EVENT_LEFT_CHANGED: string;
14 static EVENT_WIDTH_CHANGED: string;
15 static EVENT_LAST_LEFT_PINNED_CHANGED: string;
16 static EVENT_FIRST_RIGHT_PINNED_CHANGED: string;
17 static EVENT_VISIBLE_CHANGED: string;
18 static EVENT_FILTER_CHANGED: string;
19 static EVENT_FILTER_ACTIVE_CHANGED: string;
20 static EVENT_SORT_CHANGED: string;
21 static EVENT_MENU_VISIBLE_CHANGED: string;
22 static EVENT_ROW_GROUP_CHANGED: string;
23 static EVENT_PIVOT_CHANGED: string;
24 static EVENT_VALUE_CHANGED: string;
25 static PINNED_RIGHT: string;
26 static PINNED_LEFT: string;
27 static SORT_ASC: string;
28 static SORT_DESC: string;
29 private gridOptionsWrapper;
30 private columnUtils;
31 private frameworkFactory;
32 private columnApi;
33 private gridApi;
34 private colDef;
35 private colId;
36 private actualWidth;
37 private visible;
38 private pinned;
39 private left;
40 private oldLeft;
41 private aggFunc;
42 private sort;
43 private sortedAt;
44 private moving;
45 private menuVisible;
46 private lockPosition;
47 private lockPinned;
48 private lockVisible;
49 private lastLeftPinned;
50 private firstRightPinned;
51 private minWidth;
52 private maxWidth;
53 private filterActive;
54 private eventService;
55 private fieldContainsDots;
56 private tooltipFieldContainsDots;
57 private rowGroupActive;
58 private pivotActive;
59 private aggregationActive;
60 private primary;
61 private parent;
62 constructor(colDef: ColDef, colId: String, primary: boolean);
63 isLockPosition(): boolean;
64 isLockVisible(): boolean;
65 isLockPinned(): boolean;
66 setParent(parent: ColumnGroup): void;
67 getParent(): ColumnGroup;
68 initialise(): void;
69 isEmptyGroup(): boolean;
70 isRowGroupDisplayed(colId: string): boolean;
71 getUniqueId(): string;
72 isPrimary(): boolean;
73 isFilterAllowed(): boolean;
74 isFieldContainsDots(): boolean;
75 isTooltipFieldContainsDots(): boolean;
76 private validate();
77 addEventListener(eventType: string, listener: Function): void;
78 removeEventListener(eventType: string, listener: Function): void;
79 private createIsColumnFuncParams(rowNode);
80 isSuppressNavigable(rowNode: RowNode): boolean;
81 isCellEditable(rowNode: RowNode): boolean;
82 isRowDrag(rowNode: RowNode): boolean;
83 isCellCheckboxSelection(rowNode: RowNode): boolean;
84 isSuppressPaste(rowNode: RowNode): boolean;
85 isResizable(): boolean;
86 private isColumnFunc(rowNode, value);
87 setMoving(moving: boolean, source?: ColumnEventType): void;
88 private createColumnEvent(type, source);
89 isMoving(): boolean;
90 getSort(): string;
91 setSort(sort: string, source?: ColumnEventType): void;
92 setMenuVisible(visible: boolean, source?: ColumnEventType): void;
93 isMenuVisible(): boolean;
94 isSortAscending(): boolean;
95 isSortDescending(): boolean;
96 isSortNone(): boolean;
97 isSorting(): boolean;
98 getSortedAt(): number;
99 setSortedAt(sortedAt: number): void;
100 setAggFunc(aggFunc: string | IAggFunc): void;
101 getAggFunc(): string | IAggFunc;
102 getLeft(): number;
103 getOldLeft(): number;
104 getRight(): number;
105 setLeft(left: number, source?: ColumnEventType): void;
106 isFilterActive(): boolean;
107 setFilterActive(active: boolean, source?: ColumnEventType): void;
108 setPinned(pinned: string | boolean): void;
109 setFirstRightPinned(firstRightPinned: boolean, source?: ColumnEventType): void;
110 setLastLeftPinned(lastLeftPinned: boolean, source?: ColumnEventType): void;
111 isFirstRightPinned(): boolean;
112 isLastLeftPinned(): boolean;
113 isPinned(): boolean;
114 isPinnedLeft(): boolean;
115 isPinnedRight(): boolean;
116 getPinned(): string;
117 setVisible(visible: boolean, source?: ColumnEventType): void;
118 isVisible(): boolean;
119 getColDef(): ColDef;
120 getColumnGroupShow(): string;
121 getColId(): string;
122 getId(): string;
123 getDefinition(): AbstractColDef;
124 getActualWidth(): number;
125 private createBaseColDefParams(rowNode);
126 getColSpan(rowNode: RowNode): number;
127 getRowSpan(rowNode: RowNode): number;
128 setActualWidth(actualWidth: number, source?: ColumnEventType): void;
129 isGreaterThanMax(width: number): boolean;
130 getMinWidth(): number;
131 getMaxWidth(): number;
132 setMinimum(source?: ColumnEventType): void;
133 setRowGroupActive(rowGroup: boolean, source?: ColumnEventType): void;
134 isRowGroupActive(): boolean;
135 setPivotActive(pivot: boolean, source?: ColumnEventType): void;
136 isPivotActive(): boolean;
137 isAnyFunctionActive(): boolean;
138 isAnyFunctionAllowed(): boolean;
139 setValueActive(value: boolean, source?: ColumnEventType): void;
140 isValueActive(): boolean;
141 isAllowPivot(): boolean;
142 isAllowValue(): boolean;
143 isAllowRowGroup(): boolean;
144 getMenuTabs(defaultValues: string[]): string[];
145}