UNPKG

11.7 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 { RowNode } from "./entities/rowNode";
5import { GetContextMenuItems, GetMainMenuItems, GetRowNodeIdFunc, GridOptions, IsRowMaster, IsRowSelectable, NavigateToNextCellParams, NodeChildDetails, PaginationNumberFormatterParams, PostProcessPopupParams, ProcessDataFromClipboardParams, TabToNextCellParams } from "./entities/gridOptions";
6import { GridApi } from "./gridApi";
7import { ColDef, ColGroupDef, IAggFunc } from "./entities/colDef";
8import { ColumnApi } from "./columnController/columnApi";
9import { IViewportDatasource } from "./interfaces/iViewportDatasource";
10import { IDatasource } from "./rowModels/iDatasource";
11import { GridCellDef } from "./entities/gridCell";
12import { IServerSideDatasource } from "./interfaces/iServerSideDatasource";
13import { BaseExportParams, ProcessCellForExportParams, ProcessHeaderForExportParams } from "./exportParams";
14import { AgEvent } from "./events";
15export interface PropertyChangedEvent extends AgEvent {
16 currentValue: any;
17 previousValue: any;
18}
19export declare class GridOptionsWrapper {
20 private static MIN_COL_WIDTH;
21 static PROP_HEADER_HEIGHT: string;
22 static PROP_GROUP_REMOVE_SINGLE_CHILDREN: string;
23 static PROP_GROUP_REMOVE_LOWEST_SINGLE_CHILDREN: string;
24 static PROP_PIVOT_HEADER_HEIGHT: string;
25 static PROP_SUPPRESS_CLIPBOARD_PASTE: string;
26 static PROP_GROUP_HEADER_HEIGHT: string;
27 static PROP_PIVOT_GROUP_HEADER_HEIGHT: string;
28 static PROP_FLOATING_FILTERS_HEIGHT: string;
29 static PROP_SUPPRESS_ROW_DRAG: string;
30 static PROP_POPUP_PARENT: string;
31 static PROP_GRID_AUTO_HEIGHT: string;
32 private gridOptions;
33 private columnController;
34 private eventService;
35 private enterprise;
36 private frameworkFactory;
37 private gridApi;
38 private columnApi;
39 private environment;
40 private autoHeightCalculator;
41 private propertyEventService;
42 private domDataKey;
43 private layoutElements;
44 private agWire(gridApi, columnApi);
45 private destroy();
46 init(): void;
47 private checkColumnDefProperties();
48 private checkGridOptionsProperties();
49 private checkProperties(userProperties, validPropertiesAndExceptions, validProperties, containerName, docsUrl);
50 getDomData(element: Node, key: string): any;
51 setDomData(element: Element, key: string, value: any): any;
52 isEnterprise(): boolean;
53 isRowSelection(): boolean;
54 isRowDeselection(): boolean;
55 isRowSelectionMulti(): boolean;
56 isRowMultiSelectWithClick(): boolean;
57 getContext(): any;
58 isPivotMode(): boolean;
59 isPivotTotals(): boolean;
60 getPivotColumnGroupTotals(): string;
61 getPivotRowTotals(): string;
62 isRowModelInfinite(): boolean;
63 isRowModelViewport(): boolean;
64 isRowModelServerSide(): boolean;
65 isRowModelDefault(): boolean;
66 isFullRowEdit(): boolean;
67 isSuppressFocusAfterRefresh(): boolean;
68 isShowToolPanel(): boolean;
69 isToolPanelSuppressValues(): boolean;
70 isToolPanelSuppressPivots(): boolean;
71 isToolPanelSuppressRowGroups(): boolean;
72 isToolPanelSuppressSideButtons(): boolean;
73 isToolPanelSuppressPivotMode(): boolean;
74 isContractColumnSelection(): boolean;
75 isToolPanelSuppressColumnFilter(): boolean;
76 isToolPanelSuppressColumnSelectAll(): boolean;
77 isToolPanelSuppressColumnExpandAll(): boolean;
78 isSuppressTouch(): boolean;
79 isSuppressRowTransform(): boolean;
80 useAsyncEvents(): boolean;
81 isEnableCellChangeFlash(): boolean;
82 isGroupSelectsChildren(): boolean;
83 isSuppressRowHoverHighlight(): boolean;
84 isGroupSelectsFiltered(): boolean;
85 isGroupHideOpenParents(): boolean;
86 isGroupMultiAutoColumn(): boolean;
87 isGroupRemoveSingleChildren(): boolean;
88 isGroupRemoveLowestSingleChildren(): boolean;
89 isGroupIncludeFooter(): boolean;
90 isGroupIncludeTotalFooter(): boolean;
91 isGroupSuppressBlankHeader(): boolean;
92 isSuppressRowClickSelection(): boolean;
93 isSuppressCellSelection(): boolean;
94 isSuppressMultiSort(): boolean;
95 isMultiSortKeyCtrl(): boolean;
96 isGroupSuppressAutoColumn(): boolean;
97 isSuppressDragLeaveHidesColumns(): boolean;
98 isSuppressScrollOnNewData(): boolean;
99 isRowDragManaged(): boolean;
100 isSuppressRowDrag(): boolean;
101 isGridAutoHeight(): boolean;
102 isSuppressHorizontalScroll(): boolean;
103 isSuppressLoadingOverlay(): boolean;
104 isSuppressNoRowsOverlay(): boolean;
105 isSuppressFieldDotNotation(): boolean;
106 getPinnedTopRowData(): any[];
107 getPinnedBottomRowData(): any[];
108 isFunctionsPassive(): boolean;
109 isSuppressTabbing(): boolean;
110 isSuppressChangeDetection(): boolean;
111 isSuppressAnimationFrame(): boolean;
112 getQuickFilterText(): string;
113 isCacheQuickFilter(): boolean;
114 isUnSortIcon(): boolean;
115 isSuppressMenuHide(): boolean;
116 isEnterMovesDownAfterEdit(): boolean;
117 isEnterMovesDown(): boolean;
118 getRowStyle(): any;
119 getRowClass(): string | string[];
120 getRowStyleFunc(): Function;
121 getRowClassFunc(): (params: any) => string | string[];
122 rowClassRules(): {
123 [cssClassName: string]: string | Function;
124 };
125 getPopupParent(): HTMLElement;
126 getPostProcessPopupFunc(): (params: PostProcessPopupParams) => void;
127 getDoesDataFlowerFunc(): (data: any) => boolean;
128 getPaginationNumberFormatterFunc(): (params: PaginationNumberFormatterParams) => string;
129 getChildCountFunc(): (dataItem: any) => number;
130 getDefaultGroupSortComparator(): (nodeA: RowNode, nodeB: RowNode) => number;
131 getIsFullWidthCellFunc(): (rowNode: RowNode) => boolean;
132 getFullWidthCellRendererParams(): any;
133 isEmbedFullWidthRows(): boolean;
134 getBusinessKeyForNodeFunc(): (node: RowNode) => string;
135 getApi(): GridApi;
136 getColumnApi(): ColumnApi;
137 isDeltaRowDataMode(): boolean;
138 isEnsureDomOrder(): boolean;
139 isEnableColResize(): boolean;
140 getColResizeDefault(): string;
141 isSingleClickEdit(): boolean;
142 isSuppressClickEdit(): boolean;
143 isStopEditingWhenGridLosesFocus(): boolean;
144 getGroupDefaultExpanded(): number;
145 getMaxConcurrentDatasourceRequests(): number;
146 getMaxBlocksInCache(): number;
147 getCacheOverflowSize(): number;
148 getPaginationPageSize(): number;
149 getCacheBlockSize(): number;
150 getInfiniteInitialRowCount(): number;
151 isPurgeClosedRowNodes(): boolean;
152 isSuppressPaginationPanel(): boolean;
153 getRowData(): any[];
154 isGroupUseEntireRow(): boolean;
155 isEnableRtl(): boolean;
156 getAutoGroupColumnDef(): ColDef;
157 isGroupSuppressRow(): boolean;
158 getRowGroupPanelShow(): string;
159 getPivotPanelShow(): string;
160 isAngularCompileRows(): boolean;
161 isAngularCompileFilters(): boolean;
162 isAngularCompileHeaders(): boolean;
163 isDebug(): boolean;
164 getColumnDefs(): (ColDef | ColGroupDef)[];
165 getColumnTypes(): {
166 [key: string]: ColDef;
167 };
168 getDatasource(): IDatasource;
169 getViewportDatasource(): IViewportDatasource;
170 getServerSideDatasource(): IServerSideDatasource;
171 isEnableSorting(): boolean;
172 isAccentedSort(): boolean;
173 isEnableCellExpressions(): boolean;
174 isEnableGroupEdit(): boolean;
175 isSuppressMiddleClickScrolls(): boolean;
176 isSuppressPreventDefaultOnMouseWheel(): boolean;
177 isSuppressColumnVirtualisation(): boolean;
178 isSuppressContextMenu(): boolean;
179 isAllowContextMenuWithControlKey(): boolean;
180 isSuppressCopyRowsToClipboard(): boolean;
181 isSuppressClipboardPaste(): boolean;
182 isEnableFilter(): boolean;
183 isPagination(): boolean;
184 isSuppressEnterpriseResetOnNewColumns(): boolean;
185 getProcessDataFromClipboardFunc(): ((params: ProcessDataFromClipboardParams) => string[][]);
186 getBatchUpdateWaitMillis(): number;
187 isEnableServerSideFilter(): boolean;
188 isEnableServerSideSorting(): boolean;
189 isSuppressMovableColumns(): boolean;
190 isAnimateRows(): boolean;
191 isSuppressColumnMoveAnimation(): boolean;
192 isSuppressAggFuncInHeader(): boolean;
193 isSuppressAggAtRootLevel(): boolean;
194 isEnableRangeSelection(): boolean;
195 isSuppressMultiRangeSelection(): boolean;
196 isPaginationAutoPageSize(): boolean;
197 isRememberGroupStateWhenNewData(): boolean;
198 getIcons(): any;
199 getAggFuncs(): {
200 [key: string]: IAggFunc;
201 };
202 getSortingOrder(): string[];
203 getAlignedGrids(): GridOptions[];
204 isMasterDetail(): boolean;
205 getIsRowMasterFunc(): IsRowMaster;
206 getIsRowSelectableFunc(): IsRowSelectable;
207 getGroupRowRendererParams(): any;
208 getOverlayLoadingTemplate(): string;
209 getOverlayNoRowsTemplate(): string;
210 isSuppressAutoSize(): boolean;
211 isSuppressParentsInRowNodes(): boolean;
212 isEnableStatusBar(): boolean;
213 isAlwaysShowStatusBar(): boolean;
214 isFunctionsReadOnly(): boolean;
215 isFloatingFilter(): boolean;
216 isEnableOldSetFilterModel(): boolean;
217 getDefaultColDef(): ColDef;
218 getDefaultColGroupDef(): ColGroupDef;
219 getDefaultExportParams(): BaseExportParams;
220 isSuppressCsvExport(): boolean;
221 isSuppressExcelExport(): boolean;
222 isSuppressMakeColumnVisibleAfterUnGroup(): boolean;
223 getNodeChildDetailsFunc(): ((dataItem: any) => NodeChildDetails);
224 getDataPathFunc(): ((dataItem: any) => string[]);
225 getGroupRowAggNodesFunc(): (nodes: RowNode[]) => any;
226 getContextMenuItemsFunc(): GetContextMenuItems;
227 getMainMenuItemsFunc(): GetMainMenuItems;
228 getRowNodeIdFunc(): GetRowNodeIdFunc;
229 getNavigateToNextCellFunc(): (params: NavigateToNextCellParams) => GridCellDef;
230 getTabToNextCellFunc(): (params: TabToNextCellParams) => GridCellDef;
231 isTreeData(): boolean;
232 isValueCache(): boolean;
233 isValueCacheNeverExpires(): boolean;
234 isAggregateOnlyChangedColumns(): boolean;
235 getProcessSecondaryColDefFunc(): (colDef: ColDef) => void;
236 getProcessSecondaryColGroupDefFunc(): (colGroupDef: ColGroupDef) => void;
237 getSendToClipboardFunc(): (params: any) => void;
238 getProcessRowPostCreateFunc(): any;
239 getProcessCellForClipboardFunc(): (params: ProcessCellForExportParams) => any;
240 getProcessHeaderForClipboardFunc(): (params: ProcessHeaderForExportParams) => any;
241 getProcessCellFromClipboardFunc(): (params: ProcessCellForExportParams) => any;
242 getViewportRowModelPageSize(): number;
243 getViewportRowModelBufferSize(): number;
244 isServerSideSortingAlwaysResets(): boolean;
245 getPostSortFunc(): (rowNodes: RowNode[]) => void;
246 getClipboardDeliminator(): string;
247 setProperty(key: string, value: any): void;
248 addLayoutElement(element: HTMLElement): void;
249 private updateLayoutClasses();
250 addEventListener(key: string, listener: Function): void;
251 static checkEventDeprecation(eventName: string): void;
252 removeEventListener(key: string, listener: Function): void;
253 getAutoSizePadding(): number;
254 getHeaderHeight(): number;
255 getFloatingFiltersHeight(): number;
256 getGroupHeaderHeight(): number;
257 getPivotHeaderHeight(): number;
258 getPivotGroupHeaderHeight(): number;
259 isExternalFilterPresent(): boolean;
260 doesExternalFilterPass(node: RowNode): boolean;
261 getDocument(): Document;
262 getMinColWidth(): number;
263 getMaxColWidth(): number;
264 getColWidth(): number;
265 getRowBuffer(): number;
266 getScrollbarWidth(): number;
267 private checkForDeprecated();
268 getLocaleTextFunc(): Function;
269 globalEventHandler(eventName: string, event?: any): void;
270 getRowHeightAsNumber(): number;
271 getRowHeightForNode(rowNode: RowNode): number;
272 isDynamicRowHeight(): boolean;
273 getVirtualItemHeight(): number;
274 private isNumeric(value);
275 private specialForNewMaterial(defaultValue, sassVariableName);
276 private getDefaultRowHeight();
277}