zinggrid
Version:
ZingGrid - A fully-featured, native, web-component, data table and grid for Javascript applications.
1 lines • 48.6 kB
JSON
[{"name":"name","description":"Name of parameter","type":"String","fullName":"zg-param-name","demoLink":"https://app.zingsoft.com/demos/create/R2K22X2Q","default":"\"\"","acceptedValues":["adapter","idKey","newIndexPath","recordPath","nodePath","searchKey","search","serverFilter","sortByKey","sortBy","sortDirKey","sortDir","startAtKey","startAtValue","limitToKey","limitTo","pageKey","countPath","cursor","loadByPage","loadByScroll","hasNextPath","nextPath","nextIDPath","nextIDKey","hasPrevPath","prevPath","prevIDPath","prevIDKey","pageBase","csvCaption","csvDelimiter","csvHeader","csvLineSeparator","tableHide","tableHead","tableDataFormat","tableHeadFormat","collection","subscription","createOptions","readOptions","updateRowOptions","updateCellOptions","updateOptions","deleteOptions","src","createSrc","readSrc","updateRowSrc","updateCellSrc","deleteSrc","restmode","method","createMethod","readMethod","updateRowMethod","updateCellMethod","deleteMethod","headers","queryString","body","bodyMethodSuffix","createBody","readBody","updateRowBody","updateCellBody","deleteBody","createCustomFunction","readCustomFunction","updateCellCustomFunction","updateRowCustomFunction","deleteCustomFunction","serverErrorMessage","serverErrorPath","exclude","cdataEscape","requestType","responseType","dataType","urlSuffix","mode"],"displayValues":["\"adapter\"","\"idKey\"","\"newIndexPath\"","\"recordPath\"","\"nodePath\"","\"searchKey\"","\"search\"","\"sortByKey\"","\"sortBy\"","\"sortDirKey\"","\"sortDir\"","\"startAtKey\"","\"startAtValue\"","\"limitToKey\"","\"limitTo\"","\"pageKey\"","\"countPath\"","\"cursor\"","\"loadByPage\"","\"loadByScroll\"","\"hasNextPath\"","\"nextPath\"","\"nextIDPath\"","\"nextIDKey\"","\"hasPrevPath\"","\"prevPath\"","\"prevIDPath\"","\"prevIDKey\"","\"pageBase\"","\"collection\"","\"subscription\"","\"createOptions\"","\"readOptions\"","\"updateOptions\"","\"deleteOptions\"","\"src\"","\"method\"","\"headers\"","\"queryString\"","\"body\"","\"bodyMethodSuffix\"","\"createBody\"","\"readBody\"","\"updateRowBody\"","\"updateCellBody\"","\"deleteBody\"","\"exclude\"","\"requestType\"","\"mode\"","\"restmode\"","\"createCustomFunction\"","\"readCustomFunction\"","\"updateRowCustomFunction\"","\"updateCellCustomFunction\"","\"deleteCustomFunction\"","\"serverErrorMessage\"","\"serverErrorPath\""],"values":[{"name":"adapter","parent":"name","description":"Adapter is a shortcut to set known options for specific third party datasets. Currently supports `graphql` and `firebase`.\nDevelopers could register their own custom adapters. For more information on custom adapters, visit Guides > ZingGrid Object > registerAdapter().","demoLink":"https://app.zingsoft.com/demos/create/INPUJ56X","relatedAttributes":["searchKey "," sortByKey "," sortDirKey "," startAtKey "," limitToKey "," pageKey "," nextIDKey "," prevIDKey"],"displayValues":"firebase","type":"<string>","advancedFeature":"","group":"Basic, Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-adapter","category":"Attribute Value"},{"name":"idKey","parent":"name","description":"In the case of non-key based objects, the idKey can be set to indicate the id to send back to the datasource on CRUD commands.\nFor example, if the READ URL was https://zinggrid-named.firebaseio.com/ then the UPDATE would be https://zinggrid-named.firebaseio.com/VALUE_OF_IDKEY.","demoLink":"https://app.zingsoft.com/demos/create/NKCF2H81","relatedAttributes":[],"displayValues":"\"state\"","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-idKey","category":"Attribute Value"},{"name":"newIndexPath","parent":"name","description":"Specifies the path of the insert or CREATE response that returns an object to indicate the key value of the new record.\nBy default, it is set to the idKey or the raw value of the response so it would not be necessary to set this property.","demoLink":"https://app.zingsoft.com/demos/create/WWYIKFRO","relatedAttributes":["idKey"],"displayValues":"\"newId\"","type":"<string>","advancedFeature":"","group":"Response","tagName":"zg-param","fullName":"zg-param-name-newIndexPath","category":"Attribute Value"},{"name":"recordPath","parent":"name","description":"Sets the path of the JSON object response to where the grid data is located. When not specified,\nit is assumed that the whole JSON object response is the grid data. This value takes in dot notation.","demoLink":"https://app.zingsoft.com/demos/create/LC4P27SE","relatedAttributes":[],"displayValues":"\"data.result\" | \"result\"","type":"<string>","advancedFeature":"","group":"Response","tagName":"zg-param","fullName":"zg-param-name-recordPath","category":"Attribute Value"},{"name":"nodePath","parent":"name","description":"Sets the path of the JSON object within the array. When not specified,\nit is assumed that the array contains the JSON object. This value takes in dot notation.","demoLink":"https://app.zingsoft.com/demos/create/C9QXN89T","relatedAttributes":[],"displayValues":"\"node\"","type":"<string>","advancedFeature":"","group":"Response","tagName":"zg-param","fullName":"zg-param-name-nodePath","category":"Attribute Value"},{"name":"searchKey","parent":"name","description":"The query parameter to specify the search value","demoLink":"https://app.zingsoft.com/demos/create/1K3LP4K6","relatedAttributes":["search"],"displayValues":"\"searchBy\" | \"searchOn\"","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-searchKey","category":"Attribute Value"},{"name":"search","parent":"name","description":"The value to search by. This is automatically generated when search using `<zg-search>`, but the developer\nhas option to specify if preferred.","demoLink":"https://app.zingsoft.com/demos/create/CW5F3RVA","relatedAttributes":["searchKey"],"displayValues":"\"search term\"","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-search","category":"Attribute Value"},{"name":"serverFilter","parent":"name","description":"Boolean value indicating that filtering should take place on the server. Requires `loadByPage` to be enabled.","demoLink":"https://app.zingsoft.com/demos/create/5O772NYE","relatedAttributes":["search"],"displayValues":"\"true\"","type":"<boolean>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-serverFilter","category":"Attribute Value"},{"name":"sortByKey","parent":"name","description":"The query parameter to specify the sort field","demoLink":"https://app.zingsoft.com/demos/create/YSSOXDUA","relatedAttributes":["sortBy"," sortDir"," sortDirKey"],"displayValues":"\"orderBy\"","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-sortByKey","category":"Attribute Value"},{"name":"sortBy","parent":"name","description":"Specifies the property to sort on. This is automatically generated on column sort.","demoLink":"https://app.zingsoft.com/demos/create/ZI6W6X18","relatedAttributes":["sortByKey"," sortDir"," sortDirKey"],"displayValues":"\"column index\"","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-sortBy","category":"Attribute Value"},{"name":"sortDirKey","parent":"name","description":"The query parameter that specifies sort direction","demoLink":"https://app.zingsoft.com/demos/create/5BFDK9AK","relatedAttributes":["sortBy"," sortByKey"," sortDir"],"displayValues":"\"sortDir\"","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-sortDirKey","category":"Attribute Value"},{"name":"sortDir","parent":"name","description":"Sets the sort direction. This is automatically generated on column sort.","demoLink":"https://app.zingsoft.com/demos/create/ZFUR01ER","relatedAttributes":["sortBy"," sortByKey"," sortDirKey"],"displayValues":"\"asc\" | \"desc\"","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-sortDir","category":"Attribute Value"},{"name":"startAtKey","parent":"name","description":"The query parameter that specifies the start location. Must specify either nextPath, nextIDPath, pageKey\nor startAtKey when using loadByPage or loadByScroll.","demoLink":"https://app.zingsoft.com/demos/create/CPQ5ZW2K","relatedAttributes":["loadByPage"," loadByScroll"," startAtValue"],"displayValues":"\"startAt\"","type":"<string>","advancedFeature":"","group":"Infinite Scrolling, Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-startAtKey","category":"Attribute Value"},{"name":"startAtValue","parent":"name","description":"Boolean value indicating that a value is required (instead of an index) for the next start value","demoLink":"https://app.zingsoft.com/demos/create/4UXOMRHI","relatedAttributes":["startAtKey"],"displayValues":"true","type":"<boolean>","advancedFeature":"","group":"Infinite Scrolling, Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-startAtValue","category":"Attribute Value"},{"name":"limitToKey","parent":"name","description":"The query parameter to specify limitTo amount. Required to be used in loadByScroll or loadByPage.","demoLink":"https://app.zingsoft.com/demos/create/T8FMG04U","relatedAttributes":["limitTo"," loadByPage"," loadByScroll"],"displayValues":"\"limitTo\" | \"limitToFirst\"","type":"<string>","advancedFeature":"","group":"Infinite Scrolling, Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-limitToKey","category":"Attribute Value"},{"name":"limitTo","parent":"name","description":"Sets the page size. Uses ZingGrid page size by default, so `should not set`.","demoLink":"https://app.zingsoft.com/demos/create/O9DJDRMX","relatedAttributes":["limitToKey"," loadByPage"," loadByScroll"],"displayValues":"10","type":"<number>","advancedFeature":"","group":"Infinite Scrolling, Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-limitTo","category":"Attribute Value"},{"name":"pageKey","parent":"name","description":"The query parameter to specify the page. Must specify either nextPath, nextIDPath, pageKey\nor startAtKey when using loadByPage or loadByScroll.","demoLink":"https://app.zingsoft.com/demos/create/KFQ7K7PO","relatedAttributes":["loadByPage"," loadByScroll"],"displayValues":"5","type":"<number>","advancedFeature":"","group":"Infinite Scrolling, Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-pageKey","category":"Attribute Value"},{"name":"countPath","parent":"name","description":"Sets the value to path of the total count of records.","demoLink":"https://app.zingsoft.com/demos/create/ZWKZ9NCI","relatedAttributes":["loadByPage"],"displayValues":"\"total\"","type":"<string>","advancedFeature":"","group":"Cursor Paging, Server Paging, Response","tagName":"zg-param","fullName":"zg-param-name-countPath","category":"Attribute Value"},{"name":"cursor","parent":"name","description":"Boolean indicating if we should handle the loadByPage as cursor-based. \nIf set to true, no count or number of pages will be displayed. Used in loadByPage","demoLink":"https://app.zingsoft.com/demos/create/AGVH2MAS","relatedAttributes":["loadByPage"],"displayValues":"true","type":"<boolean>","advancedFeature":"","group":"Server Paging","tagName":"zg-param","fullName":"zg-param-name-cursor","category":"Attribute Value"},{"name":"loadByPage","parent":"name","description":"Boolean value enabling each page of data to be retrieved from server. Requires setting sortBy in Firebase. \nMust specify either nextPath, nextIDPath, pageKey or startAtKey when using loadByPage.","demoLink":"https://app.zingsoft.com/demos/create/FLVRKTRN","relatedAttributes":["countPath"," cursor"," nextPath"," nextIDPath"," pageKey"," startAtKey"," sortBy"],"displayValues":"true","type":"<boolean>","advancedFeature":"","group":"Server Paging","tagName":"zg-param","fullName":"zg-param-name-loadByPage","category":"Attribute Value"},{"name":"loadByScroll","parent":"name","description":"Boolean value enabling infinite scrolling. Enabling infinite scrolling requires setting `height` on `<zing-grid>` and \nalso setting the following: limitToKey, startAtKey, sortByKey, startAtValue, and sortBy. The first four are set when using Firebase adapter.\nMust specify either nextPath, nextIDPath, pageKey or startAtKey when using loadByScroll.","demoLink":"https://app.zingsoft.com/demos/create/XBUU0FKR","relatedAttributes":["limitToKey"," nextPath"," nextIDPath"," pageKey"," sortBy"," sortByKey"," startAtKey"," startAtValue"],"displayValues":"true","type":"<boolean>","advancedFeature":"","group":"Infinite Scrolling","tagName":"zg-param","fullName":"zg-param-name-loadByScroll","category":"Attribute Value"},{"name":"hasNextPath","parent":"name","description":"Path to check if there is more data.","demoLink":"https://app.zingsoft.com/demos/create/ULTJD8JV","relatedAttributes":["loadByPage"," nextPath"," nextIDPath"," nextIDKey"," hasPrevPath"," prevPath"," nextIDPath"," pathIDKey"],"displayValues":"\"hasNext\"","type":"<string>","advancedFeature":"","group":"Server Paging, Response","tagName":"zg-param","fullName":"zg-param-name-hasNextPath","category":"Attribute Value"},{"name":"nextPath","parent":"name","description":"If set, looks at response packet for full link to next path. Must specify either nextPath, nextIDPath, pageKey\nor startAtKey when using loadByPage.","demoLink":"https://app.zingsoft.com/demos/create/8TWXXV2A","relatedAttributes":["loadByPage"," hasNextPath"," nextIDPath"," nextIDKey"," hasPrevPath"," prevPath"," nextIDPath"," pathIDKey"],"displayValues":"\"next\"","type":"<string>","advancedFeature":"","group":"Server Paging, Response","tagName":"zg-param","fullName":"zg-param-name-nextPath","category":"Attribute Value"},{"name":"nextIDPath","parent":"name","description":"If set, looks at response packet for ID to next path.","demoLink":"https://app.zingsoft.com/demos/create/MJAH188G","relatedAttributes":["loadByPage"," hasNextPath"," nextPath"," nextIDKey"," hasPrevPath"," prevPath"," nextIDPath"," pathIDKey"],"displayValues":"\"next\"","type":"<string>","advancedFeature":"","group":"Server Paging, Response","tagName":"zg-param","fullName":"zg-param-name-nextIDPath","category":"Attribute Value"},{"name":"nextIDKey","parent":"name","description":"If set, adds the next key to the URL to get to the next recordset. Must specify either nextPath, nextIDPath, pageKey\nor startAtKey when using loadByPage.","demoLink":"https://app.zingsoft.com/demos/create/YTTYHLBB","relatedAttributes":["loadByPage"," hasNextPath"," nextPath"," nextIDPath"," hasPrevPath"," prevPath"," prevIDKey"," pathIDKey"],"displayValues":"\"next\"","type":"<string>","advancedFeature":"","group":"Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-nextIDKey","category":"Attribute Value"},{"name":"hasPrevPath","parent":"name","description":"Path to check if there is previous data.","demoLink":"https://app.zingsoft.com/demos/create/3978XVPB","relatedAttributes":["loadByPage"," hasNextPath"," nextPath"," nextIDPath"," nextIDKey"," prevPath"," prevIDKey"," pathIDKey"],"displayValues":"\"hasPrev\"","type":"<string>","advancedFeature":"","group":"Server Paging, Response","tagName":"zg-param","fullName":"zg-param-name-hasPrevPath","category":"Attribute Value"},{"name":"prevPath","parent":"name","description":"If set, looks at repsonse for link to previous path.","demoLink":"https://app.zingsoft.com/demos/create/V2YWHKZL","relatedAttributes":["loadByPage"," hasNextPath"," nextPath"," nextIDPath"," nextIDKey"," hasPrevPath"," prevIDKey"," pathIDKey"],"displayValues":"\"prev\"","type":"<string>","advancedFeature":"","group":"Server Paging, Response","tagName":"zg-param","fullName":"zg-param-name-prevPath","category":"Attribute Value"},{"name":"prevIDPath","parent":"name","description":"If set, looks at response packet for ID to prev path.","demoLink":"https://app.zingsoft.com/demos/create/185YDY2I","relatedAttributes":["loadByPage"," hasNextPath"," nextPath"," nextIDPath"," nextIDKey"," hasPrevPath"," prevPath"," pathIDKey"],"displayValues":"\"prev\"","type":"<string>","advancedFeature":"","group":"Server Paging, Response","tagName":"zg-param","fullName":"zg-param-name-prevIDPath","category":"Attribute Value"},{"name":"prevIDKey","parent":"name","description":"If set, adds the prev key to the URL to get to the previous recordset.","demoLink":"https://app.zingsoft.com/demos/create/5M0VNSXW","relatedAttributes":["loadByPage"," hasNextPath"," nextPath"," nextIDPath"," nextIDKey"," hasPrevPath"," prevPath"," prevIDKey"],"displayValues":"\"prev\"","type":"<string>","advancedFeature":"","group":"Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-prevIDKey","category":"Attribute Value"},{"name":"pageBase","parent":"name","description":"If loadByPage enabled, sets this to base page. The default is 1.","demoLink":"https://app.zingsoft.com/demos/create/ST4I7O5E","relatedAttributes":["loadByPage"],"displayValues":"0","type":"<number>","advancedFeature":"","group":"Server Paging","tagName":"zg-param","fullName":"zg-param-name-pageBase","category":"Attribute Value"},{"name":"csvCaption","parent":"name","description":"Specific to CSV responseType. Specify if the first line should be the caption","demoLink":"https://app.zingsoft.com/demos/create/CEQQS34H","relatedAttributes":["csvDelimiter"," csvLineSeparator"," csvHeader"],"displayValues":"'true'","type":"<string>","advancedFeature":"","group":"Response, Transport","tagName":"zg-param","fullName":"zg-param-name-csvCaption","category":"Attribute Value"},{"name":"csvDelimiter","parent":"name","description":"Specific to CSV responseType. Specify the separator to split the columns. ',' is default","demoLink":"https://app.zingsoft.com/demos/create/9HRX4U04","relatedAttributes":["csvHeader"," csvLineSeparator"," csvCaption"],"displayValues":"';'","type":"<string>","advancedFeature":"","group":"Response, Transport","tagName":"zg-param","fullName":"zg-param-name-csvDelimiter","category":"Attribute Value"},{"name":"csvHeader","parent":"name","description":"Specific to CSV responseType. Specify if the first line (or second if caption defined) should be the column headers","demoLink":"https://app.zingsoft.com/demos/create/LRRFGZEA","relatedAttributes":["csvDelimiter"," csvLineSeparator"," csvCaption"],"displayValues":"'true'","type":"<string>","advancedFeature":"","group":"Response, Transport","tagName":"zg-param","fullName":"zg-param-name-csvHeader","category":"Attribute Value"},{"name":"csvLineSeparator","parent":"name","description":"Specific to CSV responseType. Specify the separator to split the rows. '\\r\\n' is default","demoLink":"https://app.zingsoft.com/demos/create/7YJDE4BI","relatedAttributes":["csvHeader"," csvDelimiter"," csvCaption"],"displayValues":"'\\n'","type":"<string>","advancedFeature":"","group":"Response, Transport","tagName":"zg-param","fullName":"zg-param-name-csvLineSeparator","category":"Attribute Value"},{"name":"tableHide","parent":"name","description":"Hide the table referenced in tableData","demoLink":"https://app.zingsoft.com/demos/create/QX0WYQP0","relatedAttributes":["tableHead"," tableDataFormat"," tableHeadFormat"],"displayValues":"true","type":"<boolean>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-tableHide","category":"Attribute Value"},{"name":"tableHead","parent":"name","description":"Specifies the values that should be used for the grid's header","demoLink":"https://app.zingsoft.com/demos/create/YA4CH1RT","relatedAttributes":["tableHide"," tableDataFormat"," tableHeadFormat"],"displayValues":"[\"head\", \"age\"]","type":"<array>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-tableHead","category":"Attribute Value"},{"name":"tableDataFormat","parent":"name","description":"Specifies if the grid should copy the full html value of the data rows or just the text data.","demoLink":"https://app.zingsoft.com/demos/create/I30537I1","relatedAttributes":["tableHide"," tableHead"," tableHeadFormat"],"displayValues":"html | text","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-tableDataFormat","category":"Attribute Value"},{"name":"tableHeadFormat","parent":"name","description":"Specifies if the grid should copy the full html value of the header row or just the text data.","demoLink":"https://app.zingsoft.com/demos/create/RJUZSP76","relatedAttributes":["tableHide"," tableHead"," tableHeadFormat"],"displayValues":"html | text","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-tableHeadFormat","category":"Attribute Value"},{"name":"collection","parent":"name","description":"Specific to the firebaseSDK. Sets the firebase collection to use.","demoLink":"https://app.zingsoft.com/demos/create/OVOW5Y18","relatedAttributes":["adapter"],"displayValues":"\"addresses\"","type":"<string>","advancedFeature":"","group":"Firebase","tagName":"zg-param","fullName":"zg-param-name-collection","category":"Attribute Value"},{"name":"subscription","parent":"name","description":"Specific to the firebaseSDK. Set to true if you want to use subscription mode.","demoLink":"https://app.zingsoft.com/demos/create/D4HXQCIQ","relatedAttributes":["adapter"," collection"],"displayValues":"true","type":"<boolean>","advancedFeature":"","group":"Firebase","tagName":"zg-param","fullName":"zg-param-name-subscription","category":"Attribute Value"},{"name":"createOptions","parent":"name","description":"Sets the options for CREATE request. Options are formatted as a JSON string.\nAvalable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot neccessary to set, the top-level values will be taken instead.","demoLink":"https://app.zingsoft.com/demos/create/67G8B9XF","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"'{\"method\": \"POST\", \"body\": \"buildInsert\"}'","type":"<object>","advancedFeature":"","group":"Transport","tagName":"zg-param","fullName":"zg-param-name-createOptions","category":"Attribute Value"},{"name":"readOptions","parent":"name","description":"Sets the options for READ request. Options are formatted as a JSON string.\nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.","demoLink":"https://app.zingsoft.com/demos/create/XXC2LW5T","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"'{\"method\": \"GET\"}'","type":"<object>","advancedFeature":"","group":"Transport","tagName":"zg-param","fullName":"zg-param-name-readOptions","category":"Attribute Value"},{"name":"updateRowOptions","parent":"name","description":"Sets the options for UPDATE row request. \nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.","demoLink":"https://app.zingsoft.com/demos/create/LSDDMAMR","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"'{\"method\": \"PATCH\", \"body\": \"buildUpdate\"}'","type":"<object>","advancedFeature":"","group":"Transport","tagName":"zg-param","fullName":"zg-param-name-updateRowOptions","category":"Attribute Value"},{"name":"updateCellOptions","parent":"name","description":"Sets the options for UPDATE cell request. \nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.","demoLink":"https://app.zingsoft.com/demos/create/VFDNK700","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"'{\"method\": \"PATCH\", \"body\": \"buildUpdate\"}'","type":"<object>","advancedFeature":"","group":"Transport","tagName":"zg-param","fullName":"zg-param-name-updateCellOptions","category":"Attribute Value"},{"name":"updateOptions","parent":"name","description":"Sets the options for UPDATE request. Options can be set to either \"cell\" or \"row\" updates, the types of updates used in ZingGrid; \noptions are formatted as a JSON string.\nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.","demoLink":"https://app.zingsoft.com/demos/create/VFDNK700","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"'{\"row\":{\"method\": \"PATCH\", \"body\": \"buildUpdate\"}}'","type":"<object>","advancedFeature":"","group":"Transport","tagName":"zg-param","fullName":"zg-param-name-updateOptions","category":"Attribute Value"},{"name":"deleteOptions","parent":"name","description":"Sets the options for DELETE request. Options are formatted as a JSON string.\nAvailable options for requests: body, requestType, exclude, headers, method, mode, responseType, src, queryString.\nNot necessary to set, the top-level values will be taken instead.","demoLink":"https://app.zingsoft.com/demos/create/ZPE72GI1","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"'{\"exclude\": true}'","type":"<object>","advancedFeature":"","group":"Transport","tagName":"zg-param","fullName":"zg-param-name-deleteOptions","category":"Attribute Value"},{"name":"src","parent":"name","description":"Option for request type. Sets the base URL for the request. ID is automatically inserted in the `src` for DELETE and UPDATE requests.","demoLink":"https://app.zingsoft.com/demos/create/9QJQ8J3I","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"https://url-to-your-api\"","type":"<string>","advancedFeature":"","group":"Basic, Request, Transport","tagName":"zg-param","fullName":"zg-param-name-src","category":"Attribute Value"},{"name":"createSrc","parent":"name","description":"Option for request type. Sets the base URL for the create request.","demoLink":"https://app.zingsoft.com/demos/create/0H3QBZI4","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"https://url-to-your-api\"","type":"<string>","advancedFeature":"","group":"Basic, Request, Transport","tagName":"zg-param","fullName":"zg-param-name-createSrc","category":"Attribute Value"},{"name":"readSrc","parent":"name","description":"Option for request type. Sets the base URL for the read request.","demoLink":"https://app.zingsoft.com/demos/create/P9W8WBIM","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"https://url-to-your-api\"","type":"<string>","advancedFeature":"","group":"Basic, Request, Transport","tagName":"zg-param","fullName":"zg-param-name-readSrc","category":"Attribute Value"},{"name":"updateRowSrc","parent":"name","description":"Option for request type. Sets the base URL for the update row request.","demoLink":"https://app.zingsoft.com/demos/create/HY5B7XUZ","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"https://url-to-your-api\"","type":"<string>","advancedFeature":"","group":"Basic, Request, Transport","tagName":"zg-param","fullName":"zg-param-name-updateRowSrc","category":"Attribute Value"},{"name":"updateCellSrc","parent":"name","description":"Option for request type. Sets the base URL for the update cell request.","demoLink":"https://app.zingsoft.com/demos/create/XHSL4R8O","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"https://url-to-your-api\"","type":"<string>","advancedFeature":"","group":"Basic, Request, Transport","tagName":"zg-param","fullName":"zg-param-name-updateCellSrc","category":"Attribute Value"},{"name":"deleteSrc","parent":"name","description":"Option for request type. Sets the base URL for the delete request.","demoLink":"https://app.zingsoft.com/demos/create/FO0DEVLY","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"https://url-to-your-api\"","type":"<string>","advancedFeature":"","group":"Basic, Request, Transport","tagName":"zg-param","fullName":"zg-param-name-deleteSrc","category":"Attribute Value"},{"name":"restmode","parent":"name","description":"Set to \"manual\" if you want to turn off traditional REST URL construction and method setting.\nThe method settings for `restmode=\"manual\"` is GET = GET and the all other = POST. To update\nmethod settings, use `updateCellMethod`, `deleteMethod`, etc.","demoLink":"https://app.zingsoft.com/demos/create/T2A2FI5A","relatedAttributes":["src"],"displayValues":"\"manual\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-restmode","category":"Attribute Value"},{"name":"method","parent":"name","description":"Option for request type (GET, POST, PUT, etc). ZingGrid uses the standard request type per action, but it can overwritten with this param.","demoLink":"https://app.zingsoft.com/demos/create/QIL693ZK","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"GET\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-method","category":"Attribute Value"},{"name":"createMethod","parent":"name","description":"Sets the method on the create request","demoLink":"https://app.zingsoft.com/demos/create/WD5FZCAG","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"POST\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-createMethod","category":"Attribute Value"},{"name":"readMethod","parent":"name","description":"Sets the method on the read request","demoLink":"https://app.zingsoft.com/demos/create/V25H7SA8","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"POST\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-readMethod","category":"Attribute Value"},{"name":"updateRowMethod","parent":"name","description":"Sets the method on the update row request","demoLink":"https://app.zingsoft.com/demos/create/XNRZG484","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"POST\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-updateRowMethod","category":"Attribute Value"},{"name":"updateCellMethod","parent":"name","description":"Sets the method on the update cell request","demoLink":"https://app.zingsoft.com/demos/create/378DGYMM","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"POST\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-updateCellMethod","category":"Attribute Value"},{"name":"deleteMethod","parent":"name","description":"Sets the method on the the delete request","demoLink":"https://app.zingsoft.com/demos/create/5DL34ANK","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"POST\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-deleteMethod","category":"Attribute Value"},{"name":"headers","parent":"name","description":"Option for request type. Sets headers for request.","demoLink":"https://app.zingsoft.com/demos/create/ZK2QWNOR","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"'{\"Authorization\": \"token ################################\"}'","type":"<object>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-headers","category":"Attribute Value"},{"name":"queryString","parent":"name","description":"Option for request type. Adds an additional query string to request.","demoLink":"https://app.zingsoft.com/demos/create/ZHHZ3G9B","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"?query=value\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-queryString","category":"Attribute Value"},{"name":"body","parent":"name","description":"Sets the body or query string of the request, which overwrites the ZingGrid generated query string. \nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/DUPBJ14G","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-body","category":"Attribute Value"},{"name":"bodyMethodSuffix","parent":"name","description":"Sets the suffix for the function name that will construct the body for the request. \nWill set the `createBody`, `readBody`, `updateRowBody`, `updateCellBody`, and `deleteBody` parameters to:\n `create` + suffix\n `read` + suffix\n `updateRow` + suffix\n `updateCell` + suffix\n `delete` + suffix","demoLink":"https://app.zingsoft.com/demos/create/42M72GOB","relatedAttributes":["createBody"," readBody"," updateRowBody"," updateCellBody"," deleteBody"],"displayValues":"\"Countries\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-bodyMethodSuffix","category":"Attribute Value"},{"name":"createBody","parent":"name","description":"Sets the body on the create request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/HMXLON8C","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-createBody","category":"Attribute Value"},{"name":"readBody","parent":"name","description":"Sets the body on the read request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/EDR37AFU","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-readBody","category":"Attribute Value"},{"name":"updateRowBody","parent":"name","description":"Sets the body on the update row request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/1E32Z8UY","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-updateRowBody","category":"Attribute Value"},{"name":"updateCellBody","parent":"name","description":"Sets the body on the update cell request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/I37HV370","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-updateCellBody","category":"Attribute Value"},{"name":"deleteBody","parent":"name","description":"Sets the body on the delete request\nCan be set to a template string, string, or function name. If set to function name, the function \ntakes in `rawData`, `method`, and `src` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/GC0X2ZHJ","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-deleteBody","category":"Attribute Value"},{"name":"createCustomFunction","parent":"name","description":"Sets the function that handles the external data handling for creating new records\nThe function takes in `recordId`, `rawData`, and `options` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/NA2MOBP2","relatedAttributes":["readCustomFunction"," updateRowCustomFunction"," updateCellCustomFunction"," deleteCustomFunction"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-createCustomFunction","category":"Attribute Value"},{"name":"readCustomFunction","parent":"name","description":"Sets the function that handles the external data handling for reading data\nThe function takes in `options` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/CCBG1P89","relatedAttributes":["createCustomFunction"," updateRowCustomFunction"," updateCellCustomFunction"," deleteCustomFunction"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-readCustomFunction","category":"Attribute Value"},{"name":"updateCellCustomFunction","parent":"name","description":"Sets the function that handles the external data handling for updating a cell of data\nThe function takes in `recordId`, `rawData`, and `options` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/MVFAGNZQ","relatedAttributes":["createCustomFunction"," readCustomFunction"," updateRowCustomFunction"," deleteCustomFunction"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-updateCellCustomFunction","category":"Attribute Value"},{"name":"updateRowCustomFunction","parent":"name","description":"Sets the function that handles the external data handling for updating a row of data\nThe function takes in `recordId`, `rawData`, and `options` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/Q137XUG8","relatedAttributes":["createCustomFunction"," readCustomFunction"," updateCellCustomFunction"," deleteCustomFunction"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-updateRowCustomFunction","category":"Attribute Value"},{"name":"deleteCustomFunction","parent":"name","description":"Sets the function that handles the external data handling for delete\nThe function takes in `recordId`, `rawData`, and `options` and returns an object to send as body for request.","demoLink":"https://app.zingsoft.com/demos/create/8RN6ISCQ","relatedAttributes":["createCustomFunction"," readCustomFunction"," updateRowCustomFunction"," updateCellCustomFunction"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-deleteCustomFunction","category":"Attribute Value"},{"name":"serverErrorMessage","parent":"name","description":"Sets the error message for any server errors. Use [[serverMessage]] token to set message from server","demoLink":"https://app.zingsoft.com/demos/create/LA6IQ805","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"Server Error: [[serverMessage]]\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-serverErrorMessage","category":"Attribute Value"},{"name":"serverErrorPath","parent":"name","description":"serverErrorPath: Sets the path to the server error message if response is JSON.","demoLink":"https://app.zingsoft.com/demos/create/1MUTKTD6","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"error.message\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-serverErrorPath","category":"Attribute Value"},{"name":"exclude","parent":"name","description":"If enabled, method will not call the external REST API","demoLink":"https://app.zingsoft.com/demos/create/RLFIG55J","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"true","type":"<boolean>","advancedFeature":"","group":"Transport","tagName":"zg-param","fullName":"zg-param-name-exclude","category":"Attribute Value"},{"name":"cdataEscape","parent":"name","description":"If enabled, method will escape HTML wrapped in CDATA blocks on xml decoding","demoLink":"https://app.zingsoft.com/demos/create/BEUI9CY3","relatedAttributes":[],"displayValues":"true","type":"<boolean>","advancedFeature":"","group":"Response, Transport","tagName":"zg-param","fullName":"zg-param-name-cdataEscape","category":"Attribute Value"},{"name":"requestType","parent":"name","description":"Sets the Content Type for the request. The default is application/json.","demoLink":"https://app.zingsoft.com/demos/create/O4UVU8NG","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"multipart/form-data\"","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-requestType","category":"Attribute Value"},{"name":"responseType","parent":"name","description":"Sets the expected Content Type for the response. The default is application/json.","demoLink":"https://app.zingsoft.com/demos/create/J4O83U8F","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"application/xml\"","type":"<string>","advancedFeature":"","group":"Response, Transport","tagName":"zg-param","fullName":"zg-param-name-responseType","category":"Attribute Value"},{"name":"dataType","parent":"name","description":"Sets the expected data type for a static data source. The default is application/json.","demoLink":"https://app.zingsoft.com/demos/create/CWL0WCLK","relatedAttributes":[],"displayValues":"\"application/xml\"","type":"<string>","advancedFeature":"","group":"Response","tagName":"zg-param","fullName":"zg-param-name-dataType","category":"Attribute Value"},{"name":"urlSuffix","parent":"name","description":"Any string to place at the end of a REST constructed URL. Note that this cannot be used with `restmode` is set to 'manual'.","demoLink":"https://app.zingsoft.com/demos/create/78FJJ2CS","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"\"/\"","type":"<string>","advancedFeature":"","group":"Response, Transport","tagName":"zg-param","fullName":"zg-param-name-urlSuffix","category":"Attribute Value"},{"name":"mode","parent":"name","description":"Sets to 'cors' to specify the settings for cors request. The external server must enable 'cors' for this to take effect.","demoLink":"https://app.zingsoft.com/demos/create/YITD2NPL","relatedAttributes":["createOptions"," deleteOptions"," readOptions"," updateOptions"," body"," requestType"," exclude"," headers"," method"," mode"," responseType"," src"," queryString"],"displayValues":"'cors'","type":"<string>","advancedFeature":"","group":"Request, Transport","tagName":"zg-param","fullName":"zg-param-name-mode","category":"Attribute Value"}],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-param"},{"name":"value","description":"The value for given data key. If the value is an object, format as JSON encoded version of string.","type":"String","fullName":"zg-param-value","demoLink":"https://app.zingsoft.com/demos/create/R2K22X2Q","default":"\"\"","acceptedValues":["<string>"],"displayValues":["'{\"src\":\"http://example.com/deletestate/\",\"method\":\"GET\"}'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-param"}]