1 | import { RowNode } from './entities/rowNode';
|
2 | import { ChartRef, FillOperationParams, GetChartToolbarItems, GetContextMenuItems, GetMainMenuItems, GetRowNodeIdFunc, GetServerSideStoreParamsParams, GridOptions, IsApplyServerSideTransaction, IsGroupOpenByDefaultParams, IsRowMaster, IsRowSelectable, IsServerSideGroupOpenByDefaultParams, NavigateToNextCellParams, NavigateToNextHeaderParams, PaginationNumberFormatterParams, PostProcessPopupParams, ProcessDataFromClipboardParams, ServerSideStoreParams, TabToNextCellParams, TabToNextHeaderParams } from './entities/gridOptions';
|
3 | import { GridApi } from './gridApi';
|
4 | import { ColDef, ColGroupDef, IAggFunc, SuppressKeyboardEventParams } from './entities/colDef';
|
5 | import { ColumnApi } from './columns/columnApi';
|
6 | import { IViewportDatasource } from './interfaces/iViewportDatasource';
|
7 | import { IDatasource } from './interfaces/iDatasource';
|
8 | import { CellPosition } from './entities/cellPosition';
|
9 | import { IServerSideDatasource } from './interfaces/iServerSideDatasource';
|
10 | import { CsvExportParams, ProcessCellForExportParams, ProcessHeaderForExportParams } from './interfaces/exportParams';
|
11 | import { AgEvent } from './events';
|
12 | import { SideBarDef } from './entities/sideBar';
|
13 | import { AgChartTheme, AgChartThemeOverrides } from "./interfaces/iAgChartOptions";
|
14 | import { HeaderPosition } from './headerRendering/common/headerPosition';
|
15 | import { ExcelExportParams } from './interfaces/iExcelCreator';
|
16 | export interface PropertyChangedEvent extends AgEvent {
|
17 | currentValue: any;
|
18 | previousValue: any;
|
19 | }
|
20 | export declare class GridOptionsWrapper {
|
21 | private static MIN_COL_WIDTH;
|
22 | static PROP_HEADER_HEIGHT: string;
|
23 | static PROP_GROUP_REMOVE_SINGLE_CHILDREN: string;
|
24 | static PROP_GROUP_REMOVE_LOWEST_SINGLE_CHILDREN: string;
|
25 | static PROP_PIVOT_HEADER_HEIGHT: string;
|
26 | static PROP_SUPPRESS_CLIPBOARD_PASTE: string;
|
27 | static PROP_GROUP_HEADER_HEIGHT: string;
|
28 | static PROP_PIVOT_GROUP_HEADER_HEIGHT: string;
|
29 | static PROP_NAVIGATE_TO_NEXT_CELL: string;
|
30 | static PROP_TAB_TO_NEXT_CELL: string;
|
31 | static PROP_NAVIGATE_TO_NEXT_HEADER: string;
|
32 | static PROP_TAB_TO_NEXT_HEADER: string;
|
33 | static PROP_IS_EXTERNAL_FILTER_PRESENT: string;
|
34 | static PROP_DOES_EXTERNAL_FILTER_PASS: string;
|
35 | static PROP_FLOATING_FILTERS_HEIGHT: string;
|
36 | static PROP_SUPPRESS_ROW_CLICK_SELECTION: string;
|
37 | static PROP_SUPPRESS_ROW_DRAG: string;
|
38 | static PROP_SUPPRESS_MOVE_WHEN_ROW_DRAG: string;
|
39 | static PROP_GET_ROW_CLASS: string;
|
40 | static PROP_GET_ROW_STYLE: string;
|
41 | static PROP_GET_ROW_HEIGHT: string;
|
42 | static PROP_POPUP_PARENT: string;
|
43 | static PROP_DOM_LAYOUT: string;
|
44 | static PROP_FILL_HANDLE_DIRECTION: string;
|
45 | static PROP_GROUP_ROW_AGG_NODES: string;
|
46 | static PROP_GET_BUSINESS_KEY_FOR_NODE: string;
|
47 | static PROP_GET_CHILD_COUNT: string;
|
48 | static PROP_PROCESS_ROW_POST_CREATE: string;
|
49 | static PROP_GET_ROW_NODE_ID: string;
|
50 | static PROP_IS_FULL_WIDTH_CELL: string;
|
51 | static PROP_IS_ROW_SELECTABLE: string;
|
52 | static PROP_IS_ROW_MASTER: string;
|
53 | static PROP_POST_SORT: string;
|
54 | static PROP_GET_DOCUMENT: string;
|
55 | static PROP_POST_PROCESS_POPUP: string;
|
56 | static PROP_DEFAULT_GROUP_ORDER_COMPARATOR: string;
|
57 | static PROP_PAGINATION_NUMBER_FORMATTER: string;
|
58 | static PROP_GET_CONTEXT_MENU_ITEMS: string;
|
59 | static PROP_GET_MAIN_MENU_ITEMS: string;
|
60 | static PROP_PROCESS_CELL_FOR_CLIPBOARD: string;
|
61 | static PROP_PROCESS_CELL_FROM_CLIPBOARD: string;
|
62 | static PROP_SEND_TO_CLIPBOARD: string;
|
63 | static PROP_PROCESS_TO_SECONDARY_COLDEF: string;
|
64 | static PROP_PROCESS_SECONDARY_COL_GROUP_DEF: string;
|
65 | static PROP_GET_CHART_TOOLBAR_ITEMS: string;
|
66 | static PROP_GET_SERVER_SIDE_STORE_PARAMS: string;
|
67 | static PROP_IS_SERVER_SIDE_GROUPS_OPEN_BY_DEFAULT: string;
|
68 | static PROP_IS_APPLY_SERVER_SIDE_TRANSACTION: string;
|
69 | static PROP_IS_SERVER_SIDE_GROUP: string;
|
70 | static PROP_GET_SERVER_SIDE_GROUP_KEY: string;
|
71 | private readonly gridOptions;
|
72 | private readonly eventService;
|
73 | private readonly environment;
|
74 | private propertyEventService;
|
75 | private domDataKey;
|
76 | private scrollbarWidth;
|
77 | private destroyed;
|
78 | private agWire;
|
79 | private destroy;
|
80 | init(): void;
|
81 | private checkColumnDefProperties;
|
82 | private checkGridOptionsProperties;
|
83 | private checkProperties;
|
84 | getDomDataKey(): string;
|
85 | getDomData(element: Node | null, key: string): any;
|
86 | setDomData(element: Element, key: string, value: any): any;
|
87 | isRowSelection(): boolean;
|
88 | isSuppressRowDeselection(): boolean;
|
89 | isRowSelectionMulti(): boolean;
|
90 | isRowMultiSelectWithClick(): boolean;
|
91 | getContext(): any;
|
92 | isPivotMode(): boolean;
|
93 | isSuppressExpandablePivotGroups(): boolean;
|
94 | getPivotColumnGroupTotals(): string | undefined;
|
95 | getPivotRowTotals(): string | undefined;
|
96 | isRowModelInfinite(): boolean;
|
97 | isRowModelViewport(): boolean;
|
98 | isRowModelServerSide(): boolean;
|
99 | isRowModelDefault(): boolean;
|
100 | isFullRowEdit(): boolean;
|
101 | isSuppressFocusAfterRefresh(): boolean;
|
102 | isSuppressBrowserResizeObserver(): boolean;
|
103 | isSuppressMaintainUnsortedOrder(): boolean;
|
104 | isSuppressClearOnFillReduction(): boolean;
|
105 | isShowToolPanel(): boolean;
|
106 | getSideBar(): SideBarDef;
|
107 | isSuppressTouch(): boolean;
|
108 | isMaintainColumnOrder(): boolean;
|
109 | isSuppressRowTransform(): boolean;
|
110 | isSuppressColumnStateEvents(): boolean;
|
111 | isAllowDragFromColumnsToolPanel(): boolean;
|
112 | useAsyncEvents(): boolean;
|
113 | isEnableCellChangeFlash(): boolean;
|
114 | getCellFlashDelay(): number;
|
115 | getCellFadeDelay(): number;
|
116 | isGroupSelectsChildren(): boolean;
|
117 | isSuppressRowHoverHighlight(): boolean;
|
118 | isColumnHoverHighlight(): boolean;
|
119 | isGroupSelectsFiltered(): boolean;
|
120 | isGroupHideOpenParents(): boolean;
|
121 | isGroupMaintainOrder(): boolean;
|
122 | getAutoGroupColumnDef(): ColDef | undefined;
|
123 | isGroupMultiAutoColumn(): boolean;
|
124 | isGroupUseEntireRow(pivotMode: boolean): boolean;
|
125 | isGroupSuppressAutoColumn(): boolean;
|
126 | isGroupRemoveSingleChildren(): boolean;
|
127 | isGroupRemoveLowestSingleChildren(): boolean;
|
128 | isGroupIncludeFooter(): boolean;
|
129 | isGroupIncludeTotalFooter(): boolean;
|
130 | isGroupSuppressBlankHeader(): boolean;
|
131 | isSuppressRowClickSelection(): boolean;
|
132 | isSuppressCellSelection(): boolean;
|
133 | isSuppressMultiSort(): boolean;
|
134 | isMultiSortKeyCtrl(): boolean;
|
135 | isPivotSuppressAutoColumn(): boolean;
|
136 | isSuppressDragLeaveHidesColumns(): boolean;
|
137 | isSuppressScrollOnNewData(): boolean;
|
138 | isSuppressScrollWhenPopupsAreOpen(): boolean;
|
139 | isRowDragEntireRow(): boolean;
|
140 | isSuppressRowDrag(): boolean;
|
141 | isRowDragManaged(): boolean;
|
142 | isSuppressMoveWhenRowDragging(): boolean;
|
143 | isRowDragMultiRow(): boolean;
|
144 | getDomLayout(): string;
|
145 | isSuppressHorizontalScroll(): boolean;
|
146 | isSuppressMaxRenderedRowRestriction(): boolean;
|
147 | isExcludeChildrenWhenTreeDataFiltering(): boolean;
|
148 | isAlwaysShowHorizontalScroll(): boolean;
|
149 | isAlwaysShowVerticalScroll(): boolean;
|
150 | isDebounceVerticalScrollbar(): boolean;
|
151 | isSuppressLoadingOverlay(): boolean;
|
152 | isSuppressNoRowsOverlay(): boolean;
|
153 | isSuppressFieldDotNotation(): boolean;
|
154 | getPinnedTopRowData(): any[] | undefined;
|
155 | getPinnedBottomRowData(): any[] | undefined;
|
156 | isFunctionsPassive(): boolean;
|
157 | isSuppressChangeDetection(): boolean;
|
158 | isSuppressAnimationFrame(): boolean;
|
159 | getQuickFilterText(): string | undefined;
|
160 | isCacheQuickFilter(): boolean;
|
161 | isUnSortIcon(): boolean;
|
162 | isSuppressMenuHide(): boolean;
|
163 | isEnterMovesDownAfterEdit(): boolean;
|
164 | isEnterMovesDown(): boolean;
|
165 | isUndoRedoCellEditing(): boolean;
|
166 | getUndoRedoCellEditingLimit(): number | undefined;
|
167 | getRowStyle(): import("./entities/gridOptions").RowStyle | undefined;
|
168 | getRowClass(): string | string[] | undefined;
|
169 | getRowStyleFunc(): ((params: import("./entities/gridOptions").RowClassParams) => import("./entities/gridOptions").RowStyle) | undefined;
|
170 | getRowClassFunc(): ((params: import("./entities/gridOptions").RowClassParams) => string | string[] | undefined) | undefined;
|
171 | rowClassRules(): import("./entities/gridOptions").RowClassRules | undefined;
|
172 | getServerSideStoreType(): string | undefined;
|
173 | getServerSideStoreParamsFunc(): ((params: GetServerSideStoreParamsParams) => ServerSideStoreParams) | undefined;
|
174 | getCreateChartContainerFunc(): ((params: ChartRef) => void) | undefined;
|
175 | getPopupParent(): HTMLElement | undefined;
|
176 | getBlockLoadDebounceMillis(): number | undefined;
|
177 | getPostProcessPopupFunc(): ((params: PostProcessPopupParams) => void) | undefined;
|
178 | getPaginationNumberFormatterFunc(): ((params: PaginationNumberFormatterParams) => string) | undefined;
|
179 | getChildCountFunc(): ((dataItem: any) => number) | undefined;
|
180 | getIsApplyServerSideTransactionFunc(): IsApplyServerSideTransaction | undefined;
|
181 | getDefaultGroupOrderComparator(): ((nodeA: RowNode, nodeB: RowNode) => number) | undefined;
|
182 | getIsFullWidthCellFunc(): ((rowNode: RowNode) => boolean) | undefined;
|
183 | getFullWidthCellRendererParams(): any;
|
184 | isEmbedFullWidthRows(): boolean;
|
185 | isDetailRowAutoHeight(): boolean;
|
186 | getSuppressKeyboardEventFunc(): ((params: SuppressKeyboardEventParams) => boolean) | undefined;
|
187 | getBusinessKeyForNodeFunc(): ((node: RowNode) => string) | undefined;
|
188 | getApi(): GridApi | undefined | null;
|
189 | getColumnApi(): ColumnApi | undefined | null;
|
190 | isImmutableData(): boolean;
|
191 | isEnsureDomOrder(): boolean;
|
192 | isEnableCharts(): boolean;
|
193 | getColResizeDefault(): string | undefined;
|
194 | isSingleClickEdit(): boolean;
|
195 | isSuppressClickEdit(): boolean;
|
196 | isStopEditingWhenCellsLoseFocus(): boolean;
|
197 | getGroupDefaultExpanded(): number | undefined;
|
198 | getMaxConcurrentDatasourceRequests(): number | undefined;
|
199 | getMaxBlocksInCache(): number | undefined;
|
200 | getCacheOverflowSize(): number | undefined;
|
201 | getPaginationPageSize(): number | undefined;
|
202 | isPaginateChildRows(): boolean;
|
203 | getCacheBlockSize(): number | undefined;
|
204 | getInfiniteInitialRowCount(): number | undefined;
|
205 | isPurgeClosedRowNodes(): boolean;
|
206 | isSuppressPaginationPanel(): boolean;
|
207 | getRowData(): any[] | undefined | null;
|
208 | isEnableRtl(): boolean;
|
209 | getRowGroupPanelShow(): string | undefined;
|
210 | getPivotPanelShow(): string | undefined;
|
211 | isAngularCompileRows(): boolean;
|
212 | isAngularCompileFilters(): boolean;
|
213 | isDebug(): boolean;
|
214 | getColumnDefs(): (ColGroupDef | ColDef)[] | null | undefined;
|
215 | getColumnTypes(): {
|
216 | [key: string]: ColDef;
|
217 | } | undefined;
|
218 | getDatasource(): IDatasource | undefined;
|
219 | getViewportDatasource(): IViewportDatasource | undefined;
|
220 | getServerSideDatasource(): IServerSideDatasource | undefined;
|
221 | isAccentedSort(): boolean;
|
222 | isEnableBrowserTooltips(): boolean;
|
223 | isEnableCellExpressions(): boolean;
|
224 | isEnableGroupEdit(): boolean;
|
225 | isSuppressMiddleClickScrolls(): boolean;
|
226 | isPreventDefaultOnContextMenu(): boolean;
|
227 | isSuppressPreventDefaultOnMouseWheel(): boolean;
|
228 | isSuppressColumnVirtualisation(): boolean;
|
229 | isSuppressContextMenu(): boolean;
|
230 | isAllowContextMenuWithControlKey(): boolean;
|
231 | isSuppressCopyRowsToClipboard(): boolean;
|
232 | isCopyHeadersToClipboard(): boolean;
|
233 | isSuppressClipboardPaste(): boolean;
|
234 | isSuppressLastEmptyLineOnPaste(): boolean;
|
235 | isPagination(): boolean;
|
236 | isSuppressEnterpriseResetOnNewColumns(): boolean;
|
237 | getProcessDataFromClipboardFunc(): ((params: ProcessDataFromClipboardParams) => string[][] | null) | undefined;
|
238 | getAsyncTransactionWaitMillis(): number | undefined;
|
239 | isSuppressMovableColumns(): boolean;
|
240 | isAnimateRows(): boolean;
|
241 | isSuppressColumnMoveAnimation(): boolean;
|
242 | isSuppressAggFuncInHeader(): boolean;
|
243 | isSuppressAggAtRootLevel(): boolean;
|
244 | isSuppressAggFilteredOnly(): boolean;
|
245 | isShowOpenedGroup(): boolean;
|
246 | isReactUi(): boolean;
|
247 | isEnableRangeSelection(): boolean;
|
248 | isEnableRangeHandle(): boolean;
|
249 | isEnableFillHandle(): boolean;
|
250 | getFillHandleDirection(): 'x' | 'y' | 'xy';
|
251 | getFillOperation(): ((params: FillOperationParams) => any) | undefined;
|
252 | isSuppressMultiRangeSelection(): boolean;
|
253 | isPaginationAutoPageSize(): boolean;
|
254 | isRememberGroupStateWhenNewData(): boolean;
|
255 | getIcons(): {
|
256 | [key: string]: TimerHandler;
|
257 | } | undefined;
|
258 | getAggFuncs(): {
|
259 | [key: string]: IAggFunc;
|
260 | } | undefined;
|
261 | getSortingOrder(): (string | null)[] | undefined;
|
262 | getAlignedGrids(): GridOptions[] | undefined;
|
263 | isMasterDetail(): boolean;
|
264 | isKeepDetailRows(): boolean;
|
265 | getKeepDetailRowsCount(): number | undefined;
|
266 | getIsRowMasterFunc(): IsRowMaster | undefined;
|
267 | getIsRowSelectableFunc(): IsRowSelectable | undefined;
|
268 | getGroupRowRendererParams(): any;
|
269 | getOverlayLoadingTemplate(): string | undefined;
|
270 | getOverlayNoRowsTemplate(): string | undefined;
|
271 | isSuppressAutoSize(): boolean;
|
272 | isEnableCellTextSelection(): boolean;
|
273 | isSuppressParentsInRowNodes(): boolean;
|
274 | isSuppressClipboardApi(): boolean;
|
275 | isFunctionsReadOnly(): boolean;
|
276 | isFloatingFilter(): boolean | undefined;
|
277 | isEnableCellTextSelect(): boolean;
|
278 | isEnableOldSetFilterModel(): boolean;
|
279 | getDefaultColDef(): ColDef | undefined;
|
280 | getDefaultColGroupDef(): Partial<ColGroupDef> | undefined;
|
281 | getDefaultExportParams(type: 'csv'): CsvExportParams | undefined;
|
282 | getDefaultExportParams(type: 'excel'): ExcelExportParams | undefined;
|
283 | isSuppressCsvExport(): boolean;
|
284 | isAllowShowChangeAfterFilter(): boolean;
|
285 | isSuppressExcelExport(): boolean;
|
286 | isSuppressMakeColumnVisibleAfterUnGroup(): boolean;
|
287 | getDataPathFunc(): ((dataItem: any) => string[]) | undefined;
|
288 | getIsServerSideGroupFunc(): ((dataItem: any) => boolean) | undefined;
|
289 | getIsServerSideGroupOpenByDefaultFunc(): ((params: IsServerSideGroupOpenByDefaultParams) => boolean) | undefined;
|
290 | getIsGroupOpenByDefaultFunc(): ((params: IsGroupOpenByDefaultParams) => boolean) | undefined;
|
291 | getServerSideGroupKeyFunc(): ((dataItem: any) => string) | undefined;
|
292 | getGroupRowAggNodesFunc(): ((nodes: RowNode[]) => any) | undefined;
|
293 | getContextMenuItemsFunc(): GetContextMenuItems | undefined;
|
294 | getMainMenuItemsFunc(): GetMainMenuItems | undefined;
|
295 | getRowNodeIdFunc(): GetRowNodeIdFunc | undefined;
|
296 | getNavigateToNextHeaderFunc(): ((params: NavigateToNextHeaderParams) => HeaderPosition) | undefined;
|
297 | getTabToNextHeaderFunc(): ((params: TabToNextHeaderParams) => HeaderPosition) | undefined;
|
298 | getNavigateToNextCellFunc(): ((params: NavigateToNextCellParams) => CellPosition) | undefined;
|
299 | getTabToNextCellFunc(): ((params: TabToNextCellParams) => CellPosition) | undefined;
|
300 | getGridTabIndex(): string;
|
301 | isTreeData(): boolean;
|
302 | isValueCache(): boolean;
|
303 | isValueCacheNeverExpires(): boolean;
|
304 | isDeltaSort(): boolean;
|
305 | isAggregateOnlyChangedColumns(): boolean;
|
306 | getProcessSecondaryColDefFunc(): ((colDef: ColDef) => void) | undefined;
|
307 | getProcessSecondaryColGroupDefFunc(): ((colGroupDef: ColGroupDef) => void) | undefined;
|
308 | getSendToClipboardFunc(): ((params: import("./entities/gridOptions").SendToClipboardParams) => void) | undefined;
|
309 | getProcessRowPostCreateFunc(): any;
|
310 | getProcessCellForClipboardFunc(): ((params: ProcessCellForExportParams) => any) | undefined;
|
311 | getProcessHeaderForClipboardFunc(): ((params: ProcessHeaderForExportParams) => any) | undefined;
|
312 | getProcessCellFromClipboardFunc(): ((params: ProcessCellForExportParams) => any) | undefined;
|
313 | getViewportRowModelPageSize(): number | undefined;
|
314 | getViewportRowModelBufferSize(): number;
|
315 | isServerSideSortingAlwaysResets(): boolean;
|
316 | isServerSideFilteringAlwaysResets(): boolean;
|
317 | getPostSortFunc(): ((rowNodes: RowNode[]) => void) | undefined;
|
318 | getChartToolbarItemsFunc(): GetChartToolbarItems | undefined;
|
319 | getChartThemeOverrides(): AgChartThemeOverrides | undefined;
|
320 | getCustomChartThemes(): {
|
321 | [name: string]: AgChartTheme;
|
322 | } | undefined;
|
323 | getChartThemes(): string[];
|
324 | getClipboardDeliminator(): string;
|
325 | setProperty(key: string, value: any, force?: boolean): void;
|
326 | addEventListener(key: string, listener: Function): void;
|
327 | removeEventListener(key: string, listener: Function): void;
|
328 | isSkipHeaderOnAutoSize(): boolean;
|
329 | getAutoSizePadding(): number;
|
330 | getHeaderHeight(): number | null | undefined;
|
331 | getFloatingFiltersHeight(): number | null | undefined;
|
332 | getGroupHeaderHeight(): number | null | undefined;
|
333 | getPivotHeaderHeight(): number | null | undefined;
|
334 | getPivotGroupHeaderHeight(): number | null | undefined;
|
335 | isExternalFilterPresent(): boolean;
|
336 | doesExternalFilterPass(node: RowNode): boolean;
|
337 | getTooltipShowDelay(): number | null;
|
338 | isTooltipMouseTrack(): boolean;
|
339 | isSuppressModelUpdateAfterUpdateTransaction(): boolean;
|
340 | getDocument(): Document;
|
341 | getMinColWidth(): number;
|
342 | getMaxColWidth(): number | null;
|
343 | getColWidth(): number;
|
344 | getRowBuffer(): number;
|
345 | getRowBufferInPixels(): number;
|
346 | getScrollbarWidth(): number;
|
347 | private checkForDeprecated;
|
348 | private checkForViolations;
|
349 | private treeDataViolations;
|
350 | getLocaleTextFunc(): (key: string, defaultValue: string) => string;
|
351 | globalEventHandler(eventName: string, event?: any): void;
|
352 | getRowHeightAsNumber(): number;
|
353 | getRowHeightForNode(rowNode: RowNode, allowEstimate?: boolean, defaultRowHeight?: number): {
|
354 | height: number;
|
355 | estimated: boolean;
|
356 | };
|
357 | isDynamicRowHeight(): boolean;
|
358 | getListItemHeight(): number;
|
359 | chartMenuPanelWidth(): number | undefined;
|
360 | private isNumeric;
|
361 | private getFromTheme;
|
362 | getDefaultRowHeight(): number;
|
363 | private matchesGroupDisplayType;
|
364 | private matchesTreeDataDisplayType;
|
365 | }
|