{"componentChunkName":"component---src-templates-doc-page-jsx","path":"/angular-grid/grid-events/","result":{"data":{"markdownRemark":{"htmlAst":{"type":"root","children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"This is a list of the events that the grid raises. You can register callbacks for these events through the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"GridOptions"}]},{"type":"text","value":" interface."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"The name of the callback is constructed by prefixing the event name with "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"on"}]},{"type":"text","value":". For example, the callback for the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"cellClicked"}]},{"type":"text","value":" event is "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"gridOptions.onCellClicked"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["custom-block","note"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"TypeScript users can take advantage of the events' interfaces. You can construct the interface name by suffixing the event name with "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"Event"}]},{"type":"text","value":". For example, the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"cellClicked"}]},{"type":"text","value":" event uses the interface "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"CellClickedEvent"}]},{"type":"text","value":"."}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["custom-block","note"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"See the "},{"type":"element","tagName":"a","properties":{"href":"#properties-and-hierarchy"},"children":[{"type":"text","value":"Event Properties and Hierarchy"}]},{"type":"text","value":" section below to find out what properties each event has."}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"api-documentation","properties":{"source":"events.json"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"event-properties-and-hierarchy","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#event-properties-and-hierarchy","ariaLabel":"event properties and hierarchy permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","dataPrefix":"fas","dataIcon":"link","className":["svg-inline--fa","fa-link"],"role":"img","xmlns":"http://www.w3.org/2000/svg","viewBox":"0 0 512 512"},"children":[{"type":"element","tagName":"path","properties":{"fill":"currentColor","d":"M326.612 185.391c59.747 59.809 58.927 155.698.36 214.59-.11.12-.24.25-.36.37l-67.2 67.2c-59.27 59.27-155.699 59.262-214.96 0-59.27-59.26-59.27-155.7 0-214.96l37.106-37.106c9.84-9.84 26.786-3.3 27.294 10.606.648 17.722 3.826 35.527 9.69 52.721 1.986 5.822.567 12.262-3.783 16.612l-13.087 13.087c-28.026 28.026-28.905 73.66-1.155 101.96 28.024 28.579 74.086 28.749 102.325.51l67.2-67.19c28.191-28.191 28.073-73.757 0-101.83-3.701-3.694-7.429-6.564-10.341-8.569a16.037 16.037 0 0 1-6.947-12.606c-.396-10.567 3.348-21.456 11.698-29.806l21.054-21.055c5.521-5.521 14.182-6.199 20.584-1.731a152.482 152.482 0 0 1 20.522 17.197zM467.547 44.449c-59.261-59.262-155.69-59.27-214.96 0l-67.2 67.2c-.12.12-.25.25-.36.37-58.566 58.892-59.387 154.781.36 214.59a152.454 152.454 0 0 0 20.521 17.196c6.402 4.468 15.064 3.789 20.584-1.731l21.054-21.055c8.35-8.35 12.094-19.239 11.698-29.806a16.037 16.037 0 0 0-6.947-12.606c-2.912-2.005-6.64-4.875-10.341-8.569-28.073-28.073-28.191-73.639 0-101.83l67.2-67.19c28.239-28.239 74.3-28.069 102.325.51 27.75 28.3 26.872 73.934-1.155 101.96l-13.087 13.087c-4.35 4.35-5.769 10.79-3.783 16.612 5.864 17.194 9.042 34.999 9.69 52.721.509 13.906 17.454 20.446 27.294 10.606l37.106-37.106c59.271-59.259 59.271-155.699.001-214.959z"},"children":[]}]}]},{"type":"text","value":"Event Properties and Hierarchy"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Below shows the event hierarchy and properties. All properties are inherited. For example the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"CellValueChangedEvent"}]},{"type":"text","value":" interface has the following properties:"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["gatsby-highlight"],"dataLanguage":"ts"},"children":[{"type":"element","tagName":"pre","properties":{"className":["language-ts"]},"children":[{"type":"element","tagName":"code","properties":{"className":["language-ts"]},"children":[{"type":"element","tagName":"span","properties":{"className":["token","keyword"]},"children":[{"type":"text","value":"interface"}]},{"type":"text","value":" "},{"type":"element","tagName":"span","properties":{"className":["token","class-name"]},"children":[{"type":"text","value":"CellValueChangedEvent"}]},{"type":"text","value":" "},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":"{"}]},{"type":"text","value":"\n    "},{"type":"element","tagName":"span","properties":{"className":["token","keyword"]},"children":[{"type":"text","value":"type"}]},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" api"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" columnApi"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" "},{"type":"element","tagName":"span","properties":{"className":["token","comment"]},"children":[{"type":"text","value":"// -> properties from AgEvent"}]},{"type":"text","value":"\n    node"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" data"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" rowIndex"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" rowPinned"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" context"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" event"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" "},{"type":"element","tagName":"span","properties":{"className":["token","comment"]},"children":[{"type":"text","value":"// -> properties from RowEvent"}]},{"type":"text","value":"\n    column"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" colDef"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" value"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" "},{"type":"element","tagName":"span","properties":{"className":["token","comment"]},"children":[{"type":"text","value":"// -> properties from CellEvent"}]},{"type":"text","value":"\n    oldValue"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":","}]},{"type":"text","value":" newValue "},{"type":"element","tagName":"span","properties":{"className":["token","comment"]},"children":[{"type":"text","value":"// -> properties from CellValueChangedEvent"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"span","properties":{"className":["token","punctuation"]},"children":[{"type":"text","value":"}"}]}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"pre","properties":{"className":["event-hierarchy"]},"children":[{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"//---------------------------------------------------------//"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"// Event hierarchy, and properties, for all AG Grid events //"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"//---------------------------------------------------------//"}]},{"type":"text","value":"\n└── AgEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n    │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"type"}]},{"type":"text","value":": string, // the event type, eg 'sortChanged' or 'columnResized'\n    │   }"}]},{"type":"text","value":"\n    └── AgGridEvent\n        │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"api"}]},{"type":"text","value":": GridAPI, // see [Grid API](/grid-api/)\n        │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"columnApi"}]},{"type":"text","value":": ColumnAPI // see [Column API](/column-api/)\n        │   }\n        ├── GridReadyEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── SelectionChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── SortChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── RowDataChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── RowDataUpdatedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── PinnedRowDataChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── NewColumnsLoadedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── GridColumnsChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── VirtualColumnsChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── ColumnPivotModeChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── ColumnEverythingChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── DisplayedColumnsChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── ToolPanelVisibleChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── AnimationQueueEmptyEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── FilterChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{"}]},{"type":"text","value":"\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"afterFloatingFilter"}]},{"type":"text","value":": Column, // if filter was changed via floating filter\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"afterDataChange"}]},{"type":"text","value":": number, // if filter was changed as a result of data changing\n        │     }\n        ├── FilterModifiedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{"}]},{"type":"text","value":"\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"column"}]},{"type":"text","value":": Column, // the column for the event\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"filterInstance"}]},{"type":"text","value":": number, // the filter instance\n        │     }\n        ├── CellFocusedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"rowIndex"}]},{"type":"text","value":": number, // the row index of the focused cell\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"column"}]},{"type":"text","value":": Column, // the column of the focused cell\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"rowPinned"}]},{"type":"text","value":": string, // either 'top', 'bottom' or undefined/null (if not pinned)\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"forceBrowserFocus"}]},{"type":"text","value":": boolean // whether browser focus is also set (false when editing)\n        │     }"}]},{"type":"text","value":"\n        ├── ViewportChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"firstRow"}]},{"type":"text","value":": number, // the index of the first rendered row\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"lastRow"}]},{"type":"text","value":": number // the index of the last rendered row\n        │     }"}]},{"type":"text","value":"\n        ├── FirstDataRendereredEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"firstRow"}]},{"type":"text","value":": number, // the index of the first rendered row\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"lastRow"}]},{"type":"text","value":": number // the index of the last rendered row\n        │     }"}]},{"type":"text","value":"\n        ├── GridSizeChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"clientWidth"}]},{"type":"text","value":": number, // the grids DIV's clientWidth\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"clientHeight"}]},{"type":"text","value":": number // the grids DIV's clientHeight\n        │     }"}]},{"type":"text","value":"\n        ├── RangeSelectionChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"started"}]},{"type":"text","value":": boolean, // true for first event in a sequence of dragging events\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"finished"}]},{"type":"text","value":": boolean // true for last event in sequence of dragging events\n        │     }"}]},{"type":"text","value":"\n        ├── ColumnGroupOpenedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"columnGroup"}]},{"type":"text","value":": OriginalColumnGroup // the original column group that was opened\n        │     }"}]},{"type":"text","value":"\n        ├── BodyScrollEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"direction"}]},{"type":"text","value":": string // either 'horizontal' or 'vertical'\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"top"}]},{"type":"text","value":": number // top px of the scroll\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"left"}]},{"type":"text","value":": number // left px of the scroll\n        │     }"}]},{"type":"text","value":"\n        ├── PaginationChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"animate"}]},{"type":"text","value":": boolean, // true if rows were animated to new position\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"keepRenderedRows"}]},{"type":"text","value":": boolean, // true if rows were kept (otherwise complete redraw)\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"newData"}]},{"type":"text","value":": boolean, // true if data was new (ie user set new data)\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"newPage"}]},{"type":"text","value":": boolean // true if user went to a new pagination page\n        │     }"}]},{"type":"text","value":"\n        ├── ModelUpdatedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"animate"}]},{"type":"text","value":": boolean, // true if rows were animated to new position\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"keepRenderedRows"}]},{"type":"text","value":": boolean, // true if rows were kept (otherwise complete redraw)\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"newData"}]},{"type":"text","value":": boolean, // true if data was new (ie user set new data)\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"newPage"}]},{"type":"text","value":": boolean // true if user went to a new pagination page\n        │     }"}]},{"type":"text","value":"\n        ├── ComponentStateChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       // one attribute for each changed property\n        │     }"}]},{"type":"text","value":"\n        ├── ExpandCollapseAllEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"source"}]},{"type":"text","value":": string\n        │     }"}]},{"type":"text","value":"\n        ├── AsyncTransactionsFlushed "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │       "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"results"}]},{"type":"text","value":": (RowNodeTransaction | ServerSideTransactionResult) []\n        │     }"}]},{"type":"text","value":"\n        ├── DragEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"type"}]},{"type":"text","value":": string, // one of {'cell','row','headerCell','toolPanel'}\n                 "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"target"}]},{"type":"text","value":": HTMLElement, // The DOM element that started the event.\n        │   │  }"}]},{"type":"text","value":"\n        │   ├── DragStartedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        │   ├── DragStoppedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n        ├── RowDragEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{ // abstract event, never fired\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"event"}]},{"type":"text","value":": MouseEvent, // The underlying mouse move event associated with the drag.\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"node"}]},{"type":"text","value":": RowNode, // The row node getting dragged. Also the node that started the drag when multi-row dragging.\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"nodes"}]},{"type":"text","value":": RowNode[], // The list of nodes being dragged.\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"overIndex"}]},{"type":"text","value":": number, // The row index the mouse is dragging over.\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"overNode"}]},{"type":"text","value":": RowNode, // The row node the mouse is dragging over.\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"y"}]},{"type":"text","value":": number, // The vertical pixel location the mouse is over.\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"vDirection"}]},{"type":"text","value":": string, // Direction of the drag, either 'up', 'down' or null.\n        │   │  }"}]},{"type":"text","value":"\n        │   ├── RowDragEnterEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":" // row drag has started / re-entered\n        │   ├── RowDragMoveEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":" // mouse moved while dragging\n        │   ├── RowDragEndEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":" // row drag finished while mouse over grid\n        │   ├── RowDragLeaveEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":" // mouse left grid while dragging\n        ├── ColumnEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"column"}]},{"type":"text","value":": Column, // the impacted column, only set if action was on one column\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"columns"}]},{"type":"text","value":": Column[] // list of all impacted columns\n        │   │    "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"source"}]},{"type":"text","value":": string // A string describing where the event is coming from\n        │   │  }"}]},{"type":"text","value":"\n        │   ├── ColumnPivotChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":" // a column was added / removed to pivot list\n        │   ├── ColumnRowGroupChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":" // a column was added / removed to row group list\n        │   ├── ColumnValueChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":" // a column was added / removed to values list\n        │   ├── ColumnMovedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │   │        "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"toIndex"}]},{"type":"text","value":": number // the position the column was moved to\n        │   │      }"}]},{"type":"text","value":"\n        │   ├── ColumnResizedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │   │        "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"finished"}]},{"type":"text","value":": boolean // set to true for last event in a sequence of move events\n        │   │        "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"flexColumns"}]},{"type":"text","value":": Column[] // any columns resized due to flex\n        │   │      }"}]},{"type":"text","value":"\n        │   ├── ColumnVisibleEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │   │        "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"visible"}]},{"type":"text","value":": boolean // true if column was set to visible, false if set to hide\n        │   │      }"}]},{"type":"text","value":"\n        │   └── ColumnPinnedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n        │            "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"pinned"}]},{"type":"text","value":": string // either 'left', 'right', or undefined / null (it not pinned)\n        │          }"}]},{"type":"text","value":"\n        └── RowEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n            │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"node"}]},{"type":"text","value":": RowNode, // the RowNode for the row in question\n            │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"data"}]},{"type":"text","value":": any, // the user provided data for the row in question\n            │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"rowIndex"}]},{"type":"text","value":": number, // the visible row index for the row in question\n            │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"rowPinned"}]},{"type":"text","value":": string, // either 'top', 'bottom' or undefined / null (if not pinned)\n            │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"context"}]},{"type":"text","value":": any, // bag of attributes, provided by user, see [Context](/context/)\n            │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"event?"}]},{"type":"text","value":": Event // if event was due to browser event (eg click), this is browser event\n            │   }"}]},{"type":"text","value":"\n            ├── RowSelectedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n            ├── RowClickedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n            ├── RowDoubleClickedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n            ├── RowEditingStartedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n            ├── RowEditingStoppedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n            ├── RowGroupOpenedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n            │     "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"expanded"}]},{"type":"text","value":": boolean // true if the group is expanded.\n            }"}]},{"type":"text","value":"\n            ├── RowValueChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n            ├── VirtualRowRemovedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n            └── CellEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n                │   "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"column"}]},{"type":"text","value":": Column, // the column for the cell in question\n                │   "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"colDef"}]},{"type":"text","value":": ColDef, // the column definition for the cell in question\n                │   "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"value"}]},{"type":"text","value":": any // the value for the cell in question\n                │ }"}]},{"type":"text","value":"\n                ├── CellClickedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellMouseDownEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellDoubleClickedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellMouseOverEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellMouseOutEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellContextMenuEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellEditingStartedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellKeyDown "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellKeyPress "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{}"}]},{"type":"text","value":"\n                ├── CellEditingStoppedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n                        "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"oldValue"}]},{"type":"text","value":": any, // the old value before editing\n                        "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"newValue"}]},{"type":"text","value":": any // the new value after editing\n                      }"}]},{"type":"text","value":"\n                └── CellValueChangedEvent "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__property"]},"children":[{"type":"text","value":"{\n                        "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"oldValue"}]},{"type":"text","value":": any, // the old value before editing\n                        "},{"type":"element","tagName":"span","properties":{"className":["event-hierarchy__attribute"]},"children":[{"type":"text","value":"newValue"}]},{"type":"text","value":": any // the new value after editing\n                      }"}]}]}],"data":{"quirksMode":false}},"frontmatter":{"title":"Grid Events","enterprise":null,"description":null},"headings":[{"id":"event-properties-and-hierarchy","depth":2,"value":"Event Properties and Hierarchy"}]}},"pageContext":{"frameworks":["javascript","angular","react","vue"],"framework":"angular","srcPath":"/grid-events","pageName":"grid-events"}},"staticQueryHashes":["1766026005","3577950178","3666212512"]}