UNPKG

5.86 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/>
4export declare class Events {
5 /** Everything has changed with the columns. Either complete new set of columns set, or user called setState()*/
6 static EVENT_COLUMN_EVERYTHING_CHANGED: string;
7 /** User has set in new columns. */
8 static EVENT_NEW_COLUMNS_LOADED: string;
9 /** The pivot mode flag was changed */
10 static EVENT_COLUMN_PIVOT_MODE_CHANGED: string;
11 /** A row group column was added, removed or order changed. */
12 static EVENT_COLUMN_ROW_GROUP_CHANGED: string;
13 /** A pivot column was added, removed or order changed. */
14 static EVENT_COLUMN_PIVOT_CHANGED: string;
15 /** The list of grid columns has changed. */
16 static EVENT_GRID_COLUMNS_CHANGED: string;
17 /** A value column was added, removed or agg function was changed. */
18 static EVENT_COLUMN_VALUE_CHANGED: string;
19 /** A column was moved */
20 static EVENT_COLUMN_MOVED: string;
21 /** One or more columns was shown / hidden */
22 static EVENT_COLUMN_VISIBLE: string;
23 /** One or more columns was pinned / unpinned*/
24 static EVENT_COLUMN_PINNED: string;
25 /** A column group was opened / closed */
26 static EVENT_COLUMN_GROUP_OPENED: string;
27 /** One or more columns was resized. If just one, the column in the event is set. */
28 static EVENT_COLUMN_RESIZED: string;
29 /** The list of displayed columns has changed, can result from columns open / close, column move, pivot, group, etc */
30 static EVENT_DISPLAYED_COLUMNS_CHANGED: string;
31 /** The list of virtual columns has changed, results from viewport changing */
32 static EVENT_VIRTUAL_COLUMNS_CHANGED: string;
33 /** A row group was opened / closed */
34 static EVENT_ROW_GROUP_OPENED: string;
35 /** The client has set new data into the grid */
36 static EVENT_ROW_DATA_CHANGED: string;
37 /** The client has updated data for the grid */
38 static EVENT_ROW_DATA_UPDATED: string;
39 /** The client has set new floating data into the grid */
40 static EVENT_PINNED_ROW_DATA_CHANGED: string;
41 /** Range selection has changed */
42 static EVENT_RANGE_SELECTION_CHANGED: string;
43 /** For when the tool panel is shown / hidden */
44 static EVENT_TOOL_PANEL_VISIBLE_CHANGED: string;
45 /** Model was updated - grid updates the drawn rows when this happens */
46 static EVENT_MODEL_UPDATED: string;
47 static EVENT_PASTE_START: string;
48 static EVENT_PASTE_END: string;
49 static EVENT_CELL_CLICKED: string;
50 static EVENT_CELL_DOUBLE_CLICKED: string;
51 static EVENT_CELL_MOUSE_DOWN: string;
52 static EVENT_CELL_CONTEXT_MENU: string;
53 static EVENT_CELL_VALUE_CHANGED: string;
54 static EVENT_ROW_VALUE_CHANGED: string;
55 static EVENT_CELL_FOCUSED: string;
56 static EVENT_ROW_SELECTED: string;
57 static EVENT_SELECTION_CHANGED: string;
58 static EVENT_CELL_MOUSE_OVER: string;
59 static EVENT_CELL_MOUSE_OUT: string;
60 /** 2 events for filtering. The grid LISTENS for filterChanged and afterFilterChanged */
61 static EVENT_FILTER_CHANGED: string;
62 /** Filter was change but not applied. Only useful if apply buttons are used in filters. */
63 static EVENT_FILTER_MODIFIED: string;
64 static EVENT_SORT_CHANGED: string;
65 /** A row was removed from the dom, for any reason. Use to clean up resources (if any) used by the row. */
66 static EVENT_VIRTUAL_ROW_REMOVED: string;
67 static EVENT_ROW_CLICKED: string;
68 static EVENT_ROW_DOUBLE_CLICKED: string;
69 /** Gets called once after the grid has finished initialising. */
70 static EVENT_GRID_READY: string;
71 /** Width of height of the main grid div has changed. Grid listens for this and does layout of grid if it's
72 * changed, so always filling the space it was given. */
73 static EVENT_GRID_SIZE_CHANGED: string;
74 /** The indexes of the rows rendered has changed, eg user has scrolled to a new vertical position. */
75 static EVENT_VIEWPORT_CHANGED: string;
76 /** A column drag has started, either resizing a column or moving a column. */
77 static EVENT_DRAG_STARTED: string;
78 /** A column drag has stopped */
79 static EVENT_DRAG_STOPPED: string;
80 static EVENT_ROW_EDITING_STARTED: string;
81 static EVENT_ROW_EDITING_STOPPED: string;
82 static EVENT_CELL_EDITING_STARTED: string;
83 static EVENT_CELL_EDITING_STOPPED: string;
84 /** Main body of grid has scrolled, either horizontally or vertically */
85 static EVENT_BODY_SCROLL: string;
86 static EVENT_ANIMATION_QUEUE_EMPTY: string;
87 static EVENT_HEIGHT_SCALE_CHANGED: string;
88 /** The displayed page for pagination has changed. For example the data was filtered or sorted,
89 * or the user has moved to a different page. */
90 static EVENT_PAGINATION_CHANGED: string;
91 /** Only used by React, Angular 2+, Web Components, Aurelia and VueJS ag-Grid components
92 * (not used if doing plain JavaScript or Angular 1.x). If the grid receives changes due
93 * to bound properties, this event fires after the grid has finished processing the change. */
94 static EVENT_COMPONENT_STATE_CHANGED: string;
95 /** All items from here down are used internally by the grid, not intended for external use. */
96 static EVENT_BODY_HEIGHT_CHANGED: string;
97 static EVENT_DISPLAYED_COLUMNS_WIDTH_CHANGED: string;
98 static EVENT_SCROLL_VISIBILITY_CHANGED: string;
99 static EVENT_COLUMN_HOVER_CHANGED: string;
100 static EVENT_FLASH_CELLS: string;
101 static EVENT_ROW_DRAG_ENTER: string;
102 static EVENT_ROW_DRAG_MOVE: string;
103 static EVENT_ROW_DRAG_LEAVE: string;
104 static EVENT_ROW_DRAG_END: string;
105 static EVENT_COLUMN_ROW_GROUP_CHANGE_REQUEST: string;
106 static EVENT_COLUMN_PIVOT_CHANGE_REQUEST: string;
107 static EVENT_COLUMN_VALUE_CHANGE_REQUEST: string;
108 static EVENT_COLUMN_AGG_FUNC_CHANGE_REQUEST: string;
109}