eventKeys.d.ts 6.5 KB

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