zinggrid
Version:
ZingGrid - A fully-featured, native, web-component, data table and grid for Javascript applications.
1 lines • 9.93 kB
JSON
[{"name":"getData","description":"Fetches the internal property referencing the dataset for the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/WXJM54FT","acceptedValues":[],"displayValues":["{ csv: true, headers: true, col: \"all or visible\", rows: \"all or visible\" }"],"params":[{"type":"Object","description":"Optional, options for the data retrieval. Options are:\n<ul>\n<li>csv: Boolean indicating if it should be sent as a csv string. Default is false.</li>\n<li>headers: Boolean indicating if headers should be included. Default is false.\n Only applies to csv or JSON array of arrays as JSON objects have a key already.</li>\n<li>cols: String indicating if we should return all columns or only visible. 'all' or 'visible' are options.\n<li>rows: String indicating if we should return all rows or only filtered/searched. 'all' or 'visible' are options.\n</ul>","name":"config"}],"returns":[{"type":"Array | Object","description":"The dataset."}],"tagName":"zing-grid","fullName":"zing-grid-method-getData","category":"Method"},{"name":"getSrc","description":"Gets the value of the `src` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/65BH3JJH","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of attribute"}],"tagName":"zing-grid","fullName":"zing-grid-method-getSrc","category":"Method"},{"name":"getTemplateEndDelimiter","description":"Gets the value of the `template-end-delimiter` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/356O5CQH","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute"}],"tagName":"zing-grid","fullName":"zing-grid-method-getTemplateEndDelimiter","category":"Method"},{"name":"getTemplateStartDelimiter","description":"Gets the value of the `template-start-delimiter` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/U52PHUWE","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute"}],"tagName":"zing-grid","fullName":"zing-grid-method-getTemplateStartDelimiter","category":"Method"},{"name":"insertRow","description":"Inserts a new row into the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/7C8K3S0R","acceptedValues":[],"displayValues":[],"params":[{"type":"Object","description":"Data to insert into new row","name":"data"},{"type":"String","description":"If the id is already set on the new record, pass it in here","name":"id"},{"type":"Boolean","description":"If you only want to do a local insert, set `noDataSource` to \"true\"","name":"noDataSource"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-insertRow","category":"Method"},{"name":"refresh","description":"Refreshes all cells. Note: if using static data, original cell value will be restored.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/C0VU05L5","acceptedValues":[],"displayValues":["N/A"],"params":[],"returns":[{"type":"Undefined","description":"N/A"}],"tagName":"zing-grid","fullName":"zing-grid-method-refresh","category":"Method"},{"name":"refreshGrid","description":"Refreshes entire grid. Useful for language change.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/ONXSD3GH","acceptedValues":[],"displayValues":["N/A"],"params":[],"returns":[{"type":"Undefined","description":"N/A"}],"tagName":"zing-grid","fullName":"zing-grid-method-refreshGrid","category":"Method"},{"name":"removeRecord","description":"Removes a record from the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/E5WDZ3GC","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"ID of the record to remove","name":"id"},{"type":"Boolean","description":"If you only want to remove from the grid and not the external datasource, set `noDataSource` to \"true\"","name":"noDataSource"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-removeRecord","category":"Method"},{"name":"removeRow","description":"Removes a row from the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/2W8QFOZT","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"Row index (0 based) of the record to remove","name":"rowIndex"},{"type":"Boolean","description":"If you only want to remove from the grid and not the external datasource, set `noDataSource` to \"true\"","name":"noDataSource"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-removeRow","category":"Method"},{"name":"setData","description":"Sets or updates the dataset for the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/16TN8AXU","acceptedValues":[],"displayValues":["[1, 2, 3]","[{firstName:\"John\", lastName:\"Doe\"}]"],"params":[{"type":"Array | Object","description":"JSON data","name":"data"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setData","category":"Method"},{"name":"setSrc","description":"Sets the `src` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/LCIB7MYU","acceptedValues":[],"displayValues":["https://cdn.zinggrid.com/datasets/users.json"],"params":[{"type":"String","description":"Value to indicate a path to a remote data source","name":"src"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setSrc","category":"Method"},{"name":"setTemplateEndDelimiter","description":"Sets the `template-end-delimiter` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/FO1OZLPN","acceptedValues":[],"displayValues":["\"}}\""],"params":[{"type":"String","description":"Value to indicate regex expression for closing data binding","name":"delim"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setTemplateEndDelimiter","category":"Method"},{"name":"setTemplateStartDelimiter","description":"Sets the `template-start-delimiter` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/DR9KPT73","acceptedValues":[],"displayValues":["\"{{\""],"params":[{"type":"String","description":"Value to indicate regex expression for opening data binding","name":"delim"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setTemplateStartDelimiter","category":"Method"},{"name":"updateCellByID","description":"Updates a cell in the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/YQX4FZMK","acceptedValues":[],"displayValues":[],"params":[{"type":"Number","description":"ID of the record to update","name":"id"},{"type":"Number","description":"Field index of the cell to update","name":"fieldIndex"},{"type":"*","description":"New Value","name":"val"},{"type":"Boolean","description":"If you only want to update the grid and not the external datasource, set `noDataSource` to \"true\"","name":"noDataSource"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-updateCellByID","category":"Method"},{"name":"updateCellByPosition","description":"Updates a cell in the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/3KMH7QTT","acceptedValues":[],"displayValues":[],"params":[{"type":"Number","description":"Row index (0 based) of the cell to update","name":"rowIndex"},{"type":"Number","description":"Column index (0 based) of the cell to update","name":"columnIndex"},{"type":"*","description":"New Value","name":"val"},{"type":"Boolean","description":"If you only want to update the grid and not the external datasource, set `noDataSource` to \"true\"","name":"noDataSource"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-updateCellByPosition","category":"Method"},{"name":"updateRecord","description":"Updates a record in the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/FTIETDHO","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"ID of the record to update","name":"id"},{"type":"Object","description":"Data to update","name":"data"},{"type":"Boolean","description":"If you only want to update the grid and not the external datasource, set `noDataSource` to \"true\"","name":"noDataSource"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-updateRecord","category":"Method"},{"name":"updateRow","description":"Updates a row in the grid","type":null,"demoLink":"https://app.zingsoft.com/demos/create/9L8CMADP","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"Row index (0 based) of the record to update","name":"rowIndex"},{"type":"Object","description":"Data to update","name":"data"},{"type":"Boolean","description":"If you only want to update the grid and not the external datasource, set `noDataSource` to \"true\"","name":"noDataSource"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-updateRow","category":"Method"}]