zinggrid/docs_output/events/events.json

ZingGrid - A fully-featured, native, web-component, data table and grid for Javascript applications.

{"ZGElement":{"events":[]},"ZGMenuItem":{"events":[{"name":"menu-item:click","description":"Fires the event when custom menu item is clicked.","demoLink":"https://app.zingsoft.com/demos/create/B7HRCHKV","returns":[{"type":"Object","description":"The DOM cell.","name":"ZGData.DOMCell"},{"type":"Object","description":"The relevant DOM cell.","name":"ZGData.cell"},{"type":"Object","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Object","description":"Reference to the grid.","name":"ZGData.grid"},{"type":"Object","description":"The relevant header.","name":"ZGData.header"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"}],"dependency":"The 'menu:click' event listener must be added to the custom menu item.","tagName":"zg-menu-item","fullName":"zg-menu-item-event-menu-item_click","category":"Event"}]},"ZingGrid":{"events":[{"name":"grid:beforerender","description":"Fires the event once before the grid renders.","demoLink":"https://app.zingsoft.com/demos/create/1LW0Y3IJ","returns":[],"dependency":"","tagName":"zing-grid","fullName":"zing-grid-event-grid_beforerender","category":"Event"},{"name":"grid:columnmove","description":"Fires the event when a column is moved to a frozen spot or within a fram","demoLink":"https://app.zingsoft.com/demos/create/TCRV6L78","returns":[{"type":"String","description":"The fieldIndex of the moved column","name":"ZGData.fieldIndex"},{"type":"Number","description":"The old numerical index of the moved column","name":"ZGData.oldIndex"},{"type":"Number","description":"The new numerical index of the moved column","name":"ZGData.newIndex"},{"type":"String","description":"The frozen state of the moved column","name":"ZGData.frozen"}],"dependency":"The `column-drag` attribute is required on the `zing-grid` tag or `frozen` needs to be enabled","tagName":"zing-grid","fullName":"zing-grid-event-grid_columnmove","category":"Event"},{"name":"grid:columntogglevisiblity","description":"Fires the event when a column is hidden or shown","demoLink":"https://app.zingsoft.com/demos/create/0865V962","returns":[{"type":"String","description":"The fieldIndex of the moved column","name":"ZGData.fieldIndex"},{"type":"Boolean","description":"Indicates if the column is hidden","name":"ZGData.hidden"}],"dependency":"The `columns-control` or `column-drag` attribute is required on the `zing-grid` tag","tagName":"zing-grid","fullName":"zing-grid-event-grid_columntogglevisiblity","category":"Event"},{"name":"grid:contextmenuclose","description":"Fires the  event when the contextmenu is closed.","demoLink":"https://app.zingsoft.com/demos/create/5HOE3VVY","returns":[],"dependency":"The `context-menu` or `static-menu` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_contextmenuclose","category":"Event"},{"name":"grid:contextmenuopen","description":"Fires the event when the contextmenu is opened.","demoLink":"https://app.zingsoft.com/demos/create/DEZC9FG9","returns":[],"dependency":"The `context-menu` or `static-menu` attribute(s) are required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_contextmenuopen","category":"Event"},{"name":"grid:deselect","description":"Fires the event when selection is deselected in the grid.","demoLink":"https://app.zingsoft.com/demos/create/ANIPLA5G","returns":[],"dependency":"The `selector` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_deselect","category":"Event"},{"name":"grid:hydrate","description":"Fires the event when the pre-rendered grid is finished being hydrated.","demoLink":"https://app.zingsoft.com/demos/create/ZXLKFSXX","returns":[],"dependency":"The `server-rendered` attribute is required on pre-rendered `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_hydrate","category":"Event"},{"name":"grid:keydownesc","description":"Fires the event when the (Esc) key is pressed.","demoLink":"https://app.zingsoft.com/demos/create/EVFXSLSR","returns":[],"dependency":"","tagName":"zing-grid","fullName":"zing-grid-event-grid_keydownesc","category":"Event"},{"name":"grid:pagechange","description":"Fires the event when a page changes in the grid.","demoLink":"https://app.zingsoft.com/demos/create/LD0VIDBT","returns":[{"type":"Number","description":"The current page index.","name":"ZGData.currentPage"},{"type":"Number","description":"The current `page-size` of the grid.","name":"ZGData.pageSize"}],"dependency":"The `pager` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_pagechange","category":"Event"},{"name":"grid:pagefirst","description":"Fires the event when the grid changes to the first page.","demoLink":"https://app.zingsoft.com/demos/create/PMNIA14U","returns":[{"type":"Number","description":"The current page index.","name":"ZGData.currentPage"},{"type":"Number","description":"The current `page-size` of the grid.","name":"ZGData.pageSize"}],"dependency":"The `pager` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_pagefirst","category":"Event"},{"name":"grid:pagelast","description":"Fires the event when the grid changes to the last page.","demoLink":"https://app.zingsoft.com/demos/create/U0GLM0S7","returns":[{"type":"Number","description":"The current page index.","name":"ZGData.currentPage"},{"type":"Number","description":"The current `page-size` of the grid.","name":"ZGData.pageSize"}],"dependency":"The `pager` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_pagelast","category":"Event"},{"name":"grid:pagenext","description":"Fires the event when the grid changes to the next page.","demoLink":"https://app.zingsoft.com/demos/create/FAIUS72C","returns":[{"type":"Number","description":"The current page index.","name":"ZGData.currentPage"},{"type":"Number","description":"The current `page-size` of the grid.","name":"ZGData.pageSize"}],"dependency":"The `pager` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_pagenext","category":"Event"},{"name":"grid:pageprev","description":"Fires the event when the grid changes to the previous page.","demoLink":"https://app.zingsoft.com/demos/create/RME68BWF","returns":[{"type":"Number","description":"The current page index.","name":"ZGData.currentPage"},{"type":"Number","description":"The current `page-size` of the grid.","name":"ZGData.pageSize"}],"dependency":"The `pager` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_pageprev","category":"Event"},{"name":"grid:pagesizechange","description":"Fires the event when the `page-size` (amount of rows displaying) changes on the grid.","demoLink":"https://app.zingsoft.com/demos/create/WQGF796I","returns":[{"type":"Number","description":"The current page index.","name":"ZGData.currentPage"},{"type":"Number","description":"The old `page-size` of the grid.","name":"ZGData.oldPageSize"},{"type":"Number","description":"The current `page-size` of the grid.","name":"ZGData.pageSize"}],"dependency":"The `pager` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_pagesizechange","category":"Event"},{"name":"grid:ready","description":"Fires the grid ready event when grid is ready.","demoLink":"https://app.zingsoft.com/demos/create/ZDTAAQXR","returns":[],"dependency":"","tagName":"zing-grid","fullName":"zing-grid-event-grid_ready","category":"Event"},{"name":"grid:refresh","description":"Fires the event when the grid is refreshed through grid controls or API method `refresh()`.","demoLink":"https://app.zingsoft.com/demos/create/3JI8UNVU","returns":[],"dependency":"","tagName":"zing-grid","fullName":"zing-grid-event-grid_refresh","category":"Event"},{"name":"grid:render","description":"Fires the event once when grid renders.","demoLink":"https://app.zingsoft.com/demos/create/USHZFVZN","returns":[],"dependency":"","tagName":"zing-grid","fullName":"zing-grid-event-grid_render","category":"Event"},{"name":"grid:scroll","description":"Fires the event when scrolling occurs in grid.","demoLink":"https://app.zingsoft.com/demos/create/D19Y78UK","returns":[{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"Require the `height` attribute on the `zing-grid` tag to enable scrolling.","tagName":"zing-grid","fullName":"zing-grid-event-grid_scroll","category":"Event"},{"name":"grid:search","description":"Fires the event when a the grid is searched.","demoLink":"https://app.zingsoft.com/demos/create/C4FKT08Z","returns":[{"type":"String","description":"The current search term.","name":"ZGData.searchTerm"},{"type":"Array","description":"The Array of search results","name":"ZGData.searchResults"},{"type":"Number","description":"The length of the search results","name":"ZGData.searchCount"}],"dependency":"The `search` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_search","category":"Event"},{"name":"grid:select","description":"Fires the event when selection is made in the grid.","demoLink":"https://app.zingsoft.com/demos/create/XQRDEBJD","returns":[{"type":"Number","description":"The column where the selection ends.","name":"ZGData.columnEnd"},{"type":"Number","description":"The column where the selection starts.","name":"ZGData.columnStart"},{"type":"String | Array","description":"A string for a single cell and array for multiple cells being selected.","name":"ZGData.selectedData"},{"type":"String","description":"The row where the selection ends.","name":"ZGData.rowEnd"},{"type":"String","description":"The row where the selection starts.","name":"ZGData.rowStart"},{"type":"Object","description":"The single selected cell.  If multiple cells are selected, this will have the first one.  Use cells to access the rest.","name":"ZGData.DOMCell"},{"type":"Array","description":"An array of the selected cells.  If only one cell is selected, it is still in an array.","name":"ZGData.DOMCells"}],"dependency":"The `selector` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_select","category":"Event"},{"name":"grid:selectall","description":"Fires the event when selecting every cell (ctrl+a) in the grid.","demoLink":"https://app.zingsoft.com/demos/create/9YAZTONZ","returns":[],"dependency":"The `selector` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_selectall","category":"Event"},{"name":"grid:sort","description":"Fires the event when a the grid is sorted","demoLink":"https://app.zingsoft.com/demos/create/C4FKT08Z","returns":[{"type":"String","description":"The index of the sorted column","name":"ZGData.fieldIndex"},{"type":"Array","description":"Which direction the index is sorted","name":"ZGData.order"}],"dependency":"The `sort` attribute is required on the `zing-grid` tag.","tagName":"zing-grid","fullName":"zing-grid-event-grid_sort","category":"Event"}]},"ZGCell":{"events":[{"name":"cell:beforerender","description":"Fires the event before a cell is rendered.","demoLink":"https://app.zingsoft.com/demos/create/MC39A3I1","returns":[{"type":"Number","description":"The numerical index of the column.","name":"ZGData.columnIndex"},{"type":"Object","description":"The full data object for the cell.","name":"ZGData.data"},{"type":"Object","description":"The DOM cell.","name":"ZGData.DOMCell"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Number","description":"The numerical index of the row.","name":"ZGData.rowIndex"}],"dependency":"","tagName":"zg-cell","fullName":"zg-cell-event-cell_beforerender","category":"Event"},{"name":"cell:click","description":"Fires the event when a click occurs to a cell.","demoLink":"https://app.zingsoft.com/demos/create/N4Y1NSIY","returns":[{"type":"Object","description":"The relevant DOM cell.","name":"ZGData.DOMCell"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Number","description":"The column position index.","name":"ZGData.columnIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"String","description":"The current record index.","name":"ZGData.recordIndex"},{"type":"String","description":"The column type (default is text).","name":"ZGData.type"},{"type":"String","description":"The value of the cell.","name":"ZGData.value"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-cell","fullName":"zg-cell-event-cell_click","category":"Event"},{"name":"cell:closeedit","description":"Fires the event when the cell editor is closed.","demoLink":"https://app.zingsoft.com/demos/create/M5M9PT9O","returns":[{"type":"Boolean","description":"If the user canceled instead of saving the cell edit.","name":"ZGData.canceled"},{"type":"Number","description":"The numerical index of the column.","name":"ZGData.columnIndex"},{"type":"Object","description":"The full data object for the cell.","name":"ZGData.data"},{"type":"Object","description":"The DOM cell.","name":"ZGData.DOMCell"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"String","description":"The new value of the cell after editing.","name":"ZGData.newValue"},{"type":"Number","description":"The numerical index of the row.","name":"ZGData.rowIndex"}],"dependency":"The `editor` attribute is required on the `zing-grid` tag.","tagName":"zg-cell","fullName":"zg-cell-event-cell_closeedit","category":"Event"},{"name":"cell:copy","description":"Fires the event when copying (ctrl+c) occurs in a cell.","demoLink":"https://app.zingsoft.com/demos/create/OX0X5IFJ","returns":[{"type":"Object","description":"The data copied from the cell.","name":"ZGData.data"}],"dependency":"The `selector` attribute is required on the `zing-grid` tag.","tagName":"zg-cell","fullName":"zg-cell-event-cell_copy","category":"Event"},{"name":"cell:mouseout","description":"Fires the event when mouse is moved out of a cell.","demoLink":"https://app.zingsoft.com/demos/create/MMOPILFC","returns":[{"type":"Object","description":"The relevant DOM cell.","name":"ZGData.cell"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Number","description":"The column position index.","name":"ZGData.columnIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"String","description":"The current record index.","name":"ZGData.recordIndex"},{"type":"String","description":"The column type (default is text).","name":"ZGData.type"},{"type":"String","description":"The value of the cell.","name":"ZGData.value"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-cell","fullName":"zg-cell-event-cell_mouseout","category":"Event"},{"name":"cell:mouseover","description":"Fires the event when mouse is moved over a cell.","demoLink":"https://app.zingsoft.com/demos/create/HPXXGU88","returns":[{"type":"Object","description":"The relevant DOM cell.","name":"ZGData.cell"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Number","description":"The column position index.","name":"ZGData.columnIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"String","description":"The current record index.","name":"ZGData.recordIndex"},{"type":"String","description":"The column type (default is text).","name":"ZGData.type"},{"type":"String","description":"The value of the cell.","name":"ZGData.value"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-cell","fullName":"zg-cell-event-cell_mouseover","category":"Event"},{"name":"cell:openedit","description":"Fires the event when the cell editor is opened.","demoLink":"https://app.zingsoft.com/demos/create/XTZM2IN7","returns":[{"type":"Number","description":"The numerical index of the column.","name":"ZGData.columnIndex"},{"type":"Object","description":"The full data object for the cell.","name":"ZGData.data"},{"type":"Object","description":"The DOM cell.","name":"ZGData.DOMCell"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Number","description":"The numerical index of the row.","name":"ZGData.rowIndex"}],"dependency":"The `editor` attribute is required on the `zing-grid` tag.","tagName":"zg-cell","fullName":"zg-cell-event-cell_openedit","category":"Event"},{"name":"cell:paste","description":"Fires the event when pasting (ctrl+p) occurs in a cell.","demoLink":"https://app.zingsoft.com/demos/create/MOQBDKCP","returns":[{"type":"Object","description":"The data you paste","name":"ZGData.data"}],"dependency":"The `editor` attribute is required on the `zing-grid` tag.","tagName":"zg-cell","fullName":"zg-cell-event-cell_paste","category":"Event"},{"name":"cell:rightclick","description":"Fires the event when right click occurs on a cell.","demoLink":"https://app.zingsoft.com/demos/create/PZHZSFGS","returns":[{"type":"Object","description":"The relevant DOM cell.","name":"ZGData.cell"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Number","description":"The column position index.","name":"ZGData.columnIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"String","description":"The current record index.","name":"ZGData.recordIndex"},{"type":"String","description":"The column type (default is text).","name":"ZGData.type"},{"type":"String","description":"The value of the cell.","name":"ZGData.value"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-cell","fullName":"zg-cell-event-cell_rightclick","category":"Event"}]},"ZGData":{"events":[{"name":"data:cell:beforechange","description":"Fires the event before a single cell value is changed.","demoLink":"https://app.zingsoft.com/demos/create/AXA7XIC2","returns":[{"type":"Object","description":"The DOM cell that was updated.","name":"DOMCell"},{"type":"Object","description":"The data object associated with that record.","name":"data"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"fieldIndex"},{"type":"String","description":"The new value of the cell.","name":"newValue"},{"type":"String","description":"The old value of the cell.","name":"oldValue"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"recordIndex"},{"type":"Number","description":"The index of the row.","name":"rowIndex"}],"dependency":"The `editor` or `editor-controls` attribute(s) are required on the `zing-grid` tag.","tagName":"zg-data","fullName":"zg-data-event-data_cell_beforechange","category":"Event"},{"name":"data:cell:change","description":"Fires the event after a single cell value is changed.","demoLink":"https://app.zingsoft.com/demos/create/XRY6DHYJ","returns":[{"type":"Object","description":"The DOM cell that was updated.","name":"DOMCell"},{"type":"Object","description":"The data object associated with that record.","name":"data"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"fieldIndex"},{"type":"String","description":"The new value of the cell.","name":"newValue"},{"type":"String","description":"The old value of the cell.","name":"oldValue"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"recordIndex"},{"type":"Number","description":"The index of the row.","name":"rowIndex"}],"dependency":"The `editor` or `editor-controls` attribute(s) are required on the `zing-grid` tag.","tagName":"zg-data","fullName":"zg-data-event-data_cell_change","category":"Event"},{"name":"data:load","description":"Fires the event every time a new dataset is loaded in the grid.","demoLink":"https://app.zingsoft.com/demos/create/EAHH0K0C","returns":[],"dependency":"","tagName":"zg-data","fullName":"zg-data-event-data_load","category":"Event"},{"name":"data:record:beforechange","description":"Fires the event before a record (row) is changed.","demoLink":"https://app.zingsoft.com/demos/create/X9G7WCT6","returns":[{"type":"Array","description":"The column indices that were changed e.g. [\"firstName\",\"lastName\"].","name":"changedField"},{"type":"Object","description":"The data object associated with that record.","name":"data"},{"type":"Object","description":"The old data object associated with that record.","name":"oldData"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"recordIndex"},{"type":"Number","description":"The index of the row.","name":"rowIndex"}],"dependency":"The `editor` or `editor-controls` attribute(s) are required on the `zing-grid` tag.","tagName":"zg-data","fullName":"zg-data-event-data_record_beforechange","category":"Event"},{"name":"data:record:beforedelete","description":"Fires the event before a record (row) is deleted from the grid.","demoLink":"https://app.zingsoft.com/demos/create/5LPMYI4F","returns":[{"type":"Object","description":"The data object associated with that record.","name":"data"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"recordIndex"},{"type":"Number","description":"The index of the row.","name":"rowIndex"}],"dependency":"The `editor` or `editor-controls` attribute(s) are required on the `zing-grid` tag.","tagName":"zg-data","fullName":"zg-data-event-data_record_beforedelete","category":"Event"},{"name":"data:record:beforeinsert","description":"Fires the event before a new record (row) is added to the grid.","demoLink":"https://app.zingsoft.com/demos/create/95KH1Z2U","returns":[{"type":"Object","description":"The data object associated with that record.","name":"data"},{"type":"Number","description":"The index of the row.","name":"rowIndex"}],"dependency":"The `editor` or `editor-controls` attribute(s) are required on the `zing-grid` tag.","tagName":"zg-data","fullName":"zg-data-event-data_record_beforeinsert","category":"Event"},{"name":"data:record:change","description":"Fires the event after a record (row) is changed.","demoLink":"https://app.zingsoft.com/demos/create/TPM8ZZH7","returns":[{"type":"Array","description":"The column indices that were changed e.g. [\"firstName\",\"lastName\"].","name":"changedField"},{"type":"Object","description":"The data object associated with that record.","name":"data"},{"type":"Object","description":"The old data object associated with that record.","name":"oldData"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"recordIndex"},{"type":"Number","description":"The index of the row.","name":"rowIndex"}],"dependency":"The `editor` or `editor-controls` attribute(s) are required on the `zing-grid` tag.","tagName":"zg-data","fullName":"zg-data-event-data_record_change","category":"Event"},{"name":"data:record:delete","description":"Fires the event when a record (row) is deleted from the grid.","demoLink":"https://app.zingsoft.com/demos/create/NXAB4Z1Q","returns":[{"type":"Object","description":"The data object associated with that record.","name":"data"}],"dependency":"The `editor` or `editor-controls` attribute(s) are required on the `zing-grid` tag.","tagName":"zg-data","fullName":"zg-data-event-data_record_delete","category":"Event"},{"name":"data:record:insert","description":"Fires the event after a new record (row) is added to the grid.","demoLink":"https://app.zingsoft.com/demos/create/033EHETB","returns":[{"type":"Object","description":"The data object associated with that record.","name":"data"},{"type":"Number","description":"The index of the row.","name":"rowIndex"}],"dependency":"The `editor` or `editor-controls` attribute(s) are required on the `zing-grid` tag.","tagName":"zg-data","fullName":"zg-data-event-data_record_insert","category":"Event"},{"name":"data:record:openinsert","description":"Fires event when the insert dialog is opened","demoLink":"https://app.zingsoft.com/demos/create/N0650LRP","returns":[{"type":"String","description":"The container for all of the input fields on the new dialog","name":"ZGData.inputContainer"},{"type":"Object","description":"An array of references to each label and edit field inside the new dialog","name":"ZGData.editorFields"},{"type":"Object","description":"A reference to the DOM dialog.","name":"ZGTarget"}],"dependency":"","tagName":"zg-data","fullName":"zg-data-event-data_record_openinsert","category":"Event"}]},"ZGRow":{"events":[{"name":"row:click","description":"Fires the `row:click` and `record:click` event when a click occurs on a record (row).","demoLink":"https://app.zingsoft.com/demos/create/6VM972JP","returns":[{"type":"Object","description":"The cell event details.","name":"ZGData.cell"},{"type":"Object","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-row","fullName":"zg-row-event-row_click","category":"Event"},{"name":"row:frozen","description":"Fires when the frozen row state changes","demoLink":"","returns":[{"type":"Object","description":"An array of rows frozen in the modified area (top/bottom)","name":"ZGData.frozenRows"},{"type":"String","description":"The area the frozen state was changed (top or bottom)","name":"ZGData.area"},{"type":"Number","description":"The count of rows frozen in the  modified area.","name":"ZGData.currentFrozenRows"}],"dependency":"","tagName":"zg-row","fullName":"zg-row-event-row_frozen","category":"Event"},{"name":"row:mouseout","description":"Fires the event when mouse is moved out a record (row).","demoLink":"https://app.zingsoft.com/demos/create/FDY5N5W2","returns":[{"type":"Object","description":"The cell event details.","name":"ZGData.cell"},{"type":"Object","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-row","fullName":"zg-row-event-row_mouseout","category":"Event"},{"name":"row:mouseover","description":"Fires the event when mouse is moved over a record (row).","demoLink":"https://app.zingsoft.com/demos/create/OOMRFHVT","returns":[{"type":"Object","description":"The cell event details.","name":"ZGData.cell"},{"type":"Object","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-row","fullName":"zg-row-event-row_mouseover","category":"Event"},{"name":"row:select","description":"Fires when the row selector changes","demoLink":"https://app.zingsoft.com/demos/create/GUHGHX28","returns":[{"type":"String","description":"An array of currently selected rows","name":"ZGData.selectedRows"},{"type":"Object","description":"The full data object for the row selected/unselected.","name":"ZGData.data"},{"type":"String","description":"The unique identifier for the row selected/unselected, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index of the selected/unselected row.","name":"ZGData.rowIndex"},{"type":"Boolean","description":"Boolean indicating if the current row was checked or unchecked","name":"ZGData.checked"}],"dependency":"A `selector` column must exist","tagName":"zg-row","fullName":"zg-row-event-row_select","category":"Event"}]},"ZGColumn":{"events":[{"name":"column:click","description":"Fires event when click on a column.","demoLink":"https://app.zingsoft.com/demos/create/G1LTDI56","returns":[{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-column","fullName":"zg-column-event-column_click","category":"Event"},{"name":"column:filter","description":"Fires the event when a column is filtered.","demoLink":"https://app.zingsoft.com/demos/create/8FMB5J78","returns":[{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"String","description":"The index that the filter is applied to e.g. \"firstName\".","name":"ZGData.filterIndex"},{"type":"String","description":"The current filter value.","name":"ZGData.filterValue"}],"dependency":"The `filter` attribute is required on the `zing-grid` tag.","tagName":"zg-column","fullName":"zg-column-event-column_filter","category":"Event"},{"name":"column:mouseout","description":"Fires event when mouseout on a column.","demoLink":"https://app.zingsoft.com/demos/create/YUGN3NN0","returns":[{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-column","fullName":"zg-column-event-column_mouseout","category":"Event"},{"name":"column:mouseover","description":"Fires event when mouseover on a column.","demoLink":"https://app.zingsoft.com/demos/create/ZLKD91AZ","returns":[{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-column","fullName":"zg-column-event-column_mouseover","category":"Event"}]},"ZGCard":{"events":[{"name":"card:click","description":"Fires the `card:click` and `record:click` event when a click occurs on a record (card).","demoLink":"https://app.zingsoft.com/demos/create/3I2P58D2","returns":[{"type":"Object","description":"The cell event details.","name":"ZGData.cell"},{"type":"Object","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-card","fullName":"zg-card-event-card_click","category":"Event"},{"name":"card:mouseout","description":"Fires the event when mouse is moved out a record (card).","demoLink":"https://app.zingsoft.com/demos/create/FDY5N5W2","returns":[{"type":"Object","description":"The cell event details.","name":"ZGData.cell"},{"type":"Object","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-card","fullName":"zg-card-event-card_mouseout","category":"Event"},{"name":"card:mouseover","description":"Fires the event when mouse is moved over a record (card).","demoLink":"https://app.zingsoft.com/demos/create/OOMRFHVT","returns":[{"type":"Object","description":"The cell event details.","name":"ZGData.cell"},{"type":"Object","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-card","fullName":"zg-card-event-card_mouseover","category":"Event"}]},"ZGRecord":{"events":[{"name":"record:click","description":"Fires the `row:click` and `record:click` event when a click occurs on a record (row).","demoLink":"https://app.zingsoft.com/demos/create/YAZ15POU","returns":[{"type":"Object","description":"The cell click details.","name":"ZGData.cell"},{"type":"Object","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The current layout of the grid, card or row.","name":"ZGData.layout"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-record","fullName":"zg-record-event-record_click","category":"Event"},{"name":"record:mouseout","description":"Fires when the mouse cursor leaves the record (row).","demoLink":"https://app.zingsoft.com/demos/create/4O4TXH1M","returns":[{"type":"Object","description":"The cell click details.","name":"ZGData.cell"},{"type":"String","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The current layout of the grid, card or row.","name":"ZGData.layout"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-record","fullName":"zg-record-event-record_mouseout","category":"Event"},{"name":"record:mouseover","description":"Fires when the mouse cursor enter the record (row).","demoLink":"https://app.zingsoft.com/demos/create/CM6R6738","returns":[{"type":"Object","description":"The cell click details.","name":"ZGData.cell"},{"type":"String","description":"The full data object for the row.","name":"ZGData.data"},{"type":"String","description":"The current layout of the grid, card or row.","name":"ZGData.layout"},{"type":"String","description":"The unique identifier for the row, this identifier never changes.","name":"ZGData.recordIndex"},{"type":"Number","description":"The current row index.","name":"ZGData.rowIndex"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-record","fullName":"zg-record-event-record_mouseover","category":"Event"}]},"ZGHeader":{"events":[{"name":"header:click","description":"Fires event when click on a header cell.","demoLink":"https://app.zingsoft.com/demos/create/ENV6PPDP","returns":[{"type":"String","description":"The current cell index.","name":"ZGData.cellIndex"},{"type":"String","description":"The column index e.g. \"firstName\".","name":"ZGData.fieldIndex"},{"type":"String","description":"The value of the cell.","name":"ZGData.text"},{"type":"Object","description":"A reference to the custom ZingGrid internal event.","name":"ZGEvent"},{"type":"Object","description":"A reference to the DOM element.","name":"ZGTarget"}],"dependency":"","tagName":"zg-header","fullName":"zg-header-event-header_click","category":"Event"}]},"ZGButton":{"events":[]},"ZGBody":{"events":[]},"ZGCaption":{"events":[]},"ZGCheckbox":{"events":[]},"ZGColgroup":{"events":[]},"ZGColumnResize":{"events":[]},"ZGControlBar":{"events":[]},"ZGDialog":{"events":[]},"ZGEditorRow":{"events":[]},"ZGFilter":{"events":[]},"ZGFocus":{"events":[]},"ZGFoot":{"events":[]},"ZGFooter":{"events":[]},"ZGFrozenColgroup":{"events":[]},"ZGHead":{"events":[]},"ZGHeadCell":{"events":[]},"ZGIcon":{"events":[]},"ZGInput":{"events":[]},"ZGLayoutControls":{"events":[]},"ZGLoadMask":{"events":[]},"ZGMenu":{"events":[]},"ZGMenuGroup":{"events":[]},"ZGNoData":{"events":[]},"ZGOptionList":{"events":[]},"ZGPager":{"events":[]},"ZGParam":{"events":[]},"ZGSearch":{"events":[]},"ZGSelect":{"events":[]},"ZGSelectorMask":{"events":[]},"ZGSeparator":{"events":[]},"ZGSource":{"events":[]},"ZGStatus":{"events":[]},"ZGText":{"events":[]},"ZGTooltip":{"events":[]},"ZGWatermark":{"events":[]}}