events.d.ts 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. import { RowNode } from './entities/rowNode';
  2. import { Column } from './entities/column';
  3. import { ColDef } from './entities/colDef';
  4. import { GridApi } from './gridApi';
  5. import { ColumnApi } from './columnController/columnApi';
  6. import { OriginalColumnGroup } from './entities/originalColumnGroup';
  7. import { FilterRequestSource } from './filter/filterManager';
  8. import { ChartOptions, ChartType } from './interfaces/iChartOptions';
  9. import { IFilterComp } from './interfaces/iFilter';
  10. import { CellRange, CellRangeParams } from './interfaces/iRangeController';
  11. import { ChartModel } from './interfaces/IChartService';
  12. export { Events } from './eventKeys';
  13. export interface ModelUpdatedEvent extends AgGridEvent {
  14. /** If true, the grid will try and animate the rows to the new positions */
  15. animate: boolean | undefined;
  16. /** If true, the grid has new data loaded, eg user called setRowData(), otherwise
  17. * it's the same data but sorted or filtered, in which case this is true, and rows
  18. * can animate around (eg rowNode id 24 is the same row node as last time). */
  19. keepRenderedRows: boolean | undefined;
  20. /** If true, then this update was a result of setRowData() getting called. This
  21. * gets the grid to scroll to the top again. */
  22. newData: boolean | undefined;
  23. /** True when pagination and a new page is navigated to. */
  24. newPage: boolean;
  25. }
  26. export interface AgEvent {
  27. type: string;
  28. }
  29. export interface AgGridEvent extends AgEvent {
  30. api: GridApi;
  31. columnApi: ColumnApi;
  32. }
  33. export interface ToolPanelVisibleChangedEvent extends AgGridEvent {
  34. source: string | undefined;
  35. }
  36. export interface AnimationQueueEmptyEvent extends AgGridEvent {
  37. }
  38. export interface ColumnPivotModeChangedEvent extends AgGridEvent {
  39. }
  40. export interface VirtualColumnsChangedEvent extends AgGridEvent {
  41. }
  42. export interface ColumnEverythingChangedEvent extends AgGridEvent {
  43. source: string;
  44. }
  45. export interface NewColumnsLoadedEvent extends AgGridEvent {
  46. }
  47. export interface GridColumnsChangedEvent extends AgGridEvent {
  48. }
  49. export interface DisplayedColumnsChangedEvent extends AgGridEvent {
  50. }
  51. export interface RowDataChangedEvent extends AgGridEvent {
  52. }
  53. export interface RowDataUpdatedEvent extends AgGridEvent {
  54. }
  55. export interface PinnedRowDataChangedEvent extends AgGridEvent {
  56. }
  57. export interface SelectionChangedEvent extends AgGridEvent {
  58. }
  59. export interface FilterChangedEvent extends AgGridEvent {
  60. afterDataChange?: boolean;
  61. afterFloatingFilter?: boolean;
  62. }
  63. export interface FilterModifiedEvent extends AgGridEvent {
  64. filterInstance: IFilterComp;
  65. column: Column;
  66. }
  67. export interface FilterOpenedEvent extends AgGridEvent {
  68. column: Column;
  69. source: FilterRequestSource;
  70. eGui: HTMLElement;
  71. }
  72. export interface SortChangedEvent extends AgGridEvent {
  73. }
  74. export interface GridReadyEvent extends AgGridEvent {
  75. }
  76. export interface DisplayedColumnsWidthChangedEvent extends AgGridEvent {
  77. }
  78. export interface ColumnHoverChangedEvent extends AgGridEvent {
  79. }
  80. export interface BodyHeightChangedEvent extends AgGridEvent {
  81. }
  82. export interface ComponentStateChangedEvent extends AgGridEvent {
  83. }
  84. export interface DragEvent extends AgGridEvent {
  85. type: string;
  86. target: HTMLElement;
  87. }
  88. export interface DragStartedEvent extends DragEvent {
  89. }
  90. export interface DragStoppedEvent extends DragEvent {
  91. }
  92. export interface CheckboxChangedEvent extends AgEvent {
  93. id: string;
  94. name: string;
  95. selected?: boolean;
  96. }
  97. export interface GridSizeChangedEvent extends AgGridEvent {
  98. clientWidth: number;
  99. clientHeight: number;
  100. }
  101. export interface RowDragEvent extends AgGridEvent {
  102. node: RowNode;
  103. nodes: RowNode[];
  104. y: number;
  105. vDirection: string;
  106. event: MouseEvent;
  107. overIndex: number;
  108. overNode: RowNode;
  109. }
  110. export interface RowDragEnterEvent extends RowDragEvent {
  111. }
  112. export interface RowDragEndEvent extends RowDragEvent {
  113. }
  114. export interface RowDragMoveEvent extends RowDragEvent {
  115. }
  116. export interface RowDragLeaveEvent extends RowDragEvent {
  117. }
  118. export interface PasteStartEvent extends AgGridEvent {
  119. source: string;
  120. }
  121. export interface PasteEndEvent extends AgGridEvent {
  122. source: string;
  123. }
  124. export interface FillStartEvent extends AgGridEvent {
  125. }
  126. export interface FillEndEvent extends AgGridEvent {
  127. initialRange: CellRange;
  128. finalRange: CellRange;
  129. }
  130. export interface ViewportChangedEvent extends AgGridEvent {
  131. firstRow: number;
  132. lastRow: number;
  133. }
  134. export interface FirstDataRenderedEvent extends AgGridEvent {
  135. firstRow: number;
  136. lastRow: number;
  137. }
  138. export interface RangeSelectionChangedEvent extends AgGridEvent {
  139. id?: string;
  140. finished: boolean;
  141. started: boolean;
  142. }
  143. export interface ChartCreated extends AgGridEvent {
  144. chartId: string;
  145. chartModel: ChartModel;
  146. }
  147. export interface ChartRangeSelectionChanged extends AgGridEvent {
  148. id: string;
  149. chartId: string;
  150. cellRange: CellRangeParams;
  151. }
  152. export interface ChartOptionsChanged extends AgGridEvent {
  153. chartId: string;
  154. chartType: ChartType;
  155. chartPalette: string;
  156. chartOptions: ChartOptions<any>;
  157. }
  158. export interface ChartDestroyed extends AgGridEvent {
  159. chartId: string;
  160. }
  161. export interface ColumnGroupOpenedEvent extends AgGridEvent {
  162. columnGroup: OriginalColumnGroup;
  163. }
  164. export interface ItemsAddedEvent extends AgGridEvent {
  165. items: RowNode[];
  166. }
  167. export interface BodyScrollEvent extends AgGridEvent {
  168. direction: string;
  169. left: number;
  170. top: number;
  171. }
  172. export interface FlashCellsEvent extends AgGridEvent {
  173. cells: any;
  174. }
  175. export interface PaginationChangedEvent extends AgGridEvent {
  176. animate?: boolean;
  177. keepRenderedRows?: boolean;
  178. newData?: boolean;
  179. newPage: boolean;
  180. }
  181. export interface CellFocusedEvent extends AgGridEvent {
  182. rowIndex: number;
  183. column: Column;
  184. rowPinned: string;
  185. forceBrowserFocus: boolean;
  186. floating: string;
  187. }
  188. export interface ExpandCollapseAllEvent extends AgGridEvent {
  189. source: string;
  190. }
  191. /**---------------*/
  192. /** COLUMN EVENTS */
  193. /**---------------*/
  194. export declare type ColumnEventType = "sizeColumnsToFit" | "autosizeColumns" | "alignedGridChanged" | "filterChanged" | "filterDestroyed" | "gridOptionsChanged" | "gridInitializing" | "toolPanelDragAndDrop" | "toolPanelUi" | "uiColumnMoved" | "uiColumnResized" | "uiColumnDragged" | "uiColumnExpanded" | "uiColumnSorted" | "contextMenu" | "columnMenu" | "rowModelUpdated" | "api" | "flex" | "pivotChart";
  195. export interface ColumnEvent extends AgGridEvent {
  196. column: Column | null;
  197. columns: Column[] | null;
  198. source: ColumnEventType;
  199. }
  200. export interface ColumnResizedEvent extends ColumnEvent {
  201. finished: boolean;
  202. }
  203. export interface ColumnPivotChangedEvent extends ColumnEvent {
  204. }
  205. export interface ColumnRowGroupChangedEvent extends ColumnEvent {
  206. }
  207. export interface ColumnValueChangedEvent extends ColumnEvent {
  208. }
  209. export interface ColumnMovedEvent extends ColumnEvent {
  210. toIndex: number | undefined;
  211. }
  212. export interface ColumnVisibleEvent extends ColumnEvent {
  213. visible: boolean | undefined;
  214. }
  215. export interface ColumnPinnedEvent extends ColumnEvent {
  216. pinned: string | null;
  217. }
  218. /**------------*/
  219. /** ROW EVENTS */
  220. /**------------*/
  221. export interface RowEvent extends AgGridEvent {
  222. node: RowNode;
  223. data: any;
  224. rowIndex: number;
  225. rowPinned: string;
  226. context: any;
  227. event?: Event | null;
  228. }
  229. export interface RowGroupOpenedEvent extends RowEvent {
  230. expanded: boolean;
  231. }
  232. export interface RowValueChangedEvent extends RowEvent {
  233. }
  234. export interface RowSelectedEvent extends RowEvent {
  235. }
  236. export interface VirtualRowRemovedEvent extends RowEvent {
  237. }
  238. export interface RowClickedEvent extends RowEvent {
  239. }
  240. export interface RowDoubleClickedEvent extends RowEvent {
  241. }
  242. export interface RowEditingStartedEvent extends RowEvent {
  243. }
  244. export interface RowEditingStoppedEvent extends RowEvent {
  245. }
  246. /**------------*/
  247. /** CELL EVENTS */
  248. /**------------*/
  249. export interface CellEvent extends RowEvent {
  250. column: Column;
  251. colDef: ColDef;
  252. value: any;
  253. }
  254. export interface CellKeyDownEvent extends CellEvent {
  255. }
  256. export interface CellKeyPressEvent extends CellEvent {
  257. }
  258. export interface CellClickedEvent extends CellEvent {
  259. }
  260. export interface CellMouseDownEvent extends CellEvent {
  261. }
  262. export interface CellDoubleClickedEvent extends CellEvent {
  263. }
  264. export interface CellMouseOverEvent extends CellEvent {
  265. }
  266. export interface CellMouseOutEvent extends CellEvent {
  267. }
  268. export interface CellContextMenuEvent extends CellEvent {
  269. }
  270. export interface CellEditingStartedEvent extends CellEvent {
  271. }
  272. export interface CellEditingStoppedEvent extends CellEvent {
  273. }
  274. export interface CellValueChangedEvent extends CellEvent {
  275. oldValue: any;
  276. newValue: any;
  277. source: string | undefined;
  278. }
  279. export interface ColumnRequestEvent extends AgGridEvent {
  280. columns: Column[];
  281. }
  282. export interface ColumnRowGroupChangeRequestEvent extends ColumnRequestEvent {
  283. }
  284. export interface ColumnPivotChangeRequestEvent extends ColumnRequestEvent {
  285. }
  286. export interface ColumnValueChangeRequestEvent extends ColumnRequestEvent {
  287. }
  288. export interface ColumnAggFuncChangeRequestEvent extends ColumnRequestEvent {
  289. aggFunc: any;
  290. }
  291. export interface ScrollVisibilityChangedEvent extends AgGridEvent {
  292. }