zinggrid/docs_output/methods/zing-grid-api-methods.json

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

[{"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"},{"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"}],"returns":[{"type":"Undefined","description":"N/A"}],"tagName":"zing-grid","fullName":"zing-grid-method-executeOnLoad","category":"Method"},{"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"},{"type":"String","description":"The tokenized format to format the date","name":"format"}],"returns":[{"type":"String","description":"The formatted date"}],"tagName":"zing-grid","fullName":"zing-grid-method-formatDate","category":"Method"},{"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"},{"type":"Boolean","description":"Indicates if we should include 'ago/to' to indicate past/future","name":"raw"}],"returns":[{"type":"String","description":"The formatted date"}],"tagName":"zing-grid","fullName":"zing-grid-method-fromNow","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getColumnDragAction","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getCompact","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getDir","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getGridlines","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getHeight","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getLang","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getPreserveStateId","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getPreserveStateLoad","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getPreserveStateOptions","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getPreserveStateSave","category":"Method"},{"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"}],"tagName":"zing-grid","fullName":"zing-grid-method-getWidth","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setColumnDrag","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setColumnDragAction","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setCompact","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setDir","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setGridlines","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setHeight","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setLang","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setPreserveStateId","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setPreserveStateLoad","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setPreserveStateOptions","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setPreserveStateSave","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setRecordCount","category":"Method"},{"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"}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-setState","category":"Method"},{"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"},{"type":"String","description":"String, JSON string or object setting the state","name":"state"}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-setStateField","category":"Method"},{"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"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setWidth","category":"Method"},{"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":[],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-updateSize","category":"Method"}]