UNPKG

7.45 kBPlain TextView Raw
1export class Events {
2
3 /** Everything has changed with the columns. Either complete new set of columns set, or user called setState()*/
4 public static EVENT_COLUMN_EVERYTHING_CHANGED = 'columnEverythingChanged';
5
6 /** User has set in new columns. */
7 public static EVENT_NEW_COLUMNS_LOADED = 'newColumnsLoaded';
8
9 /** The pivot mode flag was changed */
10 public static EVENT_COLUMN_PIVOT_MODE_CHANGED = 'columnPivotModeChanged';
11
12 /** A row group column was added, removed or order changed. */
13 public static EVENT_COLUMN_ROW_GROUP_CHANGED = 'columnRowGroupChanged';
14
15 /** A pivot column was added, removed or order changed. */
16 public static EVENT_COLUMN_PIVOT_CHANGED = 'columnPivotChanged';
17
18 /** The list of grid columns has changed. */
19 public static EVENT_GRID_COLUMNS_CHANGED = 'gridColumnsChanged';
20
21 /** A value column was added, removed or agg function was changed. */
22 public static EVENT_COLUMN_VALUE_CHANGED = 'columnValueChanged';
23
24 /** A column was moved */
25 public static EVENT_COLUMN_MOVED = 'columnMoved';
26
27 /** One or more columns was shown / hidden */
28 public static EVENT_COLUMN_VISIBLE = 'columnVisible';
29
30 /** One or more columns was pinned / unpinned*/
31 public static EVENT_COLUMN_PINNED = 'columnPinned';
32
33 /** A column group was opened / closed */
34 public static EVENT_COLUMN_GROUP_OPENED = 'columnGroupOpened';
35
36 /** One or more columns was resized. If just one, the column in the event is set. */
37 public static EVENT_COLUMN_RESIZED = 'columnResized';
38
39 /** The list of displayed columns has changed, can result from columns open / close, column move, pivot, group, etc */
40 public static EVENT_DISPLAYED_COLUMNS_CHANGED = 'displayedColumnsChanged';
41
42 /** The list of virtual columns has changed, results from viewport changing */
43 public static EVENT_VIRTUAL_COLUMNS_CHANGED = 'virtualColumnsChanged';
44
45 /** A row group was opened / closed */
46 public static EVENT_ROW_GROUP_OPENED = 'rowGroupOpened';
47
48 /** The client has set new data into the grid */
49 public static EVENT_ROW_DATA_CHANGED = 'rowDataChanged';
50
51 /** The client has updated data for the grid */
52 public static EVENT_ROW_DATA_UPDATED = 'rowDataUpdated';
53
54 /** The client has set new floating data into the grid */
55 public static EVENT_PINNED_ROW_DATA_CHANGED = 'pinnedRowDataChanged';
56
57 /** Range selection has changed */
58 public static EVENT_RANGE_SELECTION_CHANGED = 'rangeSelectionChanged';
59
60 /** For when the tool panel is shown / hidden */
61 public static EVENT_TOOL_PANEL_VISIBLE_CHANGED = 'toolPanelVisibleChanged';
62
63 /** Model was updated - grid updates the drawn rows when this happens */
64 public static EVENT_MODEL_UPDATED = 'modelUpdated';
65
66 public static EVENT_PASTE_START = 'pasteStart';
67 public static EVENT_PASTE_END = 'pasteEnd';
68
69 public static EVENT_CELL_CLICKED = 'cellClicked';
70 public static EVENT_CELL_DOUBLE_CLICKED = 'cellDoubleClicked';
71 public static EVENT_CELL_MOUSE_DOWN = 'cellMouseDown';
72 public static EVENT_CELL_CONTEXT_MENU = 'cellContextMenu';
73 public static EVENT_CELL_VALUE_CHANGED = 'cellValueChanged';
74 public static EVENT_ROW_VALUE_CHANGED = 'rowValueChanged';
75 public static EVENT_CELL_FOCUSED = 'cellFocused';
76 public static EVENT_ROW_SELECTED = 'rowSelected';
77 public static EVENT_SELECTION_CHANGED = 'selectionChanged';
78
79 public static EVENT_CELL_MOUSE_OVER = 'cellMouseOver';
80 public static EVENT_CELL_MOUSE_OUT = 'cellMouseOut';
81
82 /** 2 events for filtering. The grid LISTENS for filterChanged and afterFilterChanged */
83 public static EVENT_FILTER_CHANGED = 'filterChanged';
84
85 /** Filter was change but not applied. Only useful if apply buttons are used in filters. */
86 public static EVENT_FILTER_MODIFIED = 'filterModified';
87
88 public static EVENT_SORT_CHANGED = 'sortChanged';
89
90 /** A row was removed from the dom, for any reason. Use to clean up resources (if any) used by the row. */
91 public static EVENT_VIRTUAL_ROW_REMOVED = 'virtualRowRemoved';
92
93 public static EVENT_ROW_CLICKED = 'rowClicked';
94 public static EVENT_ROW_DOUBLE_CLICKED = 'rowDoubleClicked';
95
96 /** Gets called once after the grid has finished initialising. */
97 public static EVENT_GRID_READY = 'gridReady';
98 /** Width of height of the main grid div has changed. Grid listens for this and does layout of grid if it's
99 * changed, so always filling the space it was given. */
100 public static EVENT_GRID_SIZE_CHANGED = 'gridSizeChanged';
101 /** The indexes of the rows rendered has changed, eg user has scrolled to a new vertical position. */
102 public static EVENT_VIEWPORT_CHANGED = 'viewportChanged';
103 /** A column drag has started, either resizing a column or moving a column. */
104 public static EVENT_DRAG_STARTED = 'dragStarted';
105 /** A column drag has stopped */
106 public static EVENT_DRAG_STOPPED = 'dragStopped';
107
108 public static EVENT_ROW_EDITING_STARTED = 'rowEditingStarted';
109 public static EVENT_ROW_EDITING_STOPPED = 'rowEditingStopped';
110
111 public static EVENT_CELL_EDITING_STARTED = 'cellEditingStarted';
112 public static EVENT_CELL_EDITING_STOPPED = 'cellEditingStopped';
113
114 /** Main body of grid has scrolled, either horizontally or vertically */
115 public static EVENT_BODY_SCROLL = 'bodyScroll';
116
117 public static EVENT_ANIMATION_QUEUE_EMPTY = 'animationQueueEmpty';
118
119 public static EVENT_HEIGHT_SCALE_CHANGED = 'heightScaleChanged';
120
121 /** The displayed page for pagination has changed. For example the data was filtered or sorted,
122 * or the user has moved to a different page. */
123 public static EVENT_PAGINATION_CHANGED = 'paginationChanged';
124
125 /** Only used by React, Angular 2+, Web Components, Aurelia and VueJS ag-Grid components
126 * (not used if doing plain JavaScript or Angular 1.x). If the grid receives changes due
127 * to bound properties, this event fires after the grid has finished processing the change. */
128 public static EVENT_COMPONENT_STATE_CHANGED = 'componentStateChanged';
129
130 /** All items from here down are used internally by the grid, not intended for external use. */
131 // not documented, either experimental, or we just don't want users using an depending on them
132 public static EVENT_BODY_HEIGHT_CHANGED = 'bodyHeightChanged';
133 public static EVENT_DISPLAYED_COLUMNS_WIDTH_CHANGED = 'displayedColumnsWidthChanged';
134 public static EVENT_SCROLL_VISIBILITY_CHANGED = 'scrollVisibilityChanged';
135 public static EVENT_COLUMN_HOVER_CHANGED = 'columnHoverChanged';
136 public static EVENT_FLASH_CELLS = 'flashCells';
137
138 public static EVENT_ROW_DRAG_ENTER = 'rowDragEnter';
139 public static EVENT_ROW_DRAG_MOVE = 'rowDragMove';
140 public static EVENT_ROW_DRAG_LEAVE = 'rowDragLeave';
141 public static EVENT_ROW_DRAG_END = 'rowDragEnd';
142
143 // these are used for server side group and agg - only used by CS with Viewport Row Model - intention is
144 // to design these better around server side functions and then release to general public when fully working with
145 // all the row models.
146 public static EVENT_COLUMN_ROW_GROUP_CHANGE_REQUEST = 'columnRowGroupChangeRequest';
147 public static EVENT_COLUMN_PIVOT_CHANGE_REQUEST = 'columnPivotChangeRequest';
148 public static EVENT_COLUMN_VALUE_CHANGE_REQUEST = 'columnValueChangeRequest';
149 public static EVENT_COLUMN_AGG_FUNC_CHANGE_REQUEST = 'columnAggFuncChangeRequest';
150}