[{"name":"calculate","description":"Calculates aggregate values","type":null,"demoLink":"https://app.zingsoft.com/demos/create/6OT26JVM","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"The method to calculate.  Options are 'sum', 'avg', 'min', 'max', and 'count'","name":"method","optional":false},{"type":"Object","description":"The options to be used in calculating the value.  Currently fieldIndex is only option.","name":"options","optional":false},{"type":"Array","description":"The data to calculate the value on.  If this is not set, it uses the grids full dataset","name":"data","optional":false}],"returns":[{"type":"String","description":"The calculated value or empty string if the parameters don't make sense","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-calculate","category":"Method","version":"1.x.x"},{"name":"clearState","description":"Clears the grid state","type":null,"demoLink":"https://app.zingsoft.com/demos/create/PU60HJHR","acceptedValues":[],"displayValues":[],"params":[],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-clearState","category":"Method","version":"1.x.x"},{"name":"executeOnLoad","description":"Executes callback function when grid completes load. If grid is already loaded, it will execute immediately.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/HRRCVJZ3","acceptedValues":[],"displayValues":["function() { //do something }"],"params":[{"type":"function","description":"Callback function to execute","name":"callback","optional":false}],"returns":[{"type":"Undefined","description":"N/A","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-executeOnLoad","category":"Method","version":"1.x.x"},{"name":"formatDate","description":"Formats a Date","type":null,"demoLink":"https://app.zingsoft.com/demos/create/P6PWYZLI","acceptedValues":[],"displayValues":[],"params":[{"type":"String | Date","description":"The Date to format","name":"date","optional":false},{"type":"String","description":"The tokenized format to format the date","name":"format","optional":false}],"returns":[{"type":"String","description":"The formatted date","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-formatDate","category":"Method","version":"1.x.x"},{"name":"fromNow","description":"Formats a Date in from now format","type":null,"demoLink":"https://app.zingsoft.com/demos/create/NWYBOBCD","acceptedValues":[],"displayValues":[],"params":[{"type":"Date","description":"The Date to format","name":"date","optional":false},{"type":"Boolean","description":"Indicates if we should include 'ago/to' to indicate past/future","name":"raw","optional":false}],"returns":[{"type":"String","description":"The formatted date","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-fromNow","category":"Method","version":"1.x.x"},{"name":"getAggregate","description":"Get the value of the `aggregate` attribute.  Does not return any user defined aggregate columns.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/8TYG2EX8","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the aggregate attribute.","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getAggregate","category":"Method","version":"1.x.x"},{"name":"getBatchEdit","description":"Gets the value of the `batch-edit` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/C8N9TQV5","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"Boolean","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getBatchEdit","category":"Method","version":"1.x.x"},{"name":"getBatchEditStatus","description":"Gets the value of the `batch-edit-status` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/QTI7LSC6","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getBatchEditStatus","category":"Method","version":"1.x.x"},{"name":"getColumnDrag","description":"Gets the value of the `column-drag` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/U12DZX8D","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"Boolean","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getColumnDrag","category":"Method","version":"1.x.x"},{"name":"getColumnDragAction","description":"Gets the value of the `column-drag-action` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/ZKH9KE8Y","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getColumnDragAction","category":"Method","version":"1.x.x"},{"name":"getCompact","description":"Gets the value of the `compact` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/9CMDZX4R","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String | Boolean","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getCompact","category":"Method","version":"1.x.x"},{"name":"getConstants","description":"Exposes the Constants object for the user to customize","type":null,"demoLink":"https://app.zingsoft.com/demos/create/KE815753","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"Object","description":"Object containing constant variables","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getConstants","category":"Method","version":"2.x.x"},{"name":"getDir","description":"Gets the dir setting for the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/L8DLUQT4","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of dir","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getDir","category":"Method","version":"1.x.x"},{"name":"getGridlines","description":"Gets the value of the `gridlines` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/32PP7TE5","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getGridlines","category":"Method","version":"1.x.x"},{"name":"getGroupBy","description":"Gets the indexes of the current row groupings.  Returns false if none","type":null,"demoLink":"https://app.zingsoft.com/demos/create/7HCE5QSA","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String | Boolean","description":"Index value of the row-group or false if none.","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getGroupBy","category":"Method","version":"1.x.x"},{"name":"getHeight","description":"Gets the value of the `height` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/DZLMNJLX","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getHeight","category":"Method","version":"1.x.x"},{"name":"getLang","description":"Gets the language used on the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/JBGU6KAC","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getLang","category":"Method","version":"1.x.x"},{"name":"getPreserveStateId","description":"Gets the value of the `preserve-state-id` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/3SGEGQKA","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"ZingGrid","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getPreserveStateId","category":"Method","version":"1.x.x"},{"name":"getPreserveStateLoad","description":"Gets the value of the `preserve-state-load` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/PIEI0982","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"ZingGrid","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getPreserveStateLoad","category":"Method","version":"1.x.x"},{"name":"getPreserveStateOptions","description":"Gets the value of the `preserve-state-options` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/43JHGSEO","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"ZingGrid","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getPreserveStateOptions","category":"Method","version":"1.x.x"},{"name":"getPreserveStateSave","description":"Gets the value of the `preserve-state-save` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/JKHQMVD1","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"ZingGrid","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getPreserveStateSave","category":"Method","version":"1.x.x"},{"name":"getRowHeight","description":"Gets the value of the `row-height` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/VQIKSPFX","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getRowHeight","category":"Method","version":"2.x.x"},{"name":"getRowHeightScope","description":"Gets the value of the `row-height-scope` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/TWLO5FV0","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getRowHeightScope","category":"Method","version":"2.x.x"},{"name":"getWidth","description":"Gets the value of the `width` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/JOUAEGFJ","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-getWidth","category":"Method","version":"1.x.x"},{"name":"setAggregate","description":"Sets the `aggregate` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/XF5TFIZU","acceptedValues":[],"displayValues":["\"sum\"","\"avg\"","\"max\"","\"min\"","\"count\"","\"tokenized string\""],"params":[{"type":"String","description":"Value to set aggregate to","name":"aggregate","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setAggregate","category":"Method","version":"1.x.x"},{"name":"setBatchEdit","description":"Sets the value of the `batch-edit` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/FBI18VKS","acceptedValues":[],"displayValues":[],"params":[{"type":"Boolean","description":"Value of batch-edit","name":"batchEdit","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setBatchEdit","category":"Method","version":"1.x.x"},{"name":"setBatchEditStatus","description":"Sets the value of the `batch-edit-status` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/RNYT7098","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"Value of the batch-edit-status","name":"batchEditStatus","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setBatchEditStatus","category":"Method","version":"1.x.x"},{"name":"setBuildCode","description":"Sets the build code and removes watermarks if it is valid.\nIf the build code is not set on page load, it is possible to set it through this API Method.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/MLAIIDW1","acceptedValues":[],"displayValues":["['BUILD_CODE']"],"params":[{"type":"Array","description":"The buildcode array","name":"buildcode","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setBuildCode","category":"Method","version":"1.x.x"},{"name":"setColumnDrag","description":"Sets the `column-drag` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/5CYF83KZ","acceptedValues":[],"displayValues":["true","false"],"params":[{"type":"Boolean","description":"Boolean value to indicate add or remove","name":"activate","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setColumnDrag","category":"Method","version":"1.x.x"},{"name":"setColumnDragAction","description":"Sets the `column-drag-action` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/FYHHMX6T","acceptedValues":[],"displayValues":["\"reorder\"","\"remove\"","\"both\""],"params":[{"type":"Enum","description":"Type of drag to enable","name":"type","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setColumnDragAction","category":"Method","version":"1.x.x"},{"name":"setCompact","description":"Sets the `compact` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/TUD3RQAU","acceptedValues":[],"displayValues":["true","false"],"params":[{"type":"Boolean","description":"Value to add or remove","name":"activate","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setCompact","category":"Method","version":"1.x.x"},{"name":"setDir","description":"Sets the `dir` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/Q1OU5SXW","acceptedValues":[],"displayValues":["\"ltr\"","\"rtl\""],"params":[{"type":"Enum","description":"Type of dir","name":"type","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setDir","category":"Method","version":"1.x.x"},{"name":"setGridlines","description":"Sets the `gridlines` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/971PFN13","acceptedValues":[],"displayValues":["\"both\"","\"horz\"","\"horizontal\"","\"vert\"","\"vertical\""],"params":[{"type":"Enum","description":"Type of gridlines to set on the grid","name":"type","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setGridlines","category":"Method","version":"1.x.x"},{"name":"setGroupBy","description":"Sets the `group-by` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/0IOJI4MG","acceptedValues":[],"displayValues":["country"],"params":[{"type":"String","description":"Index to set the group-by","name":"index","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setGroupBy","category":"Method","version":"1.x.x"},{"name":"setHeight","description":"Sets the `height` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/3T3FD7SB","acceptedValues":[],"displayValues":["500"],"params":[{"type":"Number","description":"Value setting the height of the grid","name":"height","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setHeight","category":"Method","version":"1.x.x"},{"name":"setLang","description":"Sets the `lang` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/TJMEFAMW","acceptedValues":[],"displayValues":["\"en\""],"params":[{"type":"String","description":"Language to set on the grid","name":"lang","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setLang","category":"Method","version":"1.x.x"},{"name":"setLicense","description":"Sets the license and removes watermarks if it is valid.\nIf the license is not set on page load, it is possible to set it through this API Method","type":null,"demoLink":"https://app.zingsoft.com/demos/create/5BQIG9HU","acceptedValues":[],"displayValues":["['LICENSE_KEY']"],"params":[{"type":"Array","description":"The license array","name":"license","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setLicense","category":"Method","version":"1.x.x"},{"name":"setPreserveStateId","description":"Sets the `preserve-state-id` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/COGTCBEO","acceptedValues":[],"displayValues":["'myzinggridstate'"],"params":[{"type":"String","description":"Value setting the id","name":"id","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setPreserveStateId","category":"Method","version":"1.x.x"},{"name":"setPreserveStateLoad","description":"Sets the `preserve-state-load` attribute as a reference of the user defined method to call on state load","type":null,"demoLink":"https://app.zingsoft.com/demos/create/13J3XLOW","acceptedValues":[],"displayValues":["'loadState'"],"params":[{"type":"String","description":"Value setting the function","name":"functionName","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setPreserveStateLoad","category":"Method","version":"1.x.x"},{"name":"setPreserveStateOptions","description":"Sets the `preserve-state-options` attribute as a comma separated string of the options","type":null,"demoLink":"https://app.zingsoft.com/demos/create/CSUSRNEW","acceptedValues":[],"displayValues":["'search, filter'"],"params":[{"type":"String","description":"Value setting the options","name":"options","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setPreserveStateOptions","category":"Method","version":"1.x.x"},{"name":"setPreserveStateSave","description":"Sets the `preserve-state-save` attribute as a reference of the user defined method to call on state save","type":null,"demoLink":"https://app.zingsoft.com/demos/create/LBTKBD8V","acceptedValues":[],"displayValues":["'saveState'"],"params":[{"type":"String","description":"Value setting the function","name":"functionName","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setPreserveStateSave","category":"Method","version":"1.x.x"},{"name":"setRecordCount","description":"Sets the `record-count` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/FAE61XH1","acceptedValues":[],"displayValues":["100"],"params":[{"type":"Number","description":"Value setting the count","name":"count","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setRecordCount","category":"Method","version":"1.x.x"},{"name":"setRowHeight","description":"Sets the `row-height` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/SZYIBHUH","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"CSS height to set for the row height","name":"height","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setRowHeight","category":"Method","version":"2.x.x"},{"name":"setRowHeightScope","description":"Sets the `row-height-scope` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/Z8J9DIBK","acceptedValues":[],"displayValues":[],"params":[{"type":"Enum","description":"Set to 'data', 'headers', or 'all'","name":"scope","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setRowHeightScope","category":"Method","version":"2.x.x"},{"name":"setState","description":"Sets the grid state with the options passed in","type":null,"demoLink":"https://app.zingsoft.com/demos/create/K4USHNTW","acceptedValues":[],"displayValues":["'{\"search\": \"Tom\", \"page\": 2}'"],"params":[{"type":"String","description":"JSON string or object setting the state","name":"state","optional":false}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-setState","category":"Method","version":"1.x.x"},{"name":"setStateField","description":"Sets the grid state for the given field","type":null,"demoLink":"https://app.zingsoft.com/demos/create/8JT6OM4D","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"Name of the state to set","name":"stateName","optional":false},{"type":"String","description":"String, JSON string or object setting the state","name":"state","optional":false}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-setStateField","category":"Method","version":"1.x.x"},{"name":"setWidth","description":"Sets the `width` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/O680JNWT","acceptedValues":[],"displayValues":["500"],"params":[{"type":"Number","description":"Value setting the width of the grid","name":"width","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-setWidth","category":"Method","version":"1.x.x"},{"name":"updateSize","description":"Forces a resize event to be triggered and to partially repaint the grid. Useful when the container updates size without the window updating.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/O9ZBIM3X","acceptedValues":[],"displayValues":[],"params":[{"type":"Boolean","description":"Display the loading screen while updating the grid.  False by default","name":"showLoading","optional":false},{"type":"Number","description":"The time to delay the action.  This should be > the time it takes to do the CSS transition.  Value in seconds","name":"delay","optional":false}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together","optional":false}],"tagName":"zing-grid","fullName":"zing-grid-method-updateSize","category":"Method","version":"1.x.x"}]