{"ZGBatchEdit":{"elementDescription":"The `<zg-batch-edit>` element is used to define the batch edit region.  \n`<zg-batch-edit>` is created internally and should not be placed directly in the user's HTML; however,\nthe user can style the `<zg-batch-edit>` using the `zg-batch-edit` selector.","parentComponent":[{"name":"ZingGrid","type":["Generated"]}],"storyCSSAlert":"Enable batch edit mode (top-left button of grid) to see CSS variables apply.","storyExample":"<zing-grid batch-edit editor-controls {{data}}></zing-grid>\n\n<script>\n  (() => {\n    let zgRef = document.querySelector('zing-grid');\n    zgRef.executeOnLoad(() => {\n      let zgButtonRef = zgRef.querySelector('zg-button[action=\"batchedit\"]');\n      zgButtonRef.click();\n    });\n  })();\n</script>","members":[]},"ZGBody":{"elementDescription":"`<zg-body>` is created dynamically by the ZingGrid library, and as such should not be manually added by the\ndeveloper.  However the user can style `<zg-body>` using CSS.","parentComponent":[{"name":"ZGTable","type":["Generated"]}],"childComponent":[{"name":"ZGRow","type":["Generated"]}],"storyCSSAlert":"Use layout control (top-right buttons of grid) to switch to \"card\" layout for `--zg-body-card-*` CSS variables.","storyExample":"<zing-grid layout-controls layout=\"row\" {{data}}></zing-grid>","storyExampleAlt":{"card":"<zing-grid layout-controls layout=\"card\" {{data}}></zing-grid>"},"members":[]},"ZGButton":{"elementDescription":"A custom, styled button that can be used both for internal grid-related action and for user-specific\nactions. It is stylable via CSS. Some buttons are automatically inserted when a feature that uses it enabled, like `pager`, while\nothers are inserted manually by the user.","parentComponent":[{"name":"ZGCaption","type":["Generated","Manual"]},{"name":"ZGCard","type":["Manual"]},{"name":"ZGCell","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGColumn","type":["Manual"]},{"name":"ZGControlBar","type":["Generated"]},{"name":"ZGDialog","type":["Manual"]},{"name":"ZGFooter","type":["Manual"]},{"name":"ZGHeadCell","type":["Generated"]},{"name":"ZGLayoutControls","type":["Generated"]},{"name":"ZGLoadMask","type":["Manual"]},{"name":"ZGMenu","type":["Generated"]},{"name":"ZGMenuItem","type":["Generated"]},{"name":"ZGNoData","type":["Generated","Manual"]},{"name":"ZGPager","type":["Generated","Manual"]},{"name":"ZGSource","type":["Manual"]}],"childComponent":[{"name":"ZGCheckbox","type":["Generated"]},{"name":"ZGIcon","type":["Generated","Manual"]}],"slots":[{"name":"","description":"Button content."},{"name":"icon","description":"Button icon. Replaces the default slot."},{"name":"label","description":"Button label. Use to add a label when using the \"icon\" slot."}],"storyExample":"<zing-grid editor-controls pager {{data}}>\n  <zg-caption>\n    <zg-button {{args}}>\n      Caption Button\n    </zg-button>\n    </zg-caption>\n  <zg-source>\n    <zg-button {{args}}>\n      Source Button\n    </zg-button>\n  </zg-source>\n</zing-grid>","members":[{"name":"action","description":"Sets the action of the button","type":"String","fullName":"zg-button-action","demoLink":"https://app.zingsoft.com/demos/create/91NN585A","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"batchedit\"","\"batcheditcancel\"","\"batcheditsave\"","\"cancel\"","\"cancelrecord\"","\"checkbox\"","\"closerowdetails\"","\"closerowgroup\"","\"copycell\"","\"createrecord\"","\"createrecordend\"","\"createrecordstart\"","\"deselect\"","\"duplicaterecord\"","\"editcell\"","\"editrecord\"","\"editrow\"","\"filter\"","\"firstpage\"","\"fixedmenu\"","\"freezecolumnleft\"","\"freezecolumnright\"","\"unfreezecolumn\"","\"hidecolumn\"","\"freezerowtop\"","\"freezerowbottom\"","\"unfreezerow\"","\"getselection\"","\"insertrecord\"","\"layoutrow\"","\"layoutcard\"","\"resetstate\"","\"lastpage\"","\"menu\"","\"nextpage\"","\"openrowdetails\"","\"openrowgroup\"","\"pastecell\"","\"prevpage\"","\"reload\"","\"removerecord\"","\"undoremoverecord\"","\"search\"","\"selectall\"","\"selectcell\"","\"selectrow\"","\"sortcolumn\"","\"submitrecord\"","\"about\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-button","version":"1.x.x"},{"name":"custom-disabled","description":"Set to a template or a function to return true or false to set the disabled state\nThe function's callback receives rowData and zg-cell object if in a cell","type":"String","fullName":"zg-button-customDisabled","demoLink":"https://app.zingsoft.com/demos/create/317PZ5AO","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"customFunction\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-button","version":"1.x.x"},{"name":"custom-tooltip","description":"Sets the tooltip in the case of custom buttons.  Can override the default tooltip on builtin buttons","type":"String","fullName":"zg-button-customTooltip","demoLink":"https://app.zingsoft.com/demos/create/E4OTTU1J","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"Tooltip\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-button","version":"1.x.x"},{"name":"disabled","description":"Presence of attribute determines if the button is disabled or not","type":"Boolean","fullName":"zg-button-disabled","demoLink":"https://app.zingsoft.com/demos/create/MIQE2B6K","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-button","version":"1.x.x"},{"name":"force-border","description":"By default, action buttons have no border and custom buttons do.  \nYou can force a border by setting the `[force-border]` attribute and you can force no border by setting `[force-border=\"disabled\"]`","type":"String | Boolean","fullName":"zg-button-forceBorder","demoLink":"https://app.zingsoft.com/demos/create/4JRJ599F","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-button","version":"1.x.x"},{"name":"handler","description":"A custom function to call on button click","type":"function","fullName":"zg-button-handler","demoLink":"","default":"","acceptedValues":"","displayValues":"","values":[],"category":"Attribute","tsType":"","internalDocs":""},{"name":"icon","description":"Sets the icon for the button","type":"String","fullName":"zg-button-icon","demoLink":"https://app.zingsoft.com/demos/create/2YF9ASJA","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"batchedit\"","\"batcheditcancel\"","\"batcheditsave\"","\"cancel\"","\"cancelrecord\"","\"checked\"","\"checkmark\"","\"close\"","\"createrecord\"","\"down\"","\"duplicaterecord\"","\"edit\"","\"editrecord\"","\"error\"","\"error-tmp\"","\"firstpage\"","\"fixedmenu\"","\"filter\"","\"info\"","\"lastpage\"","\"layoutcard\"","\"layoutrow\"","\"link\"","\"menu\"","\"nextpage\"","\"outsidearrow\"","\"prevpage\"","\"reload\"","\"remove\"","\"removerecord\"","\"search\"","\"sort\"","\"submitrecord\"","\"success\"","\"unchecked\"","\"undoremoverecord\"","\"up\"","\"warning\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-button","version":"1.x.x"}]},"ZGCaption":{"elementDescription":"A caption can be manually inserted inside the `<zing-grid>` tag as slotted content or automatically\ninserted when the `caption` is enabled.  `<zg-caption>` is stylable via CSS.","parentComponent":[{"name":"ZGHeader","type":["Generated","Mapped"]},{"name":"ZGFooter","type":["Generated","Manual"]},{"name":"ZingGrid","type":["Manual"]}],"childComponent":[{"name":"ZGButton","type":["Generated","Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGSearch","type":["Generated"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGText","type":["Manual"]}],"cssParts":[{"name":"caption","description":"Caption container"},{"name":"title","description":"The title container"},{"name":"toolbar","description":"The toolbar container"}],"slots":[{"name":"","description":"Caption title."},{"name":"message","description":"Caption title. Use when using a feature that enables caption toolbar ([contextMenu], [search], [staticMenu])."},{"name":"tool","description":"Caption toolbar, which is added to the rightmost of caption by default."}],"storyExample":"<zing-grid {{data}} columns-control search>\n  <zg-caption {{args}}>\n    Hello ZingGrid\n    <zg-button>Caption Button</zg-button>\n  </zg-caption>\n</zing-grid>","members":[{"name":"align","description":"The alignment of content in the caption","type":"String","fullName":"zg-caption-align","demoLink":"https://app.zingsoft.com/demos/create/3VUT9XVS","default":"\"start\"","acceptedValues":["Enum"],"displayValues":["\"start\"","\"left\"","\"right\"","\"center\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-caption","version":"1.x.x"},{"name":"position","description":"Indicates where to position the caption","type":"String","fullName":"zg-caption-position","demoLink":"https://app.zingsoft.com/demos/create/GYOV88PD","default":"\"top\"","acceptedValues":["Enum"],"displayValues":["\"top\"","\"bottom\"","\"both\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-caption","version":"1.x.x"}]},"ZGCard":{"elementDescription":"The container for a card template that holds a custom template for card mode.  This custom template\nwill be rendered per row.  `<zg-card>` can be styled via CSS or the `--zg-card-*` selectors.  Please reference\nthe \"Template\" section for more details on templates.","parentComponent":[{"name":"ZingGrid","type":["Manual"]},{"name":"ZGRow","type":["Generated"]}],"childComponent":[{"name":"ZGButton","type":["Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGText","type":["Manual"]}],"slots":[{"name":"","description":"Card content."}],"storyAlert":"true","storyExample":"<zing-grid {{data}} layout=\"card\">\n  <zg-card {{args}}>\n    [[record.first]] [[record.last]]\n  </zg-card>\n</zing-grid>","members":[{"name":"editor","description":"Sets the custom editor","type":"function","fullName":"zg-card-editor","demoLink":"https://app.zingsoft.com/demos/create/9U5NHFD0","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"editorVariable\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-card","version":"1.x.x"},{"name":"editor-template","description":"Points to an external template element to be used as the template for the card's editor.","type":"function","fullName":"zg-card-editorTemplate","demoLink":"https://app.zingsoft.com/demos/create/ZZE452WJ","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"templateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-card","version":"1.x.x"},{"name":"renderer","description":"The return value of the method is set as the innerHTML of `<zg-card>`.  If nothing is returned,\nit will not change the currently rendered card. The method takes the paramters `data`, `domCard`, and `rowObject`.","type":"function","fullName":"zg-card-renderer","demoLink":"https://app.zingsoft.com/demos/create/B9BRAX0F","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"<p>Card content</p>\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-card","version":"1.x.x"},{"name":"renderer-template","description":"Points to an external template element to be used as the template for the card's render.","type":"function","fullName":"zg-card-rendererTemplate","demoLink":"https://app.zingsoft.com/demos/create/ZBBH3JRQ","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-card","version":"1.x.x"}]},"ZGCell":{"elementDescription":"`<zg-cell>` is the container for a single cell;\nit corresponds to the `<td>` tag on an HTML table.  It is automatically inserted and should not \nbe placed directly in the user's HTML.  `<zg-cell>` can be styled via CSS.","childComponent":[{"name":"ZGButton","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGCheckbox","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGIcon","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGInput","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGSelect","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGText","type":["Generated"],"ancestor":["ZGBody"]}],"storyCSSAlert":"Switch to card layout using layout control (top-right of grid) or sort columns by clicking column headers.","storyExample":"<zing-grid layout-controls layout=\"row\" sort {{data}}></zing-grid>","storyExampleAlt":{"card":"<zing-grid layout-controls layout=\"card\" sort {{data}}></zing-grid>"},"members":[]},"ZGCellOverflow":{"elementDescription":"`<zg-cell-overflow>` elements can be used to add popup data to each cell on a user action.  Typical use would\nbe a custom element select and optionlist.  As a generated element, developers\nshould not manually place `<zg-cell-overflow>` in their grid; however, they may style the tooltips and\nits internal elements using CSS.","members":[]},"ZGCheckbox":{"elementDescription":"A checkbox is automatically inserted when\na feature that uses it is enabled, like `<zg-column type=\"selector\">`, or it can be manually-inserted\nto the grid. It can be styled via CSS.","parentComponent":[{"name":"ZGCaption","type":["Manual"]},{"name":"ZGCard","type":["Manual"]},{"name":"ZGCell","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGColumn","type":["Manual"]},{"name":"ZGDialog","type":["Manual"]},{"name":"ZGFooter","type":["Manual"]},{"name":"ZGHeadCell","type":["Generated"]},{"name":"ZGLoadMask","type":["Manual"]},{"name":"ZGMenu","type":["Manual"]},{"name":"ZGNoData","type":["Manual"]},{"name":"ZGPager","type":["Manual"]},{"name":"ZGSource","type":["Manual"]}],"childComponent":[{"name":"ZGIcon","type":["Generated"]}],"cssParts":[{"name":"text","description":"The text container"}],"slots":[{"name":"","description":"Checkbox label."}],"storyExample":"<zing-grid {{data}}>\n  <zg-caption>\n    <zg-checkbox {{args}}>\n      Caption Checkbox\n    </zg-checkbox>\n  </zg-caption>\n  <zg-source>\n    <zg-checkbox {{args}}>\n      Source Checkbox\n    </zg-checkbox>\n  </zg-source>\n</zing-grid>","members":[{"name":"checked","description":"Presence of attribute determines if the checkbox is checked","type":"Boolean","fullName":"zg-checkbox-checked","demoLink":"https://app.zingsoft.com/demos/create/W64KXNUL","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-checkbox","version":"1.x.x"}]},"ZGColgroup":{"elementDescription":"`<zg-colgroup>` is a container for the columns of the grid specified by `<zg-column>` tags.  \nThis element is similar in function to the `<colgroup>` tag in an HTML element.  \nDevelopers should always add this element to their grid structure; however, ZingGrid will insert it \nautomatically if it is omitted.  As an non-visual element, you should not apply style to this tag.\nNote: Omission of `<zg-colgroup>` may result in a slight performance delay for auto-insertion.","parentComponent":[{"name":"ZingGrid","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGColumn","type":["Generated","Manual"]}],"slots":[{"name":"","description":"Colgroup content that only accepts columns (ZGColumns)."}],"members":[]},"ZGColumn":{"elementDescription":"The `<zg-column>` tag is used to associate the columns of the grid to the values \nin a dataset.  Attributes on the tag are used to configure both the data type, style, and function \nof the grid column.  It is possible to build grids without explicit `<zg-column>` tags, and in that \ncase ZingGrid will add a column for each index in the dataset. However, developers are encouraged to \nexplore the features available with `<zg-column>` to utilize the powerful features ZingGrid has to offer.","parentComponent":[{"name":"ZGColgroup","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGButton","type":["Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGText","type":["Manual"]}],"slots":[{"name":"","description":"Custom column content."}],"storyExample":"<zing-grid column-drag columns-control column-resizable editor filter=\"inline\" search sort {{data}}>\n  <zg-colgroup>\n    {{columns}}\n  </zg-colgroup>\n</zing-grid>","members":[{"name":"align","description":"Aligns the contents of the cell","type":"String","fullName":"zg-column-align","demoLink":"https://app.zingsoft.com/demos/create/2E2VU1NK","default":"\"left\"","acceptedValues":["Enum"],"displayValues":["\"center\"","\"left\"","\"right\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"array-index","description":"If the index is an array of objects, use array-index to indicate which index of the array object to include","type":"String","fullName":"zg-column-arrayIndex","demoLink":"https://app.zingsoft.com/demos/create/NI7I2MVM","default":"N/A","acceptedValues":["<string>"],"displayValues":["\"title\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/NI7I2MVM"},{"name":"array-slice","description":"If the index is an array, you can use array-slice to indicate which array indexes to include.","type":"String | Number","fullName":"zg-column-arraySlice","demoLink":"https://app.zingsoft.com/demos/create/QGP7YD9P","default":"N/A","acceptedValues":["String","Number"],"displayValues":["\"0,1\", \"-1\", \"0,4\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/QGP7YD9P"},{"name":"button-border","description":"Presence of attribute forces a border on the button.  Setting to `disabled` removes the default border.","type":"Boolean | String","fullName":"zg-column-buttonBorder","demoLink":"https://app.zingsoft.com/demos/create/7L8FS2YW","default":"\"\"","acceptedValues":["\"disabled\""],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"cell-break","description":"The type of `word-break` style for body cells. When not set, `cell-break` style is `normal` by default.\nIf the width of a column is set, `cell-break` is `word` by default.","type":"String","fullName":"zg-column-cellBreak","demoLink":"https://app.zingsoft.com/demos/create/EBYE5QDQ","default":"\"normal\"","acceptedValues":["Enum"],"displayValues":["\"all\"","\"ellipsis\"","\"normal\"","\"word\"","\"none\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:width"},{"name":"cell-class","description":"The class to be set directly on `<zg-cell>` within the column. `cell-class` applied to\n`<zg-column>` will overwrite the `cell-class` applied to `<zing-grid>`.","type":"String","fullName":"zg-column-cellClass","demoLink":"https://app.zingsoft.com/demos/create/UK4ATT1M","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"userCustomClass\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/UK4ATT1M","storyControl":"select","storyOptions":"teal, textUppercase"},{"name":"cell-tooltip-action","description":"Sets the execution method of custom 'icon' type tooltips to either activate on hover or click of the icon","type":"String","fullName":"zg-column-cellTooltipAction","demoLink":"https://app.zingsoft.com/demos/create/V1ZLD20G","default":"\"hover\"","acceptedValues":["Enum"],"displayValues":["\"click\"","\"hover\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:cell-tooltip-text"},{"name":"cell-tooltip-delay","description":"Sets the hover delay in milliseconds before displaying the tooltip","type":"Number","fullName":"zg-column-cellTooltipDelay","demoLink":"https://app.zingsoft.com/demos/create/ALCQX5KK","default":"1000","acceptedValues":["Number"],"displayValues":["2000"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:cell-tooltip-text"},{"name":"cell-tooltip-icon","description":"Specifies the icon to use for the cell tooltip trigger icon when using the info column type","type":"String","fullName":"zg-column-cellTooltipIcon","demoLink":"https://app.zingsoft.com/demos/create/6PYU72NM","default":"info","acceptedValues":["Enum"],"displayValues":["\"batchedit\"","\"batcheditcancel\"","\"batcheditsave\"","\"cancel\"","\"cancelrecord\"","\"checked\"","\"checkmark\"","\"close\"","\"createrecord\"","\"down\"","\"duplicaterecord\"","\"edit\"","\"editrecord\"","\"error\"","\"error-tmp\"","\"firstpage\"","\"fixedmenu\"","\"info\"","\"lastpage\"","\"layoutcard\"","\"layoutrow\"","\"link\"","\"menu\"","\"nextpage\"","\"outsidearrow\"","\"prevpage\"","\"reload\"","\"remove\"","\"removerecord\"","\"undoremoverecord\"","\"search\"","\"submitrecord\"","\"success\"","\"unchecked\"","\"up\"","\"warning\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:icon"},{"name":"cell-tooltip-position","description":"Sets the tooltip-position for the cell","type":"String","fullName":"zg-column-cellTooltipPosition","demoLink":"https://app.zingsoft.com/demos/create/M23UZDB2","default":"\"top\"","acceptedValues":["Enum"],"displayValues":["\"top\"","\"left\"","\"right\"","\"bottom\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:cell-tooltip-text"},{"name":"cell-tooltip-renderer","description":"Gets the name of the user's custom render function, on window, to use the function's return value as the tooltip content","type":"String","fullName":"zg-column-cellTooltipRenderer","demoLink":"https://app.zingsoft.com/demos/create/NP2WIJZS","default":"\"\"","acceptedValues":["String"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/NP2WIJZS"},{"name":"cell-tooltip-template","description":"Points to an external template element to be used as the template for the tooltip display","type":"String","fullName":"zg-column-cellTooltipTemplate","demoLink":"https://app.zingsoft.com/demos/create/VX47FJSI","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/VX47FJSI"},{"name":"cell-tooltip-text","description":"Sets the tooltip text for the cell of the column.  Can pass this value to renderer or template if using","type":"String","fullName":"zg-column-cellTooltipText","demoLink":"https://app.zingsoft.com/demos/create/ZU3CJEUG","default":"\"\"","acceptedValues":["String"],"displayValues":["\"Tooltip Value\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"cell-tooltip-type","description":"Sets the style to use for the tooltips.  Uses the `default` style by default.  Can set to `system` to match the tooltips used on icons throughout `<zing-grid>`.","type":"String","fullName":"zg-column-cellTooltipType","demoLink":"https://app.zingsoft.com/demos/create/0QC6J7QP","default":"default","acceptedValues":["Enum"],"displayValues":["\"default\"","\"system\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:cell-tooltip-text"},{"name":"content-style","description":"When an additional HTML element is added to the renderer, as in the case of image and url,\n`content-style` will be put into a style attribute directly on the element.","type":"String","fullName":"zg-column-contentStyle","demoLink":"https://app.zingsoft.com/demos/create/SDSDOG9U","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"max-width: 50px;\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:image"},{"name":"content-width","description":"Sets the width of the content inside of the cell. Used on cells of column type\n`element`, `iframe`, `image`, or `url`.","type":"String | Number","fullName":"zg-column-contentWidth","demoLink":"https://app.zingsoft.com/demos/create/98S6N0H1","default":"\"\"","acceptedValues":["<string pixel value>"],"displayValues":["\"500\"","\"500px\"","500"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:image"},{"name":"default-display","description":"The data to display in each cell where the data value is null or undefined","type":"String","fullName":"zg-column-defaultDisplay","demoLink":"https://app.zingsoft.com/demos/create/UT0I51BC","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"N/A\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset"},{"name":"details-renderer","description":"Renderer for the details page of a column.\nTo use a custom renderer, the attribute should be set to the name of the function.\nThe renderer function takes in the following arguments, `value of index` (for each index), `domCell`, and `cellObject`.\nThe returned value of the renderer function is set as the innerHTML of the details dialog.","type":"String","fullName":"zg-column-detailsRenderer","demoLink":"https://app.zingsoft.com/demos/create/R5UTQ925","default":"\"\"","acceptedValues":["<String>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/R5UTQ925"},{"name":"details-template","description":"Points to an external template element to be used as the template for the column's details","type":"String","fullName":"zg-column-detailsTemplate","demoLink":"https://app.zingsoft.com/demos/create/2HFZ73WX","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/2HFZ73WX"},{"name":"drag","description":"Disables the drag state of a specific column when `column-drag` enabled on `<zing-grid>`","type":"Boolean","fullName":"zg-column-drag","demoLink":"https://app.zingsoft.com/demos/create/Y3HFXG3D","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"editor","description":"Overrides the default editor for the column.  Can be set to a different built-in editor (based on type of column),\ncustom editor, or `false` to turn off editor.\nIf set to a custom editor, the attribute value should be set to the name of the object.\nSee \"Features\" page on \"Editing: Custom Editor Grid\" for more details on custom editor.","type":"String | function","fullName":"zg-column-editor","demoLink":"https://app.zingsoft.com/demos/create/U9KA82K8","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"columnType\"","\"objectName\"","false"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"editor-template","description":"Points to an external template element to be used as the template for the column's editor","type":"String","fullName":"zg-column-editorTemplate","demoLink":"https://app.zingsoft.com/demos/create/G5FN1ZAB","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/G5FN1ZAB"},{"name":"filter","description":"Overrides the grid level `filter` attribute.  Presence of attribute enables the menu on `filter` column.  Can be set to `inline`, `menu`, `both`, or `disabled`","type":"String | Boolean","fullName":"zg-column-filter","demoLink":"https://app.zingsoft.com/demos/create/MEUDAXS9","default":"\"menu\"","acceptedValues":["Enum"],"displayValues":["\"menu\"","\"inline\"","\"both\"","\"disabled\""],"values":[],"category":"Attribute","tsType":"String | Boolean","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filter-buttons","description":"Comma separated list of buttons to display on the filter menu","type":"String | Array","fullName":"zg-column-filterButtons","demoLink":"https://app.zingsoft.com/demos/create/TUY6XOOT","default":"\"reset, apply\"","acceptedValues":["<comma separated enum list>"],"displayValues":["\"reset\"","\"close\"","\"apply\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/TUY6XOOT"},{"name":"filter-conditions","description":"The list of conditions to present as options in the filter menu condition select.  Use \"break\" to display the horizontal separator.  Use \"default\" to use the built in default.","type":"String","fullName":"zg-column-filterConditions","demoLink":"https://app.zingsoft.com/demos/create/KAENBEQ4","default":"default","acceptedValues":["Enum"],"displayValues":["\"none\"","\"empty\"","\"notEmpty\"","\"equals\"","\"notEquals\"","\"beginsWith\"","\"endsWith\"","\"contains\"","\"notContains\"","\"between\"","\"notBetween\"","\"greaterThan\"","\"greaterEqualThan\"","\"lessThan\"","\"lessEqualThan\"","\"before\"","\"after\"","\"betweenDate\"","\"today\"","\"yesterday\"","\"tomorrow\"","custom filter name","\"break\"","\"default\"","\"trueVal\"","\"falseVal\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filter-conditions-display","description":"Number of conditions to display in the filter menu on menu open","type":"Number","fullName":"zg-column-filterConditionsDisplay","demoLink":"https://app.zingsoft.com/demos/create/YSC0Q3K9","default":"1","acceptedValues":["Number"],"displayValues":["2"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/YSC0Q3K9"},{"name":"filter-conditions-max","description":"Max number of conditions to display in the filter menu","type":"Number","fullName":"zg-column-filterConditionsMax","demoLink":"https://app.zingsoft.com/demos/create/FW97GV9E","default":"1","acceptedValues":["Number"],"displayValues":["5"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/FW97GV9E"},{"name":"filter-default-condition","description":"The condition to initially display on filter menu open","type":"String","fullName":"zg-column-filterDefaultCondition","demoLink":"https://app.zingsoft.com/demos/create/VZ0QTIXU","default":"\"contains\"","acceptedValues":["Enum"],"displayValues":["\"none\"","\"empty\"","\"notEmpty\"","\"equals\"","\"notEquals\"","\"beginsWith\"","\"endsWith\"","\"contains\"","\"notContains\"","\"between\"","\"notBetween\"","\"greaterThan\"","\"greaterEqualThan\"","\"lessThan\"","\"lessEqualThan\"","\"before\"","\"after\"","\"betweenDate\"","\"today\"","\"yesterday\"","\"tomorrow\"","custom filter name"],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filter-index","description":"Sets the data field index to filter on if index itself has multiple fields.  The value set in index is the default.","type":"String","fullName":"zg-column-filterIndex","demoLink":"https://app.zingsoft.com/demos/create/ABCQFCFA","default":"\"\"","acceptedValues":["String"],"displayValues":["\"city\""],"values":[],"category":"Attribute","tsType":"String","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filter-key","description":"Sets the key for server side filtering.  By default the filterKey is set to the filterIndex value.","type":"String","fullName":"zg-column-filterKey","demoLink":"https://app.zingsoft.com/demos/create/5O772NYE","default":"the value of the column's filterIndex","acceptedValues":["String"],"displayValues":["\"full-name\""],"values":[],"category":"Attribute","tsType":"String","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filter-menu-areas","description":"The areas to display in the filter menu.  Can be conditions, selectbox, or both","type":"String","fullName":"zg-column-filterMenuAreas","demoLink":"https://app.zingsoft.com/demos/create/5EBI08WX","default":"\"both\"","acceptedValues":["Enum"],"displayValues":["\"conditions\"","\"selectbox\"","\"both\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filter-on","description":"Determines if the filter comparison should be against the raw values or the rendered\nThis only applies to conditionals in the filter menu.\nFor iframe column type, it is restricted to raw values.\nFor aggregate column type, it is restricted to rendered values.","type":"String","fullName":"zg-column-filterOn","demoLink":"https://app.zingsoft.com/demos/create/KHO0OOE2","default":"\"raw\"","acceptedValues":["Enum"],"displayValues":["\"raw\"","\"rendered\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filter-selectbox-display","description":"Determines if the selectbox in the filter menu should display the values as raw or rendered values.","type":"String","fullName":"zg-column-filterSelectboxDisplay","demoLink":"https://app.zingsoft.com/demos/create/7ZY0ZKY3","default":"\"raw\"","acceptedValues":["Enum"],"displayValues":["\"raw\"","\"rendered\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filter-trigger","description":"Action that fires the filter event from the filter menu.","type":"String","fullName":"zg-column-filterTrigger","demoLink":"https://app.zingsoft.com/demos/create/M0K8WL13","default":"\"button\"","acceptedValues":["Enum"],"displayValues":["\"button\"","\"change\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"filterer","description":"Overrides the default filterer for the column.  Can be set to a different built-in filterer or to a custom filterer<br>\nIf set to a custom filterer, the attribute value should either be set to the object that contains: `init`, `afterInit`, `value`, `setValue`, and `triggerEvent`\nOR it can be set to a function that will be used for the `value` method which will fire on filter change.\nNote that the custom filterer only applies to the inline filter and not the conditions or select box options (filter menu).","type":"function","fullName":"zg-column-filterer","demoLink":"https://app.zingsoft.com/demos/create/VDGE1CV7","default":"","acceptedValues":["String"],"displayValues":["\"myFilterer\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/VDGE1CV7"},{"name":"foot-cell","description":"The aggregate function, tokenized string, or function to evaluate for the foot cell of the column.\nIf using a function, the function takes the parameters `columnData` and `columnFieldIndex`.","type":"String","fullName":"zg-column-footCell","demoLink":"https://app.zingsoft.com/demos/create/MLMKU2EP","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"sum\"","\"avg\"","\"max\"","\"min\"","\"count\"","\"tokenized string\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"Enum | String","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"Attributes moved to \"number\" column to demonstrate [foot-cell] attribute."},{"name":"frozen","description":"Moves the column to the frozen panel specified","type":"String","fullName":"zg-column-frozen","demoLink":"https://app.zingsoft.com/demos/create/7APRNW8H","default":"\"left\"","acceptedValues":["Enum"],"displayValues":["\"left\"","\"right\""],"values":[],"category":"Attribute","tsType":"Enum | String","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"group","description":"Includes the column to the row-group column. To enable features on grouped row columns, set attributes on `ZGColumn[type=\"row-group\"]`.\nAll other attributes on the `[group]` column(s) are ignored.","type":"Boolean","fullName":"zg-column-group","demoLink":"https://app.zingsoft.com/demos/create/1V86Y3OC","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset"},{"name":"group-head-cell","description":"Sets a head cell on the column in the grouped row.","type":"String","fullName":"zg-column-groupHeadCell","demoLink":"https://app.zingsoft.com/demos/create/QF7D4W6G","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"sum\"","\"avg\"","\"max\"","\"min\"","\"count\"","\"tokenized string\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"Enum | String","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/QF7D4W6G"},{"name":"head-cell","description":"The aggregate function to evaluate for the head cell of the column.\nIf using a function, the function takes the parameters `columnData` and `columnFieldIndex`.","type":"String","fullName":"zg-column-headCell","demoLink":"https://app.zingsoft.com/demos/create/2MABJWGE","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"sum\"","\"avg\"","\"max\"","\"min\"","\"count\"","\"tokenized string\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"Enum | String","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"Attributes moved to \"number\" column to demonstrate [head-cell] attribute."},{"name":"header","description":"The header name for the column.   If it is not set, the default is to format the `index` value.","type":"String","fullName":"zg-column-header","demoLink":"https://app.zingsoft.com/demos/create/AHKN3N0A","default":"\"index\"","acceptedValues":["<string>"],"displayValues":["\"My Header\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"header-auto-format","description":"Setting to `disabled` will turn off formatting on the header of the column.  By default, headers will\nconvert camel, dash, or kebab case to a properly spaced and capitalized string.  Or\nset to a function name to customize formatting of header text.  The custom function takes in two parameters,\n`index` and `headerText`, and returns the formatted header text.","type":"String","fullName":"zg-column-headerAutoFormat","demoLink":"https://app.zingsoft.com/demos/create/0QT0ZBDJ","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"disabled\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"Enum | String","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"header-tooltip-action","description":"Sets the execution method of custom 'icon' type tooltips to either activate on hover or click of the icon","type":"String","fullName":"zg-column-headerTooltipAction","demoLink":"https://app.zingsoft.com/demos/create/T5MIH3ZJ","default":"\"hover\"","acceptedValues":["Enum"],"displayValues":["\"click\"","\"hover\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:header-tooltip-text"},{"name":"header-tooltip-delay","description":"Sets the hover delay in milliseconds before displaying the header tooltip","type":"Number","fullName":"zg-column-headerTooltipDelay","demoLink":"https://app.zingsoft.com/demos/create/OWLEJ17A","default":"0","acceptedValues":["Number"],"displayValues":["2000"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:header-tooltip-text"},{"name":"header-tooltip-icon","description":"Specifies the icon to use for the header tooltip trigger icon","type":"String","fullName":"zg-column-headerTooltipIcon","demoLink":"https://app.zingsoft.com/demos/create/DZGNBHVO","default":"info","acceptedValues":["<string>"],"displayValues":["'checkmark'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:header-tooltip-text"},{"name":"header-tooltip-icon-position","description":"Sets the header icon position in the header cells","type":"String","fullName":"zg-column-headerIconPosition","demoLink":"https://app.zingsoft.com/demos/create/5K6K6TNE","default":"\"left\"","acceptedValues":["Enum"],"displayValues":["\"left\"","\"right\"","\"after-text\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:header-icon"},{"name":"header-tooltip-icon-position","description":"Sets the tooltip icon position for the tooltip icon in the header cells","type":"String","fullName":"zg-column-headerTooltipIconPosition","demoLink":"https://app.zingsoft.com/demos/create/3PD1IQ2O","default":"\"right\"","acceptedValues":["Enum"],"displayValues":["\"left\"","\"right\"","\"after-text\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:header-tooltip-text"},{"name":"header-tooltip-position","description":"Sets the tooltip-position for the header cell","type":"String","fullName":"zg-column-headerTooltipPosition","demoLink":"https://app.zingsoft.com/demos/create/W1QE4CKI","default":"\"top\"","acceptedValues":["Enum"],"displayValues":["\"top\"","\"left\"","\"right\"","\"bottom\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:header-tooltip-text"},{"name":"header-tooltip-renderer","description":"Gets the name of the user's custom render function, on window, to use the function's return value as the tooltip content","type":"String","fullName":"zg-column-headerTooltipRenderer","demoLink":"https://app.zingsoft.com/demos/create/SZBBLQ3B","default":"\"\"","acceptedValues":["String"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/SZBBLQ3B"},{"name":"header-tooltip-template","description":"Points to an external template element to be used as the template for the tooltip display","type":"String","fullName":"zg-column-headerTooltipTemplate","demoLink":"https://app.zingsoft.com/demos/create/AEP72BQH","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/AEP72BQH"},{"name":"header-tooltip-text","description":"Sets the tooltip text for the header cell of the column.  Can pass this value to renderer or template if using","type":"String","fullName":"zg-column-headerTooltipText","demoLink":"https://app.zingsoft.com/demos/create/ZNA3E1ZA","default":"\"\"","acceptedValues":["String"],"displayValues":["\"Tooltip Value\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"header-tooltip-trigger","description":"Sets what part of the header triggers the tooltip.  If set to 'icon', an info icon is added to the header.","type":"String","fullName":"zg-column-headerTooltipTrigger","demoLink":"https://app.zingsoft.com/demos/create/IUS7B65M","default":"text","acceptedValues":["Enum"],"displayValues":["\"text\"","\"icon\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:header-tooltip-text"},{"name":"header-tooltip-type","description":"Sets the style to use for the tooltips.  Uses the `default` style by default.  Can set to `system` to match the tooltips used on icons throughout `<zing-grid>`.","type":"String","fullName":"zg-column-headerTooltipType","demoLink":"https://app.zingsoft.com/demos/create/4VUQ8QJO","default":"default","acceptedValues":["Enum"],"displayValues":["\"default\"","\"system\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:header-tooltip-text"},{"name":"headerIcon","description":"Adds an icon next to the header text.","type":"String","fullName":"zg-column-headerIcon","demoLink":"https://app.zingsoft.com/demos/create/KVGW2Y7J","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"outsidearrow\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"hidden","description":"Presence of attribute hides the column","type":"Boolean","fullName":"zg-column-hidden","demoLink":"https://app.zingsoft.com/demos/create/HV082G0U","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"index","description":"A single index or multiple indices (separated by comma), to associate information in the data source\n to a column in the grid.  Nested data keys are referenced by the member character `.` (Ex. data.key).","type":"String","fullName":"zg-column-index","demoLink":"https://app.zingsoft.com/demos/create/9NCUR9F6","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"recordkey\"","\"key1\"","\"object.key1\"","\"key1, key2, keyN\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"locale","description":"Localization code used with column type `currency` and `number`","type":"String","fullName":"zg-column-locale","demoLink":"https://app.zingsoft.com/demos/create/OVT2NU0P","default":"\"en-us\"","acceptedValues":["<string>"],"displayValues":["\"de-De\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:currency"},{"name":"menu-text","description":"The text to display in the control menu for the column.  If it is not set, it is set to the header text.","type":"String","fullName":"zg-column-menuText","demoLink":"https://app.zingsoft.com/demos/create/2IVY5RXA","default":"\"index\"","acceptedValues":["<string>"],"displayValues":["\"My Header\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"min-width","description":"Sets the minimum width of the column in pixels","type":"Number","fullName":"zg-column-minWidth","demoLink":"https://app.zingsoft.com/demos/create/LBHD4C38","default":"n/a","acceptedValues":["Number"],"displayValues":["150"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"renderer","description":"Overrides the default renderer for the column.  Can be set to a different built-in or custom renderer.\nTo use a custom renderer, the attribute should be set to the name of the function.\nThe renderer function takes in the following arguments, `value of index` (for each index), `domCell`, and `cellObject`.\nThe returned value of the renderer function is set as the innerHTML of the cell.","type":"String","fullName":"zg-column-renderer","demoLink":"https://app.zingsoft.com/demos/create/K23DK1S3","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/K23DK1S3","storyControl":"select","storyOptions":"appendHelloWorld, upperCase"},{"name":"renderer-template","description":"Points to an external template element to be used as the template for the column's renderer","type":"String","fullName":"zg-column-rendererTemplate","demoLink":"https://app.zingsoft.com/demos/create/XFAAAWV8","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/XFAAAWV8"},{"name":"required","description":"Indicates that the column is required to have a value on edit","type":"Boolean","fullName":"zg-column-required","demoLink":"https://app.zingsoft.com/demos/create/XUPF06BF","default":"{\"type\":\"\",\"bReflectToAttribute\":true,\"mapping\":\"bRequired\"}","acceptedValues":["Boolean"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"resizable","description":"Turns on column resizing for single column.  Set to `disabled` to turn off resizing on a single column.","type":"String","fullName":"zg-column-resizable","demoLink":"https://app.zingsoft.com/demos/create/0JT243X2","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"resizable-max-width","description":"Sets the maximum width the column can be set to when resizing","type":"Number","fullName":"zg-column-resizableMaxWidth","demoLink":"https://app.zingsoft.com/demos/create/NAAVS052","default":"n/a","acceptedValues":["Number"],"displayValues":["150"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"resizable-min-width","description":"Sets the minimum width the column can be set to when resizing","type":"Number","fullName":"zg-column-resizableMinWidth","demoLink":"https://app.zingsoft.com/demos/create/QL1FNFJA","default":"n/a","acceptedValues":["Number"],"displayValues":["150"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"resizablePersistent","description":"Modifies the default column resizable persistence.  Set to `disabled` to turn off persistence on a single column.","type":"Boolean","fullName":"zg-column-resizablePersistent","demoLink":"","default":"","acceptedValues":"","displayValues":"","values":[],"category":"Attribute","tsType":"","internalDocs":""},{"name":"search","description":"Turns off the search on a column if `search` is present on `<zing-grid>`","type":"String","fullName":"zg-column-search","demoLink":"https://app.zingsoft.com/demos/create/CLWPU7EF","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"separator","description":"If multiple indices are set, this is the string that separates them in the display.  By default, it is a comma.","type":"String","fullName":"zg-column-separator","demoLink":"https://app.zingsoft.com/demos/create/CPPYOYHM","default":"\",\"","acceptedValues":["<string>"],"displayValues":["\"-\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"sort","description":"Turns off the sort on a column if `sort` is present on `<zing-grid>`","type":"String","fullName":"zg-column-sort","demoLink":"http://app.zingsoft.com/demos/create/P8AYYNEK","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"sort-asc","description":"Presence of attribute sorts the column data in ascending order","type":"Boolean","fullName":"zg-column-sortAsc","demoLink":"https://app.zingsoft.com/demos/create/7YFFO3N2","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"sort-desc","description":"Presence of attribute sorts the column data in descending order","type":"Boolean","fullName":"zg-column-sortDesc","demoLink":"https://app.zingsoft.com/demos/create/7YFFO3N2","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"sort-intl","description":"Overrides default behavior for setting special sort for international data","type":"String","fullName":"zg-column-sortIntl","demoLink":"https://app.zingsoft.com/demos/create/420MNZQE","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"sorter","description":"Overrides the default sorter for the column.  It is also possible to override the column sorting by\npassing in method name of sort function instead or setting to `disabled` to disable sorting.  Sorter function\ntakes in two values (a, b) and returns 1, -1, or 0 indicating if `a > b`, `a < b`, or `a = b`.\nCan also be set to a path in the dataset to perform the sort on.  This is useful for sorting object indices.","type":"String","fullName":"zg-column-sorter","demoLink":"https://app.zingsoft.com/demos/create/AWR08X5U","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/AWR08X5U"},{"name":"type","description":"The type of the data stored in the column.  The column renderer/editor will behave based on the column type.","type":"String","fullName":"zg-column-type","demoLink":"https://app.zingsoft.com/demos/create/X5U3C30T","default":"\"\"","acceptedValues":["Enum"],"displayValues":["aggregate","boolean","button","checkbox","color","currency","custom","date","duplicate","editor","element","email","emoji","icon","image","iframe","number","password","percentage","radio","range","remover","row-group","row-number","select","selector","tel","text","toggle","url"],"values":[{"name":"aggregate","parent":"type","description":"Will render a column containing the aggregate value of each row.\nSpecify aggregate calculation with `[typeAggregateValue]` to return the aggregate of columns and rows.\nWhen `[footCell]` or `[headCell]` is set without `[typeAggregateValue]` to return the aggregate of all numeric value grid cells.","demoLink":"https://app.zingsoft.com/demos/create/SOZ74HE2","relatedAttributes":["\"foot-cell\" "," \"head-cell\" "," \"type-aggregate-omit\" "," \"type-aggregate-value\""],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-aggregate","category":"Attribute Value","version":"1.x.x"},{"name":"boolean","parent":"type","description":"Will render a true|false string value and the editor will use an input field with `type=\"checkbox\"`","demoLink":"https://app.zingsoft.com/demos/create/WVMQ2TLY","relatedAttributes":["\"type-button-disabled\" "," \"type-button-handler\" "," \"type-button-icon\" "," \"type-button-label\" "," \"type-button-url\""],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-boolean","category":"Attribute Value","version":"1.x.x"},{"name":"button","parent":"type","description":"Will render a button and the editor is disabled","demoLink":"https://app.zingsoft.com/demos/create/WON8GGGE","relatedAttributes":["\"type-checkbox-label\""],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-button","category":"Attribute Value","version":"1.x.x"},{"name":"checkbox","parent":"type","description":"Will render a checkbox that can be toggled","demoLink":"https://app.zingsoft.com/demos/create/NP9MOB3X","relatedAttributes":["\"type-color-mode\" "," \"type-color-preview\" "," \"type-color-spaces\""],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-checkbox","category":"Attribute Value","version":"1.x.x"},{"name":"color","parent":"type","description":"Will render a preview of the color and display a color picker when editing the cell","demoLink":"https://app.zingsoft.com/demos/create/GUKBYSNL","relatedAttributes":["\"type-currency\""],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-color","category":"Attribute Value","version":"1.x.x"},{"name":"currency","parent":"type","description":"Will render the currency symbol in front of the number and the editor will use an input field with `type=\"number\"`","demoLink":"https://app.zingsoft.com/demos/create/4OED8YTD","relatedAttributes":["\"type-date-format\" "," \"type-date-from-now\""],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-currency","category":"Attribute Value","version":"1.x.x"},{"name":"custom","parent":"type","description":"Will slot in column content and allow referencing data via `[[index.key]]` or `[[record.key]]`, and the editor will\nuse an input field with `type=\"text\"`","demoLink":"https://app.zingsoft.com/demos/create/P28LLZB3","relatedAttributes":["\"type-element-attribute-name\" "," \"type-element-tag-name\""],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-custom","category":"Attribute Value","version":"1.x.x"},{"name":"date","parent":"type","description":"Will render the date as a string value and the editor will use an input field with `type=\"date\"` expecting (dd/mm/yyyy) dates","demoLink":"https://app.zingsoft.com/demos/create/GAD4MV77","relatedAttributes":["\"type-emoji-shortcode\""],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-date","category":"Attribute Value","version":"1.x.x"},{"name":"duplicate","parent":"type","description":"A render only field to display an icon to duplicate the record on click.","demoLink":"https://app.zingsoft.com/demos/create/GL8UZ46G","relatedAttributes":["type-image-alt "," type-image-mask "," type-image-src "," type-content-width"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-duplicate","category":"Attribute Value","version":"1.x.x"},{"name":"editor","parent":"type","description":"A render only field to display an icon to edit the record on click","demoLink":"https://app.zingsoft.com/demos/create/10160WKK","relatedAttributes":["type-iframe-ratio "," width "," type-content-width"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-editor","category":"Attribute Value","version":"1.x.x"},{"name":"element","parent":"type","description":"Will wrap cell content with value specified in `[type-element-tag-name]` with the attribute specified in `[type-element-attribute-name]`","demoLink":"https://app.zingsoft.com/demos/create/4NJN81PT","relatedAttributes":["type-number-formatting "," type-number-decimals "," type-number-min-decimals "," type-number-max-decimals"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-element","category":"Attribute Value","version":"1.x.x"},{"name":"email","parent":"type","description":"Will render a string value and the editor will use an input field with `type=\"email\"`","demoLink":"https://app.zingsoft.com/demos/create/TIFDQ7IR","relatedAttributes":["type-percentage-decimals "," type-percentage-max-decimals "," type-percentage-min-decimals"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-email","category":"Attribute Value","version":"1.x.x"},{"name":"emoji","parent":"type","description":"Will render a string value that contains emojis in codepoint format","demoLink":"https://app.zingsoft.com/demos/create/W06CXMUH","relatedAttributes":["type-radio-options"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-emoji","category":"Attribute Value","version":"1.x.x"},{"name":"icon","parent":"type","description":"A render only field to set icon to convert the cell data into a built-in grid `<zg-icon name=\"\">` element. \nBy default, the value must match the name of a native grid icon or the name of a custom icon. Editing will use an input field with `type=\"text\"`.","demoLink":"https://app.zingsoft.com/demos/create/E1DSLU0F","relatedAttributes":["type-range-min "," type-range-max "," type-range-step"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-icon","category":"Attribute Value","version":"1.x.x"},{"name":"image","parent":"type","description":"Will render an `<img>` and the editor will use an input field with `type=\"text\"`.","demoLink":"https://app.zingsoft.com/demos/create/4UDK0NSQ","relatedAttributes":["type-group-hide-count "," type-group-plural"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-image","category":"Attribute Value","version":"1.x.x"},{"name":"iframe","parent":"type","description":"A render only field to display an `<iframe>`. Editing will use an input field with `type=\"text\"`.","demoLink":"https://app.zingsoft.com/demos/create/34C2S6GH","relatedAttributes":["type-select-options "," type-select-multiple"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-iframe","category":"Attribute Value","version":"1.x.x"},{"name":"number","parent":"type","description":"Will render a number as a thousand's separated string value and the editor will use an input field with `type=\"number\"`.","demoLink":"https://app.zingsoft.com/demos/create/GYTT7C5T","relatedAttributes":["type-toggle-options "," type-toggle-render-value"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-number","category":"Attribute Value","version":"1.x.x"},{"name":"password","parent":"type","description":"Will render a hidden string value and the editor will use an input field with `type=\"password\"`.","demoLink":"https://app.zingsoft.com/demos/create/7JAJYANQ","relatedAttributes":["type-url-icon "," type-url-src "," type-url-target "," type-url-text"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-password","category":"Attribute Value","version":"1.x.x"},{"name":"percentage","parent":"type","description":"Will render a number as a percentage string value and the editor will use an input field with `type=\"number\"`.","demoLink":"https://app.zingsoft.com/demos/create/UGOV12S9","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-percentage","category":"Attribute Value","version":"1.x.x"},{"name":"radio","parent":"type","description":"Will render selected option in cell and the editor will use an radio options specified in `typeRadioOptions`.","demoLink":"https://app.zingsoft.com/demos/create/41C9I817","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-radio","category":"Attribute Value","version":"1.x.x"},{"name":"range","parent":"type","description":"Will render a number as a thousand's separated string value and the editor will use an input field with `type=\"number\"` with optional `min`, `max` and `step` fields defined on the input.","demoLink":"https://app.zingsoft.com/demos/create/NZ8M6C7F","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-range","category":"Attribute Value","version":"1.x.x"},{"name":"remover","parent":"type","description":"A render only field to display an icon to remove the record on click.","demoLink":"https://app.zingsoft.com/demos/create/P4LOOU84","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-remover","category":"Attribute Value","version":"1.x.x"},{"name":"row-group","parent":"type","description":"A render only field to display the row grouping.","demoLink":"https://app.zingsoft.com/demos/create/SBQXB3FA","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-row-group","category":"Attribute Value","version":"1.x.x"},{"name":"row-number","parent":"type","description":"A render only field to display the current row index of this row.","demoLink":"https://app.zingsoft.com/demos/create/VHUXFZWI","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-row-number","category":"Attribute Value","version":"1.x.x"},{"name":"select","parent":"type","description":"Will render a string value and the editor will use an input field with `type=\"select\"`.","demoLink":"https://app.zingsoft.com/demos/create/AKU9D36H","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-select","category":"Attribute Value","version":"1.x.x"},{"name":"selector","parent":"type","description":"A render only field to display an checkbox to selector and remove the record on click.","demoLink":"https://app.zingsoft.com/demos/create/P4LOOU84","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-selector","category":"Attribute Value","version":"1.x.x"},{"name":"tel","parent":"type","description":"Will render a string value and the editor will use an input field with `type=\"tel\"`.","demoLink":"https://app.zingsoft.com/demos/create/WE4LV399","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-tel","category":"Attribute Value","version":"1.x.x"},{"name":"text","parent":"type","description":"(Default Type) Sets the column type to text.","demoLink":"https://app.zingsoft.com/demos/create/G4EHPS60","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-text","category":"Attribute Value","version":"1.x.x"},{"name":"toggle","parent":"type","description":"N/A","demoLink":"https://app.zingsoft.com/demos/create/WCKUIDRK","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-toggle","category":"Attribute Value","version":"1.x.x"},{"name":"url","parent":"type","description":"Will render the field to to display an `<a>` tag. The editor will use an input field with `type=\"text\"`.","demoLink":"https://app.zingsoft.com/demos/create/1SHDQ5JV","relatedAttributes":[],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-column","fullName":"zg-column-type-url","category":"Attribute Value","version":"1.x.x"}],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset"},{"name":"type-aggregate-omit","description":"Presence of attribute ignores the column in aggregation calculations","type":"Boolean","fullName":"zg-column-typeAggregateOmit","demoLink":"https://app.zingsoft.com/demos/create/SK9EPCZS","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:aggregate"},{"name":"type-aggregate-value","description":"The token or aggregate value to use to display if the column is an aggregation column","type":"String","fullName":"zg-column-typeAggregateValue","demoLink":"https://app.zingsoft.com/demos/create/093GV5N3","default":"undefined","acceptedValues":["<string>"],"displayValues":["\"sum\"","\"avg\"","\"max\"","\"min\"","\"count\"","\"tokenized string\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"Enum | String","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:aggregate"},{"name":"type-button-disabled","description":"Presence of attribute sets the button to be in a disabled state. Can also set to \"true\" or \"false\".","type":"Boolean","fullName":"zg-column-typeButtonDisabled","demoLink":"https://app.zingsoft.com/demos/create/IX3EMQE5","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:button"},{"name":"type-button-handler","description":"When the column type is set to `button`, use `typeButtonHander` to hook up a function call to the button click.\nCallback receives rowData, zg-cell DOM, and zg-cell object as arguments.","type":"String","fullName":"zg-column-typeButtonHandler","demoLink":"https://app.zingsoft.com/demos/create/5KOTS7K4","default":"undefined","acceptedValues":["<string>"],"displayValues":["'buttonClick'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/5KOTS7K4"},{"name":"type-button-icon","description":"When the column type is set to `button`, use `typeButtonIcon` to add an icon next to the rendered button in the cell","type":"String","fullName":"zg-column-typeButtonIcon","demoLink":"https://app.zingsoft.com/demos/create/OZWC8PUN","default":"undefined","acceptedValues":["<string>"],"displayValues":["'checkmark'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:button"},{"name":"type-button-label","description":"When the column type is set to `button`, use `typeButtonLabel` to add a label to the rendered button in the cell","type":"String","fullName":"zg-column-typeButtonLabel","demoLink":"https://app.zingsoft.com/demos/create/PW4V2ETW","default":"undefined","acceptedValues":["<string>"],"displayValues":["'Label'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:button"},{"name":"type-button-tooltip","description":"When the column type is set to `button`, use `typeButtonTooltip` to add a tooltip to the rendered button in the cell","type":"String","fullName":"zg-column-typeButtonTooltip","demoLink":"https://app.zingsoft.com/demos/create/AQ5I7JP2","default":"undefined","acceptedValues":["<string>"],"displayValues":["'Tooltip'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"type-button-url","description":"When the column type is set to `button`, use `typeButtonURL` to add a shortcut handler on button click.  The click will automatically open the url in a new window.","type":"String","fullName":"zg-column-typeButtonUrl","demoLink":"https://app.zingsoft.com/demos/create/NDETJCG1","default":"undefined","acceptedValues":["<string>"],"displayValues":["'https://www.example.com/'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:button"},{"name":"type-checkbox-label","description":"When the column type is set to `checkbox`, use `typeCheckboxLabel` to add a label next to the rendered checkbox in the cell","type":"String","fullName":"zg-column-typeCheckboxLabel","demoLink":"https://app.zingsoft.com/demos/create/NP9MOB3X","default":"undefined","acceptedValues":["<string>"],"displayValues":["'Label'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:checkbox"},{"name":"type-color-mode","description":"Sets the color mode to configure the color picker. Choose between HSL, RGBA, and the default Hex.","type":"String","fullName":"zg-column-typeColorMode","demoLink":"","default":"\"hex\"","acceptedValues":["<string>"],"displayValues":["\"color: #ff9900;\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:color"},{"name":"type-color-preview","description":"Disable the default color swatch UI preview with a false value.","type":"Boolean","fullName":"zg-column-typeColorPreview","demoLink":"","default":"true","acceptedValues":["<boolean>"],"displayValues":["\"\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:color"},{"name":"type-color-spaces","description":"By default, spaces are added into the color when in RGB or HSL mode.  Turn the spaces off by setting to `disabled`","type":"String","fullName":"zg-column-typeColorSpaces","demoLink":"","default":"true","acceptedValues":["disabled"],"displayValues":["\"\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:color"},{"name":"type-currency","description":"The currency to be used in currency formatting.\nCurrency is set using using the 3 letter currency code specified by ISO 4217 specification (https://en.wikipedia.org/wiki/ISO_4217)","type":"String","fullName":"zg-column-typeCurrency","demoLink":"https://app.zingsoft.com/demos/create/GFES04TQ","default":"\"USD\" | \"EUR\"","acceptedValues":["<string>"],"displayValues":"","values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:currency"},{"name":"type-date-format","description":"The tokenized formatting for a date column","type":"String","fullName":"zg-column-typeDateFormat","demoLink":"https://app.zingsoft.com/demos/create/CO0KH0B8","default":"Browser Default based on locale","acceptedValues":["<string>"],"displayValues":["\"dddd, MMMM Do YYYY\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:date"},{"name":"type-date-from-now","description":"Indicates if date should be displayed in FromNow format","type":"Boolean","fullName":"zg-column-typeDateFromNow","demoLink":"https://app.zingsoft.com/demos/create/IAGMQ14H","default":"n/a","acceptedValues":["<boolean>"],"displayValues":["n/a"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:date"},{"name":"type-element-attribute-name","description":"Sets the attribute of the custom-element in the column when `<zg-column>` has `type` set to `element`","type":"String","fullName":"zg-column-typeElementAttributeName","demoLink":"https://app.zingsoft.com/demos/create/LNADIAME","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"attributeName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/LNADIAME"},{"name":"type-element-tag-name","description":"Sets the tag to wrap content when `<zg-column>` has `type` set to `element`.\nIf `type-element-attribute-name` isn't set, it will put the rendered data into the body of the element.\nIf `type-element-attribute-name` is set, it will set the attribute to the indexed value.","type":"String","fullName":"zg-column-typeElementTagName","demoLink":"https://app.zingsoft.com/demos/create/ATEG1H8V","default":"\"\"","acceptedValues":["<string>"],"displayValues":"","values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/ATEG1H8V"},{"name":"type-emoji-shortcode","description":"Set to function to convert shortcodes to emojis","type":"String","fullName":"zg-column-typeEmojiShortcode","demoLink":"https://app.zingsoft.com/demos/create/08MRBQOM","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"shortcodeConverter\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/08MRBQOM"},{"name":"type-group-hide-count","description":"Presence of the attribute disables the display of the row count on the row-group column","type":"Boolean","fullName":"zg-column-typeGroupHideCount","demoLink":"https://app.zingsoft.com/demos/create/VKCXNCU6","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:row-group"},{"name":"type-group-plural","description":"Indicates the word to use if the count is plural or singular.  Comma separated with singular first.\nThe word can be referenced by the token `group.plural` and is used in a renderer or template.","type":"String","fullName":"zg-column-typeGroupPlural","demoLink":"https://app.zingsoft.com/demos/create/99NOEJ3E","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"person,people\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:row-group"},{"name":"type-iframe-ratio","description":"Sets a `square` ratio instead of the default `16:9`","type":"String","fullName":"zg-column-typeIframeRatio","demoLink":"https://app.zingsoft.com/demos/create/CMXG73AF","default":"'square'","acceptedValues":["<string>"],"displayValues":["\"square\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:iframe"},{"name":"type-image-alt","description":"The alternative text used with the `image` type column","type":"String","fullName":"zg-column-typeImageAlt","demoLink":"https://app.zingsoft.com/demos/create/E77C24KU","default":"Full Image URL","acceptedValues":["<string>"],"displayValues":["\"Logo\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:image"},{"name":"type-image-mask","description":"The alternative shape to mask the image","type":"String","fullName":"zg-column-typeImageMask","demoLink":"https://app.zingsoft.com/demos/create/LXCGPDZD","default":"N/A","acceptedValues":["<string>"],"displayValues":["\"circle\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:image"},{"name":"type-image-src","description":"If the column type is `image`, use the `type-image-src` attribute to set the src for the image.  The src will be the index value by default.","type":"String","fullName":"zg-column-typeImageSrc","demoLink":"https://app.zingsoft.com/demos/create/5A1UF54Z","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"https://www.example.com/[[index.shortImg]]\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"dataset:type:image"},{"name":"type-number-decimals","description":"Indicates the exact numbers to display after the decimal","type":"Number","fullName":"zg-column-typeNumberDecimals","demoLink":"https://app.zingsoft.com/demos/create/85JDYLP2","default":"{\"bReflectToAttribute\":true,\"type\":\"\",\"mapping\":\"nTypeNumberDecimals\",\"bRefreshContent\":true}","acceptedValues":["<number>"],"displayValues":["2"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:number"},{"name":"type-number-formatting","description":"Set to \"disabled\" to turn off default number formatting","type":"String","fullName":"zg-column-typeNumberFormatting","demoLink":"https://app.zingsoft.com/demos/create/LCOCD7Z5","default":"{\"bReflectToAttribute\":true,\"type\":\"\",\"mapping\":\"sTypeNumberFormatting\",\"bRefreshContent\":true}","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:number"},{"name":"type-number-max-decimals","description":"Indicates the maximum numbers to display after the decimal","type":"Number","fullName":"zg-column-typeNumberMaxDecimals","demoLink":"https://app.zingsoft.com/demos/create/85JDYLP2","default":"{\"bReflectToAttribute\":true,\"type\":\"\",\"mapping\":\"nTypeNumberMaxDecimals\",\"bRefreshContent\":true}","acceptedValues":["<number>"],"displayValues":["2"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:number"},{"name":"type-number-min-decimals","description":"Indicates the minimum numbers to display after the decimal","type":"Number","fullName":"zg-column-typeNumberMinDecimals","demoLink":"https://app.zingsoft.com/demos/create/85JDYLP2","default":"{\"bReflectToAttribute\":true,\"type\":\"\",\"mapping\":\"nTypeNumberMinDecimals\",\"bRefreshContent\":true}","acceptedValues":["<number>"],"displayValues":["2"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:number"},{"name":"type-radio-options","description":"When the column type is set to `radio`, use `typeRadioOptions` to add rendered radio options in the cell.\nCan also set as array of name/value pairs where the name is displayed for the given value","type":"Array | String","fullName":"zg-column-typeRadioOptions","demoLink":"https://app.zingsoft.com/demos/create/41C9I817","default":"undefined","acceptedValues":["<string","array>"],"displayValues":["'one,two,three'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:radio"},{"name":"type-range-max","description":"Maximum value for the input box. Used with the `range` type column in edit mode.","type":"Number","fullName":"zg-column-typeRangeMax","demoLink":"https://app.zingsoft.com/demos/create/X7FZSCAS","default":"100","acceptedValues":["<number>"],"displayValues":["150"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:range"},{"name":"type-range-min","description":"Minimum value for the input box.  Used with `range` type column in edit mode.","type":"Number","fullName":"zg-column-typeRangeMin","demoLink":"https://app.zingsoft.com/demos/create/S4IQMYFF","default":"0","acceptedValues":["<number>"],"displayValues":["100"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:range"},{"name":"type-range-step","description":"Specifies the step between each legal value for the input box.  Used with `range` type column in edit mode.","type":"Number","fullName":"zg-column-typeRangeStep","demoLink":"https://app.zingsoft.com/demos/create/0DBR208U","default":"1","acceptedValues":["<number>"],"displayValues":["20"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:range"},{"name":"type-select-default-value","description":"The default value of a new record.  The select box in the create record will default to the specified value.","type":"String","fullName":"zg-column-typeSelectDefaultValue","demoLink":"https://app.zingsoft.com/demos/create/0E6JVOFK","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"M\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:select"},{"name":"type-select-multiple","description":"In edit mode, presence of attribute allows column type `select` to have multiple selections, instead of the default\nof a single selection","type":"Boolean","fullName":"zg-column-typeSelectMultiple","demoLink":"https://app.zingsoft.com/demos/create/0OP35J9R","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:select"},{"name":"type-select-options","description":"To set the options for the select box for a `select` column when `editor` is enabled on `<zing-grid>`.\nCan also set as array of name/value pairs where the name is displayed for the given value","type":"String | Array","fullName":"zg-column-typeSelectOptions","demoLink":"https://app.zingsoft.com/demos/create/0OP35J9R","default":"\"\"","acceptedValues":["<comma separated string list>"],"displayValues":["\"M, T, W, Th, F\"","[{\"name\": \"Monday\", \"value\": \"M\"}, {\"name\": \"Tuesday\", \"value\": \"T\"}, {\"name\": \"Wednesday\", \"value\": \"W\"}, {\"name\": \"Thursday\", \"value\": \"Th\"}, {\"name\": \"Friday\", \"value\": \"F\"}]"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:select"},{"name":"type-selector-page-persist","description":"Keeps the selected rows selected even on page change.  This means that rows can be selected and not on the current page.","type":"Boolean","fullName":"zg-column-typeSelectorPagePersist","demoLink":"https://app.zingsoft.com/demos/create/9T4P7ZG5","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"2.x.x"},{"name":"type-toggle-options","description":"When the column type is set to `toggle`, use `typeToggleOptions` to set the list of options for the display.","type":"Array","fullName":"zg-column-typeToggleOptions","demoLink":"https://app.zingsoft.com/demos/create/BWSBRL9C","default":"[]","acceptedValues":["<Array>"],"displayValues":["[\"red\", \"orange\", \"yellow\", \"green\", \"blue\"]"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:toggle"},{"name":"type-toggle-render-value","description":"When the column type is set, the render and value will be the same.  This prevents the default creating of true/false for toggles.","type":"Boolean","fullName":"zg-column-typeToggleRenderValue","demoLink":"https://app.zingsoft.com/demos/create/W88ROFBK","default":"false","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/W88ROFBK"},{"name":"type-url-icon","description":"If the column type is `url`, use this attribute to reference any `<zg-icon>` within the library\nto replace the link text with this icon.","type":"String","fullName":"zg-column-typeUrlIcon","demoLink":"https://app.zingsoft.com/demos/create/51XKWSN3","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"link\"","\"outsidearrow\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:url"},{"name":"type-url-src","description":"If the column type is `url`, use the `type-url-src` attribute to set the src for the link.  The link will be the index value by default.","type":"String","fullName":"zg-column-typeUrlSrc","demoLink":"https://app.zingsoft.com/demos/create/9H6VZVVU","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"https://www.example.com/?searchfor=[[index.id]]\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:url"},{"name":"type-url-target","description":"If the column type is `url`, use this attribute to set the target window of the click.  \nUses the same values as HTML `<a>` `[target]` attribute.  `_blank` by default","type":"String","fullName":"zg-column-typeUrlTarget","demoLink":"https://app.zingsoft.com/demos/create/9EJ6RLKQ","default":"\"_blank\"","acceptedValues":["String"],"displayValues":["\"_self\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:url"},{"name":"type-url-text","description":"If the column type is `url`, use the `type-url-text` attribute to set the text displayed for the link.","type":"String","fullName":"zg-column-typeUrlText","demoLink":"https://app.zingsoft.com/demos/create/Z3WKG5XL","default":"\"\"","acceptedValues":["<string>","<unicode characters>"],"displayValues":["\"Go to site\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:type:url"},{"name":"validation-error-message","description":"Sets the validation error message for the column.  Overrides any other settings.","type":"String","fullName":"zg-column-validationErrorMessage","demoLink":"https://app.zingsoft.com/demos/create/B6KISBZ0","default":"N/A","acceptedValues":["<string>"],"displayValues":["\"Please provide valid input.\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:validator"},{"name":"validation-required-message","description":"Sets the validation required message for the column.  Overrides any other settings.","type":"String","fullName":"zg-column-validationRequiredMessage","demoLink":"https://app.zingsoft.com/demos/create/0247YIAM","default":"N/A","acceptedValues":["<string>"],"displayValues":["\"This field is required\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x","storyAlert":"recommend:validator"},{"name":"validator","description":"Sets the validation method for the column.  Overrides the default for the column type","type":"String | function","fullName":"zg-column-validator","demoLink":"https://app.zingsoft.com/demos/create/VYY009C8","default":"N/A","acceptedValues":["<string>"],"displayValues":["\"number\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"visibility-priority","description":"Used in the case of automatically removing columns on resize.  Columns without a `visibility-priority` never\ngets removed. The rest of the columns are removed from highest `visibility-priority` value to the lowest.","type":"Number","fullName":"zg-column-visibilityPriority","demoLink":"https://app.zingsoft.com/demos/create/HMLS88C7","default":"\"\"","acceptedValues":["<number>"],"displayValues":["2"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-column","version":"1.x.x"},{"name":"width","description":"Sets the width of the column.","type":"String | Number","fullName":"zg-column-width","demoLink":"https://app.zingsoft.com/demos/create/L0JW9BEW","default":"fit","acceptedValues":["Enum","<string pixel value>"],"displayValues":["\"fit\"","\"fitheader\"","\"fitcontent\"","\"stretch\"","\"10%\"","\"150px\"","150","min-content","max-content"],"values":[],"category":"Attribute","tsType":"Enum | String | Number","internalDocs":"","tagName":"zg-column","version":"1.x.x"}]},"ZGColumnResize":{"elementDescription":"The column resize handle appears when hovering over header to\nresize the column.","parentComponent":[{"name":"ZGHeadCell","type":["Generated"]}],"cssParts":[{"name":"handle","description":"The resize handle container"},{"name":"icon","description":"The resize icon"}],"storyExample":"<zing-grid column-resizable column-resizable-persistent {{data}}></zing-grid>","members":[]},"ZGControlBar":{"elementDescription":"The `<zg-control-bar>` is inserted dynamically by the ZingGrid library\nand serves as a container for the grid's interface controls.  As a generated element, developers\nshould not manually place `<zg-control-bar>` in their grid; however, they may style the bar and\nits internal elements using CSS.","parentComponent":[{"name":"ZGHeader","type":["Generated"]}],"childComponent":[{"name":"ZGLayoutControls","type":["Generated"]},{"name":"ZGSeparator","type":["Generated"]}],"cssParts":[{"name":"control-bar","description":"Control-bar container."},{"name":"card-action","description":"Container for the card action controls."},{"name":"row-action","description":"Container for the row action controls."},{"name":"batch-message","description":"Container for the batch editing status message."},{"name":"layout","description":"Container for the layout controls."}],"storyExample":"<zing-grid layout-controls preserve-state-id=\"storybookGridState\" preserve-state-options=\"layout\" {{data}}></zing-grid>","members":[]},"ZGData":{"elementDescription":"The `<zg-data>` tag is used to associate a dataset with the actual grid.  \nA top-level attribute is placed on `<zing-grid>` for basic cases, but when more fine grain \ncontrol is required, `<zg-data>`should be employed and various configuration values set via the \n`options` attribute, or more appropriately via `<zg-param>` tags nested within the tag.","parentComponent":[{"name":"ZingGrid","type":["Manual"]}],"childComponent":[{"name":"ZGParam","type":["Manual"]}],"slots":[{"name":"","description":"Data content that only accepts data configuration options (ZGParams)."}],"storyAlert":"true","storyExample":"<zing-grid>\n  <zg-data\n    {{args}}>\n  </zg-data>\n</zing-grid>","members":[{"name":"adapter","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().","type":"String","fullName":"zg-data-adapter","demoLink":"https://app.zingsoft.com/demos/create/36KGT9LR","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"firebase\"","\"graphql\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-data","version":"1.x.x"},{"name":"data","description":"Data for the grid presented as an array or object.  If set as an attribute value, the\ndata needs to be in JSON format.","type":"Object","fullName":"zg-data-data","demoLink":"https://app.zingsoft.com/demos/create/BXPENKMP","default":"\"\"","acceptedValues":["<array","object>"],"displayValues":["[{\"firstName\": \"John\", \"lastName\": \"Doe\"}]"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-data","version":"1.x.x"},{"name":"id-key","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.","type":"String","fullName":"zg-data-idKey","demoLink":"https://app.zingsoft.com/demos/create/NKCF2H81","default":"\"id\"","acceptedValues":["<string>"],"displayValues":["\"state\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-data","version":"1.x.x"},{"name":"options","description":"Used to set `<zg-param>`, the configuration data for `<zg-data>`.  This should never be used directly as an attribute and\nis meant for object instantiation and for setting in JavaScript.","type":"Object","fullName":"zg-data-options","demoLink":"https://app.zingsoft.com/demos/create/9AODYVJT","default":"{}","acceptedValues":["<object>"],"displayValues":["{\"idKey\":\"state\",\"sortDirKey\":\"_order\",\"sortDir\":\"desc\",\"sortByKey\":\"_sort\",\"sortBy\":\"capital\",\"src\":\"https://zinggrid-named.firebaseio.com/\"}"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-data","version":"1.x.x"},{"name":"src","description":"Specifies the absolute or relative URL to fetch data from to populate the grid","type":"String","fullName":"zg-data-src","demoLink":"https://app.zingsoft.com/demos/create/R2K22X2Q","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"https://url-to-your-api\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-data","version":"1.x.x"}]},"ZGDialog":{"elementDescription":"The `<zg-dialog>` tag is used internally for dialogs used by \nCRUD (Create, Read, Update, and Delete) actions, as well as to\nallow for custom dialogs to be created for generic use with the grid.  The design goal of the\ncustom element is to extend HTML's `<dialog>` element for a consistent style and more data grid-\nrelated duties.","parentComponent":[{"name":"ZingGrid","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGButton","type":["Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGText","type":["Manual"]}],"cssParts":[{"name":"dialog","description":"Dialog mask or overlay."},{"name":"form","description":"Dialog form consisting of header, body, and footer."},{"name":"header","description":"Dialog header consisting of header label and close button."},{"name":"header-label","description":"Dialog header label."},{"name":"header-close","description":"Dialog header close button."},{"name":"body","description":"Dialog body."},{"name":"body-error","description":"Dialog error message that appears top of dialog body."},{"name":"body-content-wrapper","description":"Dialog content wrapper that wraps around editor labels and inputs."},{"name":"footer","description":"Dialog footer consisting of footer buttons (cancel and confirm)."},{"name":"footer-cancel","description":"Dialog footer cancel button."},{"name":"footer-confirm","description":"Dialog footer confirm button."}],"slots":[{"name":"","description":"Dialog body content."}],"storyAlert":"true","storyExample":"<zing-grid storybook-dialog dialog {{data}}>\n  <zg-dialog type=\"custom\" {{args}} open>\n    <p>This is a custom dialog</p>\n  </zg-dialog>\n</zing-grid>","storyCSSExample":"<zing-grid storybook-dialog dialog {{data}}>\n  <zg-dialog type=\"custom\" {{args}} open label=\"Dialog Example\">\n    <p>This is a custom dialog</p>\n  </zg-dialog>\n</zing-grid>","members":[{"name":"cancel","description":"Callback method to call on custom dialog when the dialog's \"cancel\"\nbutton is clicked","type":"String","fullName":"zg-dialog-cancel","demoLink":"https://app.zingsoft.com/demos/create/XBVNL7I6","default":"N/A","acceptedValues":["<string>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-dialog","version":"1.x.x"},{"name":"confirm","description":"Callback method to call on custom dialog when the dialog's \"confirm\"\nbutton is clicked","type":"String","fullName":"zg-dialog-confirm","demoLink":"https://app.zingsoft.com/demos/create/JYVD3V6H","default":"N/A","acceptedValues":["<string>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-dialog","version":"1.x.x"},{"name":"label","description":"Sets the dialog's header 'label' text","type":"String","fullName":"zg-dialog-label","demoLink":"https://app.zingsoft.com/demos/create/NMCHC24M","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"Are you sure you want to continue?\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-dialog","version":"1.x.x"},{"name":"open","description":"The presence of the specification-standard `open` attribute designates whether the dialog is shown or hidden","type":"String","fullName":"zg-dialog-open","demoLink":"https://app.zingsoft.com/demos/create/0L3OPPLM","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-dialog","version":"1.x.x"}]},"ZGEditorRow":{"elementDescription":"`<zg-editor-row>` holds the details of the edit mode for the grid.\n`<zg-editor-row>` is created internally and should not be placed directly in the user's HTML.","parentComponent":[{"name":"ZGTable","type":["Generated"]}],"cssParts":[{"name":"editor-row","description":"Editor-row container."},{"name":"inputs","description":"Container for the input fields"}],"storyCSSAlert":"Enable row editor by clicking the \"row edit\" buttons in the columns.","storyExample":"<zing-grid storybook-editor-row editor-controls {{data}}></zing-grid>","members":[]},"ZGFilter":{"elementDescription":"`<zg-filter>` is the container for a single cell when the cell contains a filter.\n`<zg-filter>` is created internally and should not be placed directly in the user's HTML; however,\nthe user can style the `<zg-filter>` using the `zg-filter` selector.","parentComponent":[{"name":"ZGRow","type":["Generated"],"ancestor":["ZGHead"]}],"cssParts":[{"name":"filter","description":"Filter container."},{"name":"filter-wrapper","description":"Wrapper for the filter field"}],"storyExample":"<zing-grid filter=\"inline\" sort {{data}}></zing-grid>\n\n<script>\n  (() => {\n    let zgRef = document.querySelector('zing-grid');\n    zgRef.executeOnLoad(() => {\n      zgRef.filterColumn('first', 'Maria')\n    });\n  })();\n</script>","storyExampleAlt":{"select":"<zing-grid filter=\"inline\" sort {{data}}>\n  <zg-colgroup>\n    <zg-column index=\"first\" type=\"select\"></zg-column>\n    <zg-column index=\"last\"></zg-column>\n    <zg-column index=\"number\"></zg-column>\n  </zg-colgroup>\n</zing-grid>\n\n<script>\n  (() => {\n    let zgRef = document.querySelector('zing-grid');\n    zgRef.executeOnLoad(() => {\n      zgRef.filterColumn('first', 'Maria')\n    });\n  })();\n</script>"},"members":[]},"ZGFilterMenu":{"elementDescription":"The `<zg-filter-menu>` element is a container for the menu that appears when clicking the column filter button.  \nThe element is dynamically inserted by the library.\nThe element can be styled using CSS.","parentComponent":[{"name":"ZingGrid","type":["Generated"]}],"childComponent":[{"name":"ZGButton","type":["Generated"]},{"name":"ZGMenuItem","type":["Generated"]}],"cssParts":[{"name":"body","description":"The body for the menu"},{"name":"body-conditions","description":"The \"conditions\" area of the menu"},{"name":"body-list","description":"The \"selectbox\" area of the menu"},{"name":"case-sensitive","description":"The label and checkbox for \"Match Case\" in the menu"},{"name":"filter-menu","description":"The container for the menu"},{"name":"footer","description":"The header for the menu"},{"name":"footer-apply","description":"The \"apply\" button in the menu"},{"name":"footer-close","description":"The \"close\" button in the menu"},{"name":"footer-reset","description":"The \"reset\" button in the menu"},{"name":"header","description":"The header for the menu"},{"name":"header-label","description":"The header label for the menu"}],"storyExample":"<zing-grid storybook-filter-menu filter filter-menu-areas=\"both\" {{data}}></zing-grid>\n\n<script>\n  (() => {\n    let zgRef = document.querySelector('zing-grid');\n    zgRef.executeOnLoad(() => {\n      let zgButtonRef = zgRef.querySelector('zg-button[action=\"filter\"]');\n      zgButtonRef.click();\n    });\n  })();\n</script>","members":[]},"ZGFocus":{"elementDescription":"The `<zg-focus>` element is a generated element added to `<zing-grid>`\nwhen the `selector` attribute is defined.  It is used as a container for the focus of cell(s) \nand used as a CSS target for styling by the developer.  It should not be accessed specifically\nbeyond styling.","parentComponent":[{"name":"ZGTable","type":["Generated"]}],"cssParts":[{"name":"focus","description":"Focus container"},{"name":"bottom","description":"The bottom edge of the focus"},{"name":"top","description":"The top edge of the focus"},{"name":"right","description":"The right edge of the focus"},{"name":"left","description":"The left edge of the focus"}],"storyCSSAlert":"Click grid body cells to view &lt;zg-focus&gt;. Click and drag to select multiple cells.","storyExample":"<zing-grid storybook-focus selector {{data}}></zing-grid>","members":[]},"ZGFoot":{"elementDescription":"The `<zg-foot>` tag contains the foot cells (`<zg-foot-cell>`) of the data \ngrid specified via the `foot-cell` attribute found on `<zg-column>` tags.  The tag roughly\ncorresponds to the idea of the `<tfoot>` tag used in HTML tables.  The `<zg-foot>` tag is \ngenerated by the library and should not be placed in a grid manually by a developer, but\ninstead is used as a styling target for CSS.","parentComponent":[{"name":"ZGTable","type":["Generated"]}],"childComponent":[{"name":"ZGRow","type":["Generated"]}],"storyExample":"<zing-grid {{data}}>\n  <zg-colgroup>\n    <zg-column index=\"first\"></zg-column>\n    <zg-column index=\"last\"></zg-column>\n    <zg-column index=\"number\" foot-cell=\"avg\"></zg-column>\n  </zg-colgroup>\n</zing-grid>","members":[]},"ZGFooter":{"elementDescription":"The `<zg-footer>` cell is a simple container element for content placed at the bottom of a grid.  \nIt may contain `<zg-caption>` or `<zg-source>`, but also may contain arbitrarily defined elements inserted by the \ndeveloper.  The element and its contents are stylable directly using CSS.","parentComponent":[{"name":"ZingGrid","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGButton","type":["Manual"]},{"name":"ZGCaption","type":["Generated","Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGSource","type":["Generated","Manual"]},{"name":"ZGText","type":["Manual"]}],"slots":[{"name":"","description":"Footer content."}],"storyExample":"<zing-grid {{data}}>\n  <zg-footer>Grid footer</zg-footer>\n</zing-grid>","members":[]},"ZGFrozenColgroup":{"elementDescription":"The `<zg-frozen-colgroup>` element is used to define the frozen columns.  \n`<zg-frozen-colgroup>` is created internally and should not be placed directly in the user's HTML; however,\nthe user can style the `<zg-frozen-colgroup>` using the `zg-frozen-colgroup` selector.","parentComponent":[{"name":"ZingGrid","type":["Generated"]}],"members":[]},"ZGHead":{"elementDescription":"The `<zg-head>` tag contains the head cells (`<zg-head-cell>`) of the data grid specified via the\n`head-cell` attribute found on `<zg-column>` tags.  The tag roughly corresponds to the idea of the `<thead>` tag used in\nHTML tables.  The `<zg-head>` tag is generated by the library and should not be placed in a grid manually by a developer. Instead, it is used as a styling target for CSS.","parentComponent":[{"name":"ZGTable","type":["Generated"]}],"childComponent":[{"name":"ZGRow","type":["Generated"]}],"storyExample":"<zing-grid {{data}}></zing-grid>","members":[]},"ZGHeadCell":{"elementDescription":"The `<zg-head-cell>` contains header information for a column and is roughly equivalent to the `<th>` \ntag used for HTML tables.  The `<zg-head-cell>` tag is generated by the library and should not be placed in a grid \nmanually by a developer. It can be used as a styling target for CSS.","parentComponent":[{"name":"ZGRow","type":["Generated"],"ancestor":["ZGHead"]}],"childComponent":[{"name":"ZGButton","type":["Generated"]},{"name":"ZGCheckbox","type":["Generated"]},{"name":"ZGColumnResize","type":["Generated"]},{"name":"ZGIcon","type":["Generated"]}],"cssParts":[{"name":"cell","description":"The head-cell container"},{"name":"cell-inner","description":"The content container"}],"storyExample":"<zing-grid sort {{data}}></zing-grid>","members":[]},"ZGHeader":{"elementDescription":"`<zg-header>` is the semantic container placed at the top of the grid\nto hold various grid items.  `<zg-header>` is created internally and should not be placed\ndirectly in the user's HTML.  The element can be styled via CSS.","parentComponent":[{"name":"ZingGrid","type":["Generated"]}],"childComponent":[{"name":"ZGCaption","type":["Generated","Mapped"]},{"name":"ZGControlBar","type":["Generated"]},{"name":"ZGSource","type":["Generated","Mapped"]}],"slots":[{"name":"","description":"header content."}],"storyExample":"<zing-grid {{data}}>\n  <zg-header>Grid header</zg-header>\n</zing-grid>","members":[]},"ZGIcon":{"elementDescription":"`<zg-icon>` is used to display custom ZingGrid icons within the grid.  \nThe icon is set by its name, but can have a different look based on the grid's theme.  \n`<zg-icon>` is created internally when a feature that uses it is enabled, like `pager`, \nbut can be included in the grid manually as long as the name attribute exists.","parentComponent":[{"name":"ZGCaption","type":["Manual"]},{"name":"ZGCard","type":["Manual"]},{"name":"ZGCell","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGCheckbox","type":["Generated"]},{"name":"ZGColumn","type":["Manual"]},{"name":"ZGDialog","type":["Manual"]},{"name":"ZGFooter","type":["Manual"]},{"name":"ZGHeadCell","type":["Generated"]},{"name":"ZGLoadMask","type":["Manual"]},{"name":"ZGMenu","type":["Manual"]},{"name":"ZGMenuGroup","type":["Generated"]},{"name":"ZGNoData","type":["Manual"]},{"name":"ZGPager","type":["Manual"]},{"name":"ZGSource","type":["Manual"]}],"slots":[{"name":"icon","description":"Icon content."}],"storyExample":"<zing-grid pager search sort {{data}}>\n  <zg-caption>\n    Icon Example\n    <zg-icon {{args}}>\n    </zg-icon>\n  </zg-caption>\n</zing-grid>","members":[{"name":"name","description":"Sets the icon type of `<zg-icon>`","type":"String","fullName":"zg-icon-name","demoLink":"https://app.zingsoft.com/demos/create/3Z0S4888","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"batchedit\"","\"batcheditcancel\"","\"batcheditsave\"","\"cancel\"","\"cancelrecord\"","\"checked\"","\"checkmark\"","\"close\"","\"createrecord\"","\"down\"","\"duplicaterecord\"","\"edit\"","\"editrecord\"","\"error\"","\"error-tmp\"","\"filter\"","\"firstpage\"","\"fixedmenu\"","\"info\"","\"lastpage\"","\"layoutcard\"","\"layoutrow\"","\"link\"","\"menu\"","\"nextpage\"","\"outsidearrow\"","\"prevpage\"","\"reload\"","\"remove\"","\"removerecord\"","\"search\"","\"sort\"","\"submitrecord\"","\"success\"","\"unchecked\"","\"undoremoverecord\"","\"up\"","\"warning\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-icon","version":"1.x.x"}]},"ZGInput":{"elementDescription":"`<zg-input>` contains input fields with added ZingGrid-specific functionality.\nThe specific functionality can be set via the `action` attribute.","parentComponent":[{"name":"ZGCaption","type":["Manual"]},{"name":"ZGCard","type":["Manual"]},{"name":"ZGCell","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGColumn","type":["Manual"]},{"name":"ZGDialog","type":["Manual"]},{"name":"ZGFooter","type":["Manual"]},{"name":"ZGLoadMask","type":["Manual"]},{"name":"ZGMenu","type":["Manual"]},{"name":"ZGNoData","type":["Manual"]},{"name":"ZGPager","type":["Generated","Manual"]},{"name":"ZGSource","type":["Manual"]}],"cssParts":[{"name":"input","description":"The input field wrapper"}],"slots":[{"name":"","description":"Content after input field."},{"name":"input","description":"Content before input field."}],"storyExample":"<zing-grid pager {{data}}>\n  <zg-caption>Input example: <zg-input {{args}}></zg-input></zg-caption>\n</zing-grid>","storyCSSExample":"<zing-grid pager {{data}}>\n  <zg-caption>Input example: <zg-input value=\"My Custom Input\" {{args}}></zg-input></zg-caption>\n</zing-grid>","members":[{"name":"action","description":"The built-in behavior and display of the input.  Gets and sets the associated grid property.","type":"String","fullName":"zg-input-action","demoLink":"https://app.zingsoft.com/demos/create/M64BDXP3","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"currpage\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-input","version":"1.x.x"},{"name":"type","description":"The type of the input if not using a built-in action","type":"String","fullName":"zg-input-type","demoLink":"https://app.zingsoft.com/demos/create/T37LYIM7","default":"\"text\"","acceptedValues":["<string>"],"displayValues":["\"password\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-input","version":"1.x.x"},{"name":"value","description":"The value of the input","type":"String","fullName":"zg-input-value","demoLink":"https://app.zingsoft.com/demos/create/AF5361VU","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"6\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-input","version":"1.x.x"}]},"ZGLayoutControls":{"elementDescription":"Allows you to switch between normal row mode and condensed card mode for the grid.  \n`<zg-layout-controls>` is created internally and should not be placed directly in the user's HTML; however,\nthe user can style the `<zg-layout-controls>` using the `zg-layout-controls` selector.","parentComponent":[{"name":"ZGControlBar","type":["Generated"]}],"childComponent":[{"name":"ZGButton","type":["Generated"]},{"name":"ZGText","type":["Generated"]}],"members":[]},"ZGLoadMask":{"elementDescription":"The `<zg-load-mask>` element is used to define the loading overlay that displays\non top of the grid before the grid is completely rendered.  The element is generally dynamically created, \nthough it is possible to manually define it for a complex loading screen. Define a simple message and use CSS to style the element.","parentComponent":[{"name":"ZingGrid","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGButton","type":["Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGText","type":["Manual"]}],"slots":[{"name":"","description":"Loading mask content."}],"storyExample":"<zing-grid loading {{data}}></zing-grid>","members":[]},"ZGMenu":{"elementDescription":"The `<zg-menu>` element is a container for a custom menu for ZingGrid \nused as a context or static (aka \"Hamburger\") menu.  The element is generally dynamically \ninserted by the library, though the developer can append of overwrite menu with custom \nentries.  The element can be styled using CSS.","parentComponent":[{"name":"ZingGrid","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGButton","type":["Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGMenuGroup","type":["Generated","Manual"]},{"name":"ZGMenuItem","type":["Generated","Manual"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGSeparator","type":["Generated"]},{"name":"ZGText","type":["Manual"]}],"cssParts":[{"name":"menu","description":"The container for the menu"}],"slots":[{"name":"","description":"Menu content. Overwrites default menu when `[replace]` is present, else appends to the end of the default menu.\nAccepts ZGMenuGroup, ZGMenuItem, and ZGSeparator to construct custom menu."}],"storyAlert":"true","storyExample":"<zing-grid storybook-menu context-menu static-menu {{data}}></zing-grid>","members":[{"name":"replace","description":"Presence of attribute replaces the default context menu with a custom menu.\nIf `replace` is not set, the custom menu will be appended to the end of the default menu.","type":"Boolean","fullName":"zg-menu-replace","demoLink":"https://app.zingsoft.com/demos/create/57Z2RG8B","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-menu","version":"1.x.x"}]},"ZGMenuGroup":{"elementDescription":"A group wrapper for multiple menu items found in the context \nmenu.  ZingGrid dynamically creates this element to hold various `<zg-menu-item>` \ntags together for organizational purposes.  As it is a visual element, it can be \nstyled via CSS.","parentComponent":[{"name":"ZGMenu","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGIcon","type":["Generated"]},{"name":"ZGMenuItem","type":["Generated","Manual"]}],"cssParts":[{"name":"group","description":"The container for the menu group"},{"name":"label","description":"The container for the menu group label"},{"name":"items","description":"The container for the menu group items"}],"slots":[{"name":"zgMenuGroupLabel","description":"Menu group label."},{"name":"zgMenuGroupItems","description":"Menu group items that only accepts menu items (ZGMenuItems)."}],"storyExample":"<zing-grid storybook-menu context-menu static-menu {{data}}></zing-grid>","members":[]},"ZGMenuItem":{"elementDescription":"This element defines a single menu item in ZingGrid's context \nmenu defined by `<zg-menu>`.  The element is typically dynamically generated, though \nit can be overwritten by a user's own custom `<zg-menu-item>` elements.  The \nelement can be styled via CSS.","parentComponent":[{"name":"ZGMenu","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGButton","type":["Generated"]}],"slots":[{"name":"","description":"Menu item content."}],"storyExample":"<zing-grid storybook-menu context-menu static-menu {{data}}></zing-grid>","members":[]},"ZGNoData":{"elementDescription":"`<zg-no-data>` is used to display a message when there are no records.  The \nelement internally wraps any text in a `<div role=\"any\">` tag.  The\nelement is stylable with CSS like most ZingGrid elements.","parentComponent":[{"name":"ZingGrid","type":["Manual"]},{"name":"ZGTable","type":["Generated"]}],"childComponent":[{"name":"ZGButton","type":["Generated","Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGText","type":["Manual"]}],"cssParts":[{"name":"status","description":"The container for the no data status message"}],"slots":[{"name":"","description":"No data content."}],"storyExample":"<zing-grid {{data}}></zing-grid>","members":[]},"ZGOptionList":{"elementDescription":"An option's list to go within a `<zg-select>` element","parentComponent":[{"name":"ZGSelect","type":["Generated"]}],"cssParts":[{"name":"list","description":"The container for the option list"}],"storyExample":"<zing-grid storybook-select pager {{data}}></zing-grid>","members":[]},"ZGPager":{"elementDescription":"An element that contains the UI controls for paging through a grid's dataset.  The \nelement can be manually placed, though it is more often dynamically inserted when paging is enabled via \nthe `pager` attribute on the `<zing-grid>` tag.  The element can be styled via CSS.","parentComponent":[{"name":"ZingGrid","type":["Generated","Manual"]}],"childComponent":[{"name":"ZGButton","type":["Generated","Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Generated","Manual"]},{"name":"ZGSelect","type":["Generated","Manual"]},{"name":"ZGText","type":["Generated","Manual"]}],"cssParts":[{"name":"pager","description":"The container for the entire pager"},{"name":"pager-inner","description":"The inner container for the pager"},{"name":"left","description":"The container for the left content of the pager"},{"name":"center","description":"The container for the center content of the pager"},{"name":"right","description":"The container for the right content of the pager"}],"slots":[{"name":"","description":"Pager content. If used with the other pager slot, the content is placed beneath the other slots."},{"name":"left","description":"Pager content placed in the left."},{"name":"center","description":"Pager content placed in the center."},{"name":"right","description":"Pager content placed in the right."}],"storyExample":"<zing-grid layout-controls preserve-state-id=\"storybookGridState\" preserve-state-options=\"layout\" {{data}}>\n  <zg-pager {{args}}>\n  </zg-pager>\n</zing-grid>","storyExampleAlt":{"buttonText":"<zing-grid layout-controls preserve-state-id=\"storybookGridState\" preserve-state-options=\"layout\" {{data}}>\n  <zg-pager pager-type=\"button-text\" {{args}}>\n  </zg-pager>\n</zing-grid>","cursor":"<zing-grid layout-controls preserve-state-id=\"storybookGridState\" preserve-state-options=\"layout\" pager page-size=\"5\">\n  <zg-data>\n    <zg-param name=\"src\" value=\"https://us-central1-zingsoft-demo-endpoints.cloudfunctions.net/cursor-paging/api\"></zg-param>\n    <zg-param name=\"recordPath\" value=\"data\"></zg-param>\n    <zg-param name=\"limitTo\" value=\"10\"></zg-param>\n    <zg-param name=\"loadByPage\" value=\"true\"></zg-param>\n    <zg-param name=\"cursor\" value=\"true\"></zg-param>\n    <zg-param name=\"prevIDPath\" value=\"previous_cursor\"></zg-param>\n    <zg-param name=\"nextIDPath\" value=\"next_cursor\"></zg-param>\n    <zg-param name=\"prevIDKey\" value=\"cursor\"></zg-param>\n    <zg-param name=\"nextIDKey\" value=\"cursor\"></zg-param>\n  </zg-data>\n</zing-grid>"},"members":[{"name":"page-size","description":"Sets the number of records or rows to display per page","type":"Number","fullName":"zg-pager-pageSize","demoLink":"https://app.zingsoft.com/demos/create/81Z219UH","default":"50","acceptedValues":["<number>"],"displayValues":["10"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-pager","version":"1.x.x"},{"name":"page-size-card","description":"Sets the number of cards to display per page when in card mode","type":"Number","fullName":"zg-pager-pageSizeCard","demoLink":"https://app.zingsoft.com/demos/create/686MIOTN","default":"page-size value","acceptedValues":["<number>"],"displayValues":["10"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-pager","version":"1.x.x","storyAlert":"To see attribute in action, update grid layout to \"card\" mode (top-right corner)."},{"name":"page-size-row","description":"Sets the number of rows to display per page when in row mode","type":"Number","fullName":"zg-pager-pageSizeRow","demoLink":"https://app.zingsoft.com/demos/create/97IV0UWT","default":"page-size value","acceptedValues":["<number>"],"displayValues":["10"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-pager","version":"1.x.x"},{"name":"pager-type","description":"Determines which type of pagination to use, input or buttons","type":"String","fullName":"zg-pager-pagerType","demoLink":"https://app.zingsoft.com/demos/create/H7FW1HCJ","default":"''","acceptedValues":["Enum"],"displayValues":["\"button-text\"","\"button-arrows\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-pager","version":"1.x.x"},{"name":"pagerButtonLimit","description":"Determines max number of page buttons to display.  Default is 5.","type":"Number","fullName":"zg-pager-pagerButtonLimit","demoLink":"","default":"","acceptedValues":"","displayValues":"","values":[],"category":"Attribute","tsType":"","internalDocs":""},{"name":"position","description":"Indicates where to position the pager","type":"String","fullName":"zg-pager-position","demoLink":"https://app.zingsoft.com/demos/create/S32UQ3Q4","default":"\"bottom\"","acceptedValues":["Enum"],"displayValues":["\"top\"","\"bottom\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-pager","version":"1.x.x"},{"name":"size-options","description":"Sets the options for page size in `zg-option-list`","type":"String","fullName":"zg-pager-sizeOptions","demoLink":"https://app.zingsoft.com/demos/create/SHG55V21","default":"\"5,10,50\"","acceptedValues":["<string separated number list>"],"displayValues":["\"2,4,6\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-pager","version":"1.x.x"}]},"ZGParam":{"elementDescription":"`<zg-param>` is a non-visual element used to pass the configuration options for the `<zg-data>` \nelement more cleanly via `name`-`value` pairs.  The element is not required, though it is preferred, as everything set \nwithin a `<zg-param>` element can also be set directly on `<zg-data>` via the `config` attribute.  Developers should note \nthat when setting complex values for the `value` attribute to use JSON encoded values.  Also, as a non-visual element, \nCSS styling does not apply to `<zg-param>`.","parentComponent":[{"name":"ZGData","type":["Manual"]}],"storyAlert":"true","storyExample":"<zing-grid {{data}}>\n  <zg-data>\n    <zg-param {{args}}>\n    </zg-param>\n  </zg-data>\n</zing-grid>","members":[{"name":"name","description":"Name of parameter","type":"String","fullName":"zg-param-name","demoLink":"https://app.zingsoft.com/demos/create/R2K22X2Q","default":"\"\"","acceptedValues":["Enum"],"displayValues":["adapter","idKey","newIndexPath","recordPath","nodePath","searchKey","search","serverFilter","filterFunction","sortByKey","sortBy","sortDirKey","sortDir","batchEditStatus","startAtKey","startAtValue","limitToKey","limitTo","offsetKey","offsetValue","pageKey","countPath","cursor","loadByPage","loadByScroll","hasNextPath","nextPath","nextIDPath","nextIDKey","hasPrevPath","prevPath","prevIDPath","prevIDKey","pageBase","selectorKey","csvCaption","csvDelimiter","csvHeader","csvLineSeparator","tableHide","tableHead","tableDataFormat","tableHeadFormat","collection","subscription","dataTable","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"],"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"name":"filterFunction","parent":"name","description":"This specifies a function to call to build the url for filtering on server side filter.\nThe function takes in a `filterObj` and is expected to return a URL query string or an object of name/pair values.","demoLink":"https://app.zingsoft.com/demos/create/MO0QDR19","relatedAttributes":["serverFilter"],"displayValues":"\"functionName\"","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-filterFunction","category":"Attribute Value","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"name":"batchEditStatus","parent":"name","description":"Sets the status message for batch editing","relatedAttributes":[],"displayValues":"tokenized string","type":"<string>","advancedFeature":"","group":"Request","tagName":"zg-param","fullName":"zg-param-name-batchEditStatus","category":"Attribute Value","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"name":"offsetKey","parent":"name","description":"The query paramter to specify offsetValue amount.  The default if \"offset\".","demoLink":"https://app.zingsoft.com/demos/create/KXNFFBS8","relatedAttributes":["offsetValue"," loadByPage"," loadByScroll"],"displayValues":"10","type":"<number>","advancedFeature":"","group":"Infinite Scrolling, Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-offsetKey","category":"Attribute Value","version":"1.x.x"},{"name":"offsetValue","parent":"name","description":"Sets the offset or number of records to skip","demoLink":"https://app.zingsoft.com/demos/create/KXNFFBS8","relatedAttributes":["offsetKey"," loadByPage"," loadByScroll"],"displayValues":"10","type":"<number>","advancedFeature":"","group":"Infinite Scrolling, Server Paging, Request","tagName":"zg-param","fullName":"zg-param-name-offsetValue","category":"Attribute Value","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"name":"selectorKey","parent":"name","description":"In the case of server side paging and type-selector-page-persist, this will indicate the field to act as an ID to persist the selection.","demoLink":"https://app.zingsoft.com/demos/create/085W1KHR","relatedAttributes":["loadByPage"],"displayValues":"\"name\"","type":"<string>","advancedFeature":"","group":"Server Paging","tagName":"zg-param","fullName":"zg-param-name-selectorKey","category":"Attribute Value","version":"2.1.0"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"name":"dataTable","parent":"name","description":"Specific to the dexieCloud and supabaseJS adapter.  Sets the table to use for CRUD operations.","demoLink":"https://app.zingsoft.com/demos/create/O35N7MXC","relatedAttributes":["adapter"],"displayValues":"\"employee_list\"","type":"<string>","advancedFeature":"","group":"Supabase, DexieCloud","tagName":"zg-param","fullName":"zg-param-name-dataTable","category":"Attribute Value","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"name":"restmode","parent":"name","description":"Set to \"manual\" if you want to turn off traditional REST URL construction and method setting.\nSet to \"method\" if you only want to use REST methods and not REST url construction.  \nSet to \"url\" if you want to use REST URL construction but not REST methods.  \nSet to \"auto\" if you want to use REST URL constuction and REST methods.\nThe method settings for `restmode=\"manual\"` and `restmode=\"url\"` 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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"},{"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","version":"1.x.x"}],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-param","version":"1.x.x"},{"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","version":"1.x.x"}]},"ZGRow":{"elementDescription":"`<zg-row>` is the container for the `<zg-cell>`, `<zg-head-cell>`, and `<zg-filter>` elements.\nIt corresponds to the `<tr>` tag on an HTML table.\nThe `<zg-row>` element is created dynamically and should not be placed in the grid by a developer.  \nHowever, the element is useful for styling the various rows of the grid using CSS.","parentComponent":[{"name":"ZGBody","type":["Generated"]},{"name":"ZGFoot","type":["Generated"]},{"name":"ZGHead","type":["Generated"]}],"childComponent":[{"name":"ZGCell","type":["Generated"],"ancestor":["ZGBody","ZGFoot"]},{"name":"ZGFilter","type":["Generated"],"ancestor":["ZGHead"]},{"name":"ZGHeadCell","type":["Generated"],"ancestor":["ZGHead"]}],"storyExample":"<zing-grid layout-controls layout=\"row\" {{data}}></zing-grid>","storyExampleAlt":{"card":"<zing-grid layout-controls layout=\"card\" {{data}}></zing-grid>"},"members":[]},"ZGRowDetails":{"elementDescription":"`<zg-row-details>` is the container for a row expansion;","parentComponent":[{"name":"ZingGrid","type":["Manual"]},{"name":"ZGRow","type":["Generated"]}],"childComponent":[{"name":"ZingGrid","type":["Generated","Manual"]}],"storyExample":"<zing-grid storybook-row-details {{data}}>\n  <zg-colgroup>\n   <zg-column index=\"first\"></zg-column>\n   <zg-column index=\"last\"></zg-column>\n </zg-colgroup>\n <zg-row-details>\n   <template>\n     <zing-grid data='[[record.tests]]'>\n       <zg-colgroup>\n         <zg-column index=\"test1\"></zg-column>\n         <zg-column index=\"test2\"></zg-column>\n         <zg-column index=\"test3\"></zg-column>\n       </zg-colgroup>\n     </zing-grid>\n   </template>\n </zg-row-details>\n</zing-grid>","members":[]},"ZGSearch":{"elementDescription":"The `<zg-search>` element is used to encapsulate the interface widget necessary for searching the grid -- \ntypically a text field and a button to trigger the search.  The element is added dynamically when search is specified and \nshould not be directly inserted by the developer.  The element and its contents can be styled using CSS.","parentComponent":[{"name":"ZGCaption","type":["Generated"]}],"childComponent":[{"name":"ZGButton","type":["Generated"]}],"cssParts":[{"name":"search","description":"The container for the search"},{"name":"input","description":"The container for the search input field"}],"storyExample":"<zing-grid search {{data}}></zing-grid>\n\n<script>\n  (() => {\n    let zgRef = document.querySelector('zing-grid');\n    zgRef.executeOnLoad(() => {\n      zgRef.searchGrid('Maria')\n    });\n  })();\n</script>","members":[]},"ZGSelect":{"elementDescription":"A custom select dropdown defined by our library. The\ndropdown can be assigned different options through the `options` attribute.","parentComponent":[{"name":"ZGCaption","type":["Manual"]},{"name":"ZGCard","type":["Manual"]},{"name":"ZGCell","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGColumn","type":["Manual"]},{"name":"ZGDialog","type":["Manual"]},{"name":"ZGFooter","type":["Manual"]},{"name":"ZGLoadMask","type":["Manual"]},{"name":"ZGMenu","type":["Manual"]},{"name":"ZGNoData","type":["Manual"]},{"name":"ZGPager","type":["Generated","Manual"]},{"name":"ZGSource","type":["Manual"]}],"childComponent":[{"name":"ZGOptionList","type":["Generated"]}],"cssParts":[{"name":"select","description":"The container for selection"},{"name":"select","description":"The container for selection"},{"name":"select-inner","description":"The inner container for selection"},{"name":"mask","description":"The container for the selection mask"}],"storyExample":"<zing-grid storybook-select pager {{data}}>\n  <zg-footer>Select example: <zg-select {{args}}></select></zg-footer>\n</zing-grid>","members":[{"name":"action","description":"The actions of the select dropdown. The current option is pagesize.","type":"String","fullName":"zg-select-action","demoLink":"https://app.zingsoft.com/demos/create/GZQR41UB","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"pagesize\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-select","version":"1.x.x"},{"name":"options","description":"The comma separated string list of options to go into the Select Element","type":"String","fullName":"zg-select-options","demoLink":"https://app.zingsoft.com/demos/create/GZQR41UB","default":"\"5,15,50\"","acceptedValues":["Any comma separated String list"],"displayValues":"","values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-select","version":"1.x.x"},{"name":"value","description":"The default value of the select dropdown","type":"String","fullName":"zg-select-value","demoLink":"https://app.zingsoft.com/demos/create/GZQR41UB","default":"\"\"","acceptedValues":["String"],"displayValues":["\"5\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-select","version":"1.x.x"}]},"ZGSelectorMask":{"elementDescription":"`<zg-selector-mask>` is used to wrap the cells during user selection for \nstyling purposes.  The element is dynamically added to the grid based upon the presence of the \n`selector` attribute on the `<zing-grid>` element.  The element should not be manually inserted, \nthough it can be styled using CSS.","parentComponent":[{"name":"ZGTable","type":["Generated"]}],"cssParts":[{"name":"selector-mask","description":"The container for the selector mask"}],"storyExample":"<zing-grid storybook-focus selector {{data}}></zing-grid>","members":[]},"ZGSeparator":{"elementDescription":"`<zg-separator>` specifies the horizontal bar in the `<zg-menu>` used for separating \nitems.  The element is created dynamically and should not be manually inserted by developers.  However,\n`<zg-separator>` can be styled using CSS.","parentComponent":[{"name":"ZGControlbar","type":["Generated"]},{"name":"ZGMenu","type":["Generated"]}],"storyExample":"<zing-grid storybook-menu context-menu static-menu {{data}}></zing-grid>","members":[]},"ZGSource":{"elementDescription":"`<zg-source>` is used to source the data in ZingGrid.  The \nelement internally wraps any text in a `<cite role=\"generic\">` tag for proper semantics.  The\nelement is stylable with CSS like most ZingGrid elements.","parentComponent":[{"name":"ZGFooter","type":["Generated","Manual"]},{"name":"ZGHeader","type":["Generated","Mapped"]},{"name":"ZingGrid","type":["Manual"]}],"childComponent":[{"name":"ZGButton","type":["Manual"]},{"name":"ZGCheckbox","type":["Manual"]},{"name":"ZGIcon","type":["Manual"]},{"name":"ZGInput","type":["Manual"]},{"name":"ZGSelect","type":["Manual"]},{"name":"ZGText","type":["Manual"]}],"cssParts":[{"name":"source","description":"The container for the source"}],"slots":[{"name":"","description":"Source content."}],"storyExample":"<zing-grid {{data}}>\n  <zg-source {{args}}>\n    My source\n  </zg-source>\n</zing-grid>","storyCSSExample":"<zing-grid {{data}}>\n  <zg-source position=\"both\">\n    My source\n  </zg-source>\n</zing-grid>","members":[{"name":"position","description":"Indicates where to position the source","type":"String","fullName":"zg-source-position","demoLink":"https://app.zingsoft.com/demos/create/7EDEO4QO","default":"\"bottom\"","acceptedValues":["Enum"],"displayValues":["\"top\"","\"bottom\"","\"both\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-source","version":"1.x.x"}]},"ZGStatus":{"elementDescription":"`<zg-status>` is a custom element used to display messages to the \nuser, such as errors and verifications of CRUD actions.  `<zg-status>` is created \ndynamically and should not be inserted manually.  The `<zg-status>` element is \nstylable with CSS.","parentComponent":[{"name":"ZingGrid","type":["Generated"]}],"childComponent":[{"name":"ZGIcon","type":["Generated"]}],"cssParts":[{"name":"status","description":"The container for the status"},{"name":"message","description":"The container for the status message"},{"name":"text","description":"The status text"},{"name":"action","description":"The container for the status action area"},{"name":"close","description":"The container for the close icon"},{"name":"close-icon","description":"The close icon"}],"storyExample":"<zing-grid storybook-status editor status-persist {{data}}></zing-grid>","members":[]},"ZGTable":{"elementDescription":"The `<zg-table>` component replicates the `<table>` functionality in the grid.\nIt contains `<zg-head>`, `<zg-body>`, `<zg-foot>`, and `<zg-colgroup>`.  \nThe element and its contents are stylable directly using CSS.","parentComponent":[{"name":"ZingGrid","type":["Generated"]}],"childComponent":[{"name":"ZGBody","type":["Generated"]},{"name":"ZGEditorRow","type":["Generated"]},{"name":"ZGFocus","type":["Generated"]},{"name":"ZGFoot","type":["Generated"]},{"name":"ZGHead","type":["Generated"]},{"name":"ZGNoData","type":["Generated"]},{"name":"ZGSelectorMask","type":["Generated"]}],"storyExample":"<zing-grid {{data}}></zing-grid>","members":[]},"ZGText":{"elementDescription":"`<zg-text>` is a ZingGrid specific text value that is bound to \nthe status of the grid, as defined by the `value` attribute.  The field can be \nmanually inserted by a developer, but is more commonly added by the use of certain \ngrid features, like paging.  The element is stylable with CSS.","parentComponent":[{"name":"ZGCaption","type":["Manual"]},{"name":"ZGCell","type":["Generated"],"ancestor":["ZGBody"]},{"name":"ZGCard","type":["Manual"]},{"name":"ZGColumn","type":["Manual"]},{"name":"ZGControlBar","type":["Generated"]},{"name":"ZGDialog","type":["Manual"]},{"name":"ZGFooter","type":["Manual"]},{"name":"ZGLayoutControls","type":["Generated"]},{"name":"ZGLoadMask","type":["Manual"]},{"name":"ZGMenu","type":["Manual"]},{"name":"ZGNoData","type":["Manual"]},{"name":"ZGPager","type":["Generated","Manual"]}],"slots":[{"name":"","description":"Text value."}],"storyExample":"<zing-grid pager data='[\n  { \"first\": \"Maria\", \"last\": \"John\", \"number\": 123 },\n  { \"first\": \"David\", \"last\": \"Smith\", \"number\": 456 },\n  { \"first\": \"Felicity\", \"last\": \"Snow\", \"number\": 789 }\n]'>\n  <zg-caption>\n    Text example: <zg-text {{args}}></zg-text>\n  </zg-caption>\n</zing-grid>","members":[{"name":"value","description":"Specifies what value to generate in text field.  Current built-in options are\npager-related information.","type":"String","fullName":"zg-text-value","demoLink":"https://app.zingsoft.com/demos/create/JVDZATK6","default":"\"\"","acceptedValues":["Enum"],"displayValues":["currpage","pagecount","pagesize","startrow","endrow","rowcount"],"values":[{"name":"currpage","parent":"value","description":"Display the current page of the grid.","relatedAttributes":["pager"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-text","fullName":"zg-text-value-currpage","category":"Attribute Value","version":"1.x.x"},{"name":"pagecount","parent":"value","description":"Displays the total amount of pages in the grid","relatedAttributes":["pager"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-text","fullName":"zg-text-value-pagecount","category":"Attribute Value","version":"1.x.x"},{"name":"pagesize","parent":"value","description":"Displays the current `page-size` of the grid","relatedAttributes":["pager"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-text","fullName":"zg-text-value-pagesize","category":"Attribute Value","version":"1.x.x"},{"name":"startrow","parent":"value","description":"Displays the current starting row index, of the current page, in the grid","relatedAttributes":["pager"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-text","fullName":"zg-text-value-startrow","category":"Attribute Value","version":"1.x.x"},{"name":"endrow","parent":"value","description":"Displays the current end row index, of the current page, in the grid","relatedAttributes":["pager"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-text","fullName":"zg-text-value-endrow","category":"Attribute Value","version":"1.x.x"},{"name":"rowcount","parent":"value","description":"Displays the total amount of rows in the grid","relatedAttributes":["pager"],"displayValues":"","type":"","advancedFeature":"","group":"","tagName":"zg-text","fullName":"zg-text-value-rowcount","category":"Attribute Value","version":"1.x.x"}],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zg-text","version":"1.x.x"}]},"ZGTooltip":{"elementDescription":"`<zg-tooltip>` elements are inserted dynamically by the ZingGrid library\nand serves as a container for the grid's tooltips.  As a generated element, developers\nshould not manually place `<zg-tooltip>` in their grid; however, they may style the tooltips and\nits internal elements using CSS.","parentComponent":[{"name":"ZingGrid","type":["Generated"]}],"cssParts":[{"name":"close","description":"The tooltip close icon"}],"members":[]},"ZingGrid":{"elementDescription":"The most important tag in the library. Contains most of the attributes to turn grid features on/off. \nSet `zing-grid:not(:defined) {display:none;}` to hide <zing-grid> instances until they are ready. \nThis stops child elements from appearing unstyled for a brief moment.","childComponent":[{"name":"ZGBatchEdit","type":["Generated"]},{"name":"ZGCaption","type":["Manual"]},{"name":"ZGCard","type":["Manual"]},{"name":"ZGColgroup","type":["Generated","Manual"]},{"name":"ZGData","type":["Manual"]},{"name":"ZGDialog","type":["Generated","Manual"]},{"name":"ZGFilterMenu","type":["Generated"]},{"name":"ZGFooter","type":["Generated","Manual"]},{"name":"ZGFrozenColgroup","type":["Generated"]},{"name":"ZGHeader","type":["Generated"]},{"name":"ZGLoadMask","type":["Generated","Manual"]},{"name":"ZGMenu","type":["Generated","Manual"]},{"name":"ZGPager","type":["Generated","Manual"]},{"name":"ZGStatus","type":["Generated"]},{"name":"ZGTable","type":["Generated"]},{"name":"ZGTooltip","type":["Generated"]}],"slots":[{"name":"","description":"Grid content or configuration that accepts `<zg-*>` elements that are allowed to be manually inserted."}],"storyExample":"<zing-grid {{args}}>\n</zing-grid>","storyCSSExample":"<zing-grid frozen-columns-left=1 {{args}}>\n</zing-grid>","members":[{"name":"aggregate","description":"Adds aggregate column and sets the type-aggregate-value to the specified value","type":"String","fullName":"zing-grid-aggregate","demoLink":"https://app.zingsoft.com/demos/create/21U0IS7T","default":"N/A","acceptedValues":["Enum"],"displayValues":["\"sum\"","\"avg\"","\"max\"","\"min\"","\"count\"","\"tokenized string\""],"values":[],"category":"Attribute","tsType":"String","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"dataset"},{"name":"align","description":"Aligns the contents of the grid's text","type":"String","fullName":"zing-grid-align","demoLink":"https://app.zingsoft.com/demos/create/6FILWB1Y","default":"\"left\"","acceptedValues":["Enum"],"displayValues":["\"center\"","\"left\"","\"right\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"batch-edit","description":"Presence of attribute indicates the grid allows batch editing and displays the controls.\nIn batch edit mode, changes can be made to cells that do not have edit disabled or are not a part of the \"recordkey\" column.","type":"Boolean","fullName":"zing-grid-batchEdit","demoLink":"https://app.zingsoft.com/demos/create/ZX34SZ4C","default":"false","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"batch-edit-status","description":"Sets the message to display when making batch edits.  \nCan use the following tokens: [[changes]], [[deleted]], [[fieldsEdited]], [[inserted]], [[modified]], [[recordsEdited]].\nCan append 'Message' to any of the above for a string description.","type":"String","fullName":"zing-grid-batchEditStatus","demoLink":"https://app.zingsoft.com/demos/create/GSFBMZGE","default":"\"[[changesMessages]]\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:batch-edit:true"},{"name":"button-tooltip-disabled","description":"Turns off the tooltips on all buttons in the grid","type":"Boolean","fullName":"zing-grid-buttonTooltipDisabled","demoLink":"https://app.zingsoft.com/demos/create/KBQ43E4K","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:editor-controls:true"},{"name":"caption","description":"The caption for the grid","type":"String","fullName":"zing-grid-caption","demoLink":"https://app.zingsoft.com/demos/create/O52C484H","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"My Caption\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"card","description":"Specifies the defined `<zg-card>` of the grid.  More appropriate to use `<zg-card>` in most cases or set the property programmatically.","type":"Object","fullName":"zing-grid-card","demoLink":"https://app.zingsoft.com/demos/create/7FSHTJSA","default":"[]","acceptedValues":["<object>"],"displayValues":["{\"renderer-template\": \"renderTemplate\", \"editor-template\": \"editorTemplate\", \"renderer\": \"custom-renderer\", \"editor\": \"customEditor\"}"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/7FSHTJSA"},{"name":"cell-break","description":"The type of `word-break` style for body cells. When not set, `cell-break` style is `normal` by default.\nIf the width of a column is set, `cell-break` is `word` by default.\nTo overwrite `cell-break` for cells in a specific column, set `cell-break` for that column.","type":"String","fullName":"zing-grid-cellBreak","demoLink":"https://app.zingsoft.com/demos/create/A46O96IK","default":"\"normal\"","acceptedValues":["Enum"],"displayValues":["\"all\"","\"ellipsis\"","\"normal\"","\"word\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"dataset:column-width"},{"name":"cell-class","description":"Adds a class to each `<zg-cell>` in the grid. This attribute can be applied to both\n`<zing-grid>` or `<zg-column>`. If the attribute is applied to both, `<zg-column>`'s `cell-class` overwrites `<zing-grid>`'s `cell-class`.\nTo set a class conditionally, set `cell-class` to the name of the function, which takes in the arguments: `cellData`, `domContainer`, `cellObject`.","type":"String","fullName":"zing-grid-cellClass","demoLink":"https://app.zingsoft.com/demos/create/7QHJW15H","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"userClassName\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/7QHJW15H","storyControl":"select","storyOptions":"teal, textUppercase"},{"name":"cell-editor","description":"Turns cell editing on or off. Automatically turned on when setting `editor` or `editor-controls`.","type":"String | Boolean","fullName":"zing-grid-cellEditor","demoLink":"https://app.zingsoft.com/demos/create/RJ9FDW1F","default":"false","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum | Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:editor-controls:true"},{"name":"cell-focus","description":"Turns off keyboard nav cell focus if set to disabled","type":"String","fullName":"zing-grid-cellFocus","demoLink":"https://app.zingsoft.com/demos/create/YHMJUU1B","default":"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/YHMJUU1B"},{"name":"cell-tooltip-action","description":"Sets the execution method of custom 'icon' type tooltips to either activate on hover or click of the icon","type":"String","fullName":"zing-grid-cellTooltipAction","demoLink":"https://app.zingsoft.com/demos/create/EFSY4YCV","default":"\"hover\"","acceptedValues":["Enum"],"displayValues":["\"click\"","\"hover\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/EFSY4YCV"},{"name":"cell-tooltip-delay","description":"Sets the hover delay in milliseconds before displaying the tooltip. If delay is not specified,\nit is 1000ms on cell tooltips without an icon and 0ms on cell tooltips with an icon.","type":"Number","fullName":"zing-grid-cellTooltipDelay","demoLink":"https://app.zingsoft.com/demos/create/DFHNBLQH","default":"1000","acceptedValues":["Number"],"displayValues":["2000"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/DFHNBLQH"},{"name":"cell-tooltip-icon","description":"Specifies the icon to use for the info column types","type":"String","fullName":"zing-grid-cellTooltipIcon","demoLink":"https://app.zingsoft.com/demos/create/P56L5RR9","default":"info","acceptedValues":["<string>"],"displayValues":["'checkmark'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/P56L5RR9"},{"name":"cell-tooltip-position","description":"Sets the tooltip-position for the cell","type":"String","fullName":"zing-grid-cellTooltipPosition","demoLink":"https://app.zingsoft.com/demos/create/VI7LVJZV","default":"\"top\"","acceptedValues":["Enum"],"displayValues":["\"top\"","\"left\"","\"right\"","\"bottom\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/VI7LVJZV"},{"name":"cell-tooltip-renderer","description":"Gets the name of the user's custom render function, on window, to use the function's return value as the tooltip content","type":"String","fullName":"zing-grid-cellTooltipRenderer","demoLink":"https://app.zingsoft.com/demos/create/L5VON3SE","default":"\"\"","acceptedValues":["String"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/L5VON3SE"},{"name":"cell-tooltip-template","description":"Points to an external template element to be used as the template for the tooltip display","type":"String","fullName":"zing-grid-cellTooltipTemplate","demoLink":"https://app.zingsoft.com/demos/create/H0TL7Q4M","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/H0TL7Q4M"},{"name":"cell-tooltip-type","description":"Sets the style to use for the tooltips.  Uses the `default` style by default.  Can set to `system` to match the tooltips used on icons throughout `<zing-grid>`.","type":"String","fullName":"zing-grid-cellTooltipType","demoLink":"https://app.zingsoft.com/demos/create/70BE60YN","default":"default","acceptedValues":["Enum"],"displayValues":["\"default\"","\"system\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/70BE60YN"},{"name":"col-class","description":"Adds a class to each `<zg-cell>` in targeted `<zg-column>`. To\napply a class conditionally, set the value to the name of the function to run\non each cell value. The function takes the parameters `fieldIndex`, `domContainer`,\nand `colObject`, and returns a string which is the class name to apply.","type":"String","fullName":"zing-grid-colClass","demoLink":"https://app.zingsoft.com/demos/create/5K4WJTVV","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"userClassName\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/5K4WJTVV","storyControl":"select","storyOptions":"teal, textUppercase"},{"name":"column-drag","description":"Enables column dragging","type":"String","fullName":"zing-grid-columnDrag","demoLink":"https://app.zingsoft.com/demos/create/ZJ3ZEZOQ","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"column-drag-action","description":"Specifies the action of dragging allowed.  By default, if `column-drag` is\nenabled then `column-drag-action` is set `\"both\"`.  This property will turn on column-drag if not already set.","type":"String","fullName":"zing-grid-columnDragAction","demoLink":"https://app.zingsoft.com/demos/create/I0Z4308I","default":"false","acceptedValues":["Enum"],"displayValues":["\"reorder\"","\"hide\"","\"both\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:column-drag:true"},{"name":"column-resizable","description":"Presence of attribute turns on column resizing for all columns.\nThis excludes internal column types (), which requires setting ZGColumn[resizable] on the column.","type":"Boolean","fullName":"zing-grid-columnResizable","demoLink":"https://app.zingsoft.com/demos/create/6QN88PG9","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"column-resizable-max-width","description":"Sets the maximum width columns can be set to when resizing","type":"Number","fullName":"zing-grid-columnResizableMaxWidth","demoLink":"https://app.zingsoft.com/demos/create/2K5XRF7T","default":"n/a","acceptedValues":["Number"],"displayValues":["150"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:column-resizable:true"},{"name":"column-resizable-min-width","description":"Sets the minimum width columns can be set to when resizing","type":"Number","fullName":"zing-grid-columnResizableMinWidth","demoLink":"https://app.zingsoft.com/demos/create/X5AKZ5HL","default":"n/a","acceptedValues":["Number"],"displayValues":["150"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:column-resizable:true"},{"name":"column-resizable-persistent","description":"Presence of attribute displays column resizing for all columns without hover","type":"Boolean","fullName":"zing-grid-columnResizablePersistent","demoLink":"https://app.zingsoft.com/demos/create/ARYGKYST","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:column-resizable:true"},{"name":"column-width","description":"Sets the width each of the columns","type":"String | Number","fullName":"zing-grid-columnWidth","demoLink":"https://app.zingsoft.com/demos/create/HFAWU3EU","default":"fit","acceptedValues":["Enum","<string pixel value>"],"displayValues":["\"fit\"","\"fitheader\"","\"fitcontent\"","\"stretch\"","\"10%\"","\"150px\"","150"],"values":[],"category":"Attribute","tsType":"Enum | String | Number","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"columns","description":"Specifies the columns of the grid.  More appropriate to use `<zg-column>` in most cases or set the property programmatically.","type":"Object","fullName":"zing-grid-columns","demoLink":"https://app.zingsoft.com/demos/create/EU02P5CF","default":"[]","acceptedValues":["<object>"],"displayValues":["[{\"index\": \"firstName\"}, {\"index\": \"lastName\"}]"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"columns-control","description":"Presence of attribute turns on the menu to show and hide columns","type":"Boolean","fullName":"zing-grid-columnsControl","demoLink":"https://app.zingsoft.com/demos/create/0R0WHLV3","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"compact","description":"Augments internal themes to a compact mode","type":"Boolean","fullName":"zing-grid-compact","demoLink":"https://app.zingsoft.com/demos/create/XQU3BZA0","default":"N/A","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"config","description":"Used to set multiple grid properties at once.  This should never be used directly.\nThis is meant for object instantiation.","type":"Object","fullName":"zing-grid-config","demoLink":"https://app.zingsoft.com/demos/create/DCO6DQ23","default":"{}","acceptedValues":["<object>"],"displayValues":["{\"search\": true,\"pager\":true,\"caption\": \"Actors/Actresses\",\"pageSize\": 5}"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"confirm-delete","description":"Turns off delete confirmation if set to disable","type":"String","fullName":"zing-grid-confirmDelete","demoLink":"https://app.zingsoft.com/demos/create/1P30R7BU","default":"true","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:editor-controls:true"},{"name":"confirmations","description":"Sets which confirmation dialogs to display on batch editing and deleting","type":"String","fullName":"zing-grid-confirmations","demoLink":"https://app.zingsoft.com/demos/create/N2XQIGWB","default":"\"all\"","acceptedValues":["Enum"],"displayValues":["\"batch-edit\"","\"batch-edit-discard\"","\"delete\"","\"disabled\"","\"all\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:editor-controls:true"},{"name":"context-menu","description":"Enables the default `<zing-grid>` context menu or set to the id name of a custom `<zg-menu>`.  If\nset to a custom menu and `<zg-menu>` has the `replace` attribute present, then the custom menu will replace the context menu.\nOtherwise the contents of the custom menu is appended to the end of context menu.\nCan also set to `\"browser\"` to use the browser's built in context-menu\nNote that the `\"browser\"` context-menu cannot be used together with a custom static-menu.","type":"String | Boolean","fullName":"zing-grid-contextMenu","demoLink":"https://app.zingsoft.com/demos/create/XSUBCM96","default":"\"\"","acceptedValues":["N/A","<string>"],"displayValues":["N/A","\"browser\"","\"myCustomMenu\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"creator","description":"Sets the create editor to modal (default) or inline.","type":"String","fullName":"zing-grid-creator","demoLink":"https://app.zingsoft.com/demos/create/ZUH4NYL0","default":"false","acceptedValues":["<string>"],"displayValues":["\"inline\""],"values":[],"category":"Attribute","tsType":"Enum | Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:editor-controls:true"},{"name":"data","description":"Data for the grid presented as an array or object","type":"Object","fullName":"zing-grid-data","demoLink":"https://app.zingsoft.com/demos/create/EV3X7J4E","default":"\"\"","acceptedValues":["<object>"],"displayValues":["[{\"firstName\": \"John\", \"lastName\": \"Doe\"}]"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"default-display","description":"The data to display in each cell where the data value is null or undefined","type":"String","fullName":"zing-grid-defaultDisplay","demoLink":"https://app.zingsoft.com/demos/create/63IMORRK","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"N/A\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"dataset"},{"name":"dialog","description":"Sets `<zg-dialog>` to display dialog and mask within the grid dimensions instead of the whole screen","type":"Boolean","fullName":"zing-grid-dialog","demoLink":"https://app.zingsoft.com/demos/create/XINAL854","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:editor:modal"},{"name":"dir","description":"The HTML standard direction to indicate direction of grid's columns and text","type":"String","fullName":"zing-grid-dir","demoLink":"https://app.zingsoft.com/demos/create/LKG20E1U","default":"\"ltr\"","acceptedValues":["<string>"],"displayValues":["\"ltr\"","\"rtl\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"editor","description":"Turns on the grid editor.  Enables single cell editing via double click.\nSets the editor to inline (default) or modal.","type":"String | Boolean","fullName":"zing-grid-editor","demoLink":"https://app.zingsoft.com/demos/create/3C61DMKN","default":"false","acceptedValues":["<string>"],"displayValues":["\"modal\""],"values":[],"category":"Attribute","tsType":"Enum | Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"editor-controls","description":"Adds columns for the editor controls.  If it is added, default is \"all\".","type":"String | Boolean","fullName":"zing-grid-editorControls","demoLink":"https://app.zingsoft.com/demos/create/L3U440X5","default":"false","acceptedValues":["Enum"],"displayValues":["\"editor\"","\"remover\"","\"creator\"","\"all\""],"values":[],"category":"Attribute","tsType":"Enum | Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"editor-disabled-fields","description":"Comma separated list of indexes to turn off editor functionality on.  Mimes the functionality of [\"editor=disabled\"] on `<zg-column>`","type":"String","fullName":"zing-grid-editorDisabledFields","demoLink":"https://app.zingsoft.com/demos/create/4LRZNXI2","default":"\"\"","acceptedValues":["String"],"displayValues":["fieldIndex"],"values":[],"category":"Attribute","tsType":"Enum | Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:editor-controls:true"},{"name":"filter","description":"Enables filtering for all columns.  Can be turned on/off individually via column.  Can be set to \"inline\" or \"menu\"  Default is \"menu\"","type":"Boolean","fullName":"zing-grid-filter","demoLink":"https://app.zingsoft.com/demos/create/4HCRN4FI","default":"\"menu\"","acceptedValues":["Enum"],"displayValues":["\"menu\"","\"inline\"","\"both\"","\"disabled\""],"values":[],"category":"Attribute","tsType":"String | Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"filter-buttons","description":"Comma separated list of buttons to display in the specified order on the filter menu","type":"String | Array","fullName":"zing-grid-filterButtons","demoLink":"https://app.zingsoft.com/demos/create/CHM0EJ01","default":"\"reset, apply\"","acceptedValues":["<comma separated enum list>"],"displayValues":["\"reset\"","\"close\"","\"apply\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/CHM0EJ01"},{"name":"filter-conditions","description":"The list of conditions to present as options in the filter menu condition select.  Use \"break\" to display the horizontal separator.  Use \"default\" to use the built in default.","type":"String","fullName":"zing-grid-filterConditions","demoLink":"https://app.zingsoft.com/demos/create/E460972W","default":"default","acceptedValues":["Enum"],"displayValues":["\"none\"","\"empty\"","\"notEmpty\"","\"equals\"","\"notEquals\"","\"beginsWith\"","\"endsWith\"","\"contains\"","\"notContains\"","\"between\"","\"notBetween\"","\"greaterThan\"","\"greaterEqualThan\"","\"lessThan\"","\"lessEqualThan\"","\"before\"","\"after\"","\"betweenDate\"","\"today\"","\"yesterday\"","\"tomorrow\"","custom filter name","\"break\"","\"default\"","\"trueVal\"","\"falseVal\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"filter-conditions-display","description":"Number of conditions to display in the filter menu on menu open","type":"Number","fullName":"zing-grid-filterConditionsDisplay","demoLink":"https://app.zingsoft.com/demos/create/PP8PO0EY","default":"1","acceptedValues":["Number"],"displayValues":["2"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/PP8PO0EY"},{"name":"filter-conditions-max","description":"Max number of conditions to display in the filter menu","type":"Number","fullName":"zing-grid-filterConditionsMax","demoLink":"https://app.zingsoft.com/demos/create/JR4N4DCR","default":"1","acceptedValues":["Number"],"displayValues":["5"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/JR4N4DCR"},{"name":"filter-default-condition","description":"The condition to initially display on filter menu open","type":"String","fullName":"zing-grid-filterDefaultCondition","demoLink":"https://app.zingsoft.com/demos/create/ZS7YWQS7","default":"\"contains\"","acceptedValues":["Enum"],"displayValues":["\"none\"","\"empty\"","\"notEmpty\"","\"equals\"","\"notEquals\"","\"beginsWith\"","\"endsWith\"","\"contains\"","\"notContains\"","\"between\"","\"notBetween\"","\"greaterThan\"","\"greaterEqualThan\"","\"lessThan\"","\"lessEqualThan\"","\"before\"","\"after\"","\"betweenDate\"","\"today\"","\"yesterday\"","\"tomorrow\"","custom filter name"],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"filter-menu-areas","description":"The areas to display in the filter menu.  Can be conditions, selectbox, or both","type":"String","fullName":"zing-grid-filterMenuAreas","demoLink":"https://app.zingsoft.com/demos/create/863QAY2V","default":"\"conditions\"","acceptedValues":["Enum"],"displayValues":["\"conditions\"","\"selectbox\"","\"both\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"filter-on","description":"Determines if the filter comparison should be against the raw values or the rendered.\nThis only applies to conditionals in the filter menu.\nFor iframe column type, it is restricted to raw values.\nFor aggregate column type, it is restricted to rendered values.","type":"String","fullName":"zing-grid-filterOn","demoLink":"https://app.zingsoft.com/demos/create/T007SEBG","default":"depends on column type","acceptedValues":["Enum"],"displayValues":["\"raw\"","\"rendered\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"filter-selectbox-display","description":"Determines if the selectbox in the filter menu should display the values as raw or rendered values.","type":"String","fullName":"zing-grid-filterSelectboxDisplay","demoLink":"https://app.zingsoft.com/demos/create/YKJUE5A3","default":"depends on column type","acceptedValues":["Enum"],"displayValues":["\"raw\"","\"rendered\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"filter-trigger","description":"Action that fires the filter event from the filter menu.","type":"String","fullName":"zing-grid-filterTrigger","demoLink":"https://app.zingsoft.com/demos/create/OD0KX134","default":"\"button\"","acceptedValues":["Enum"],"displayValues":["\"button\"","\"change\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"foot-class","description":"Adds a class to each `<zg-cell>` in the `<zg-foot>`. To\napply a class conditionally, set the value to the name of the function to run \non each cell value. The function takes the parameters `fieldIndex`, `domContainer`,\nand `colObject`, and returns a string which is the class name to apply.","type":"String","fullName":"zing-grid-footClass","demoLink":"https://app.zingsoft.com/demos/create/4RSYZH9X","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"userClassName\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/4RSYZH9X"},{"name":"frozen-columns-left","description":"Sets the number of columns to freeze to the left","type":"Number","fullName":"zing-grid-frozenColumnsLeft","demoLink":"https://app.zingsoft.com/demos/create/ERBCTU9W","default":"0","acceptedValues":["Number"],"displayValues":["1"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"frozen-columns-right","description":"Sets the number of columns to freeze to the right","type":"Number","fullName":"zing-grid-frozenColumnsRight","demoLink":"https://app.zingsoft.com/demos/create/SHSGTE6C","default":"0","acceptedValues":["Number"],"displayValues":["1"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"frozen-row-class","description":"Adds a class to each `<zg-row>` element. To\napply a class conditionally, set the value to the name of the function to run\non each cell value. The function takes the parameters `data`, `rowIndex` (1-based),\n `domRow`, and `rowObject`, `rowParent`, and returns a string which is the class name to apply.","type":"String","fullName":"zing-grid-frozenRowClass","demoLink":"https://app.zingsoft.com/demos/create/8HIA1NX8","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"userClassName\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:frozen-rows-*","storyControl":"select","storyOptions":"teal, textUppercase"},{"name":"frozen-rows-bottom","description":"Sets the number of rows to freeze to the bottom","type":"Number","fullName":"zing-grid-frozenRowsBottom","demoLink":"https://app.zingsoft.com/demos/create/YK9OTK0N","default":"0","acceptedValues":["Number"],"displayValues":["1"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"frozen-rows-top","description":"Sets the number of rows to freeze to the top","type":"Number","fullName":"zing-grid-frozenRowsTop","demoLink":"https://app.zingsoft.com/demos/create/YYZBW5QJ","default":"0","acceptedValues":["Number"],"displayValues":["1"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"gridlines","description":"Sets vertical, horizontal or both grid lines to the grid","type":"String","fullName":"zing-grid-gridlines","demoLink":"https://app.zingsoft.com/demos/create/9XDBFP79","default":"","acceptedValues":["Enum"],"displayValues":["\"both\"","\"horz\"","\"horizontal\"","\"vert\"","\"vertical\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"group-by","description":"Sets the index fields to group on.","type":"String","fullName":"zing-grid-groupBy","demoLink":"https://app.zingsoft.com/demos/create/LUNDRSXW","default":"","acceptedValues":["String"],"displayValues":["\"country\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"dataset","storyControl":"select","storyOptions":"first"},{"name":"head-class","description":"Adds a class to each `<zg-cell>` in the `<zg-head>`. To\napply a class conditionally, set the value to the name of the function to run \non each cell value. The function takes the parameters `fieldIndex`, `domContainer`,\nand `colObject`, and returns a string which is the class name to apply.","type":"String","fullName":"zing-grid-headClass","demoLink":"https://app.zingsoft.com/demos/create/3X5995IT","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"userClassName\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/3X5995IT","storyControl":"select","storyOptions":"teal, textUppercase"},{"name":"header-auto-format","description":"Converts camel, dash, and kebab case to properly spaced and capitalized typography.\nSetting to `disabled` will turn off formatting on headers.  Set to a function name to customize formatting of headers.","type":"String","fullName":"zing-grid-headerAutoFormat","demoLink":"https://app.zingsoft.com/demos/create/DXI75TPI","default":"\"\"","acceptedValues":["N/A"],"displayValues":["\"disabled\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"header-row-hide","description":"Hides any header rows","type":"String","fullName":"zing-grid-headerRowHide","demoLink":"https://app.zingsoft.com/demos/create/O5I6BB3J","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"header-tooltip-action","description":"Sets the execution method of custom 'icon' type tooltips to either activate on hover or click of the icon","type":"String","fullName":"zing-grid-headerTooltipAction","demoLink":"https://app.zingsoft.com/demos/create/H30XQPVF","default":"\"hover\"","acceptedValues":["Enum"],"displayValues":["\"click\"","\"hover\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/H30XQPVF"},{"name":"header-tooltip-delay","description":"Sets the hover delay in milliseconds before displaying the header tooltip","type":"Number","fullName":"zing-grid-headerTooltipDelay","demoLink":"https://app.zingsoft.com/demos/create/GJS825NR","default":"0","acceptedValues":["Number"],"displayValues":["2000"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/GJS825NR"},{"name":"header-tooltip-icon","description":"Specifies the icon to use for the header tooltip trigger icon","type":"String","fullName":"zing-grid-headerTooltipIcon","demoLink":"https://app.zingsoft.com/demos/create/XTERMUKW","default":"info","acceptedValues":["<string>"],"displayValues":["'checkmark'"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"header-tooltip-icon-position","description":"Sets the tooltip icon position for the tooltip icon in the header cells","type":"String","fullName":"zing-grid-headerTooltipIconPosition","demoLink":"https://app.zingsoft.com/demos/create/USHB9WFZ","default":"\"right\"","acceptedValues":["Enum"],"displayValues":["\"left\"","\"right\"","\"after-text\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/USHB9WFZ"},{"name":"header-tooltip-position","description":"Sets the tooltip-position for the header cell","type":"String","fullName":"zing-grid-headerTooltipPosition","demoLink":"https://app.zingsoft.com/demos/create/BKMIOSJI","default":"\"top\"","acceptedValues":["Enum"],"displayValues":["\"top\"","\"left\"","\"right\"","\"bottom\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/BKMIOSJI"},{"name":"header-tooltip-renderer","description":"Gets the name of the user's custom render function, on window, to use the function's return value as the tooltip content","type":"String","fullName":"zing-grid-headerTooltipRenderer","demoLink":"https://app.zingsoft.com/demos/create/Q5DYAB0L","default":"\"\"","acceptedValues":["String"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/Q5DYAB0L"},{"name":"header-tooltip-template","description":"Points to an external template element to be used as the template for the tooltip display","type":"String","fullName":"zing-grid-headerTooltipTemplate","demoLink":"https://app.zingsoft.com/demos/create/0MGML3OF","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/0MGML3OF"},{"name":"header-tooltip-trigger","description":"Sets what part of the header triggers the tooltip.  If set to 'icon', an info icon is added to the header.","type":"String","fullName":"zing-grid-headerTooltipTrigger","demoLink":"https://app.zingsoft.com/demos/create/I1VOMDTH","default":"text","acceptedValues":["Enum"],"displayValues":["\"text\"","\"icon\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/I1VOMDTH"},{"name":"header-tooltip-type","description":"Sets the style to use for the tooltips.  Uses the `default` style by default.  Can set to `system` to match the tooltips used on icons throughout `<zing-grid>`.","type":"String","fullName":"zing-grid-headerTooltipType","demoLink":"https://app.zingsoft.com/demos/create/O3AQ5MJM","default":"default","acceptedValues":["Enum"],"displayValues":["\"default\"","\"system\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"height","description":"Sets the height of the grid.  If the height is less than the size of the content, scrolling is added\nto grid body.","type":"String | Number","fullName":"zing-grid-height","demoLink":"https://app.zingsoft.com/demos/create/NG2O8JB3","default":"inherit","acceptedValues":["<string pixel value>"],"displayValues":["\"500px\"","\"500\"","500"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"icon-set","description":"Allows the user to change the grid icon set to an allowed 3rd-party type (e.g., Font-Awesome).\nTo use a custom icon set, the icon set must first be registered.","type":"String","fullName":"zing-grid-iconSet","demoLink":"https://app.zingsoft.com/demos/create/ICU6CTB5","default":"undefined","acceptedValues":["<string>"],"displayValues":["\"fa\"","\"fontawesome\"","\"font-awesome\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"lang","description":"Sets the language to use for the grid","type":"String","fullName":"zing-grid-lang","demoLink":"https://app.zingsoft.com/demos/create/ZBX1CFXE","default":"\"en\"","acceptedValues":["<string>"],"displayValues":["\"en\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"layout","description":"Sets the grid layout to be either `card` or `row` and adds `<zg-layout-controls>` to the grid.\nThe default is based on the size of the user's screen, unless `layout` is set.","type":"String","fullName":"zing-grid-layout","demoLink":"https://app.zingsoft.com/demos/create/UK168REV","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"card\"","\"row\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"layout-controls","description":"When `layout` is set, by default `layout-controls` is enabled.\nTo hide, set `layout-controls` to `disabled`.  Presence of this attribute will enable\n`<zg-layout-controls>` even if `layout` is not set.","type":"String | Boolean","fullName":"zing-grid-layoutControls","demoLink":"https://app.zingsoft.com/demos/create/ZOISX39K","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum | Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"loading","description":"Presence of attribute adds loading state to grid, which triggers `<zg-load-mask>` to show.\nThis attribute allows styling the height of the grid (via CSS) before the data has loaded in the grid.","type":"Boolean","fullName":"zing-grid-loading","demoLink":"https://app.zingsoft.com/demos/create/ZF838GXO","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"loading-text","description":"Sets the text to display in the `<zg-load-mask>` on data load","type":"String","fullName":"zing-grid-loadingText","demoLink":"https://app.zingsoft.com/demos/create/VC607IV8","default":"\"loading...\"","acceptedValues":["<string>"],"displayValues":["\"ZingGrid is Loading\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:loading:true"},{"name":"loadmask","description":"Set `loadmask=\"disabled\"` to prevent the `<zg-load-mask>` from showing on data load.","type":"String","fullName":"zing-grid-loadmask","demoLink":"https://app.zingsoft.com/demos/create/7SW1PDDR","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/7SW1PDDR"},{"name":"nested-data-separator","description":"Indicates separator that should be used for nested headers and data paths.  By default, the '.' is used: 'fullName.first'\nSetting to `disabled` will turn off parsing for nested headers and will not look at pathing for data","type":"String","fullName":"zing-grid-nestedDataSeparator","demoLink":"https://app.zingsoft.com/demos/create/OR8CFKQB","default":"\".\"","acceptedValues":["N/A"],"displayValues":["\"/\"","\"disabled\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/OR8CFKQB"},{"name":"no-data","description":"Sets the message that appears in the `<zg-no-data>` element when there are no records","type":"String","fullName":"zing-grid-noData","demoLink":"https://app.zingsoft.com/demos/create/J4VZX23V","default":"\"There are no records to display.\"","acceptedValues":["<string>"],"displayValues":["\"No Records\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"dataset"},{"name":"page-size","description":"Sets the number of records or rows to display per page. Can be set only if `pager` is set.","type":"Number","fullName":"zing-grid-pageSize","demoLink":"https://app.zingsoft.com/demos/create/81Z219UH","default":"50","acceptedValues":["<number>"],"displayValues":["10"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:pager:true"},{"name":"page-size-card","description":"Sets the number of cards to display per page when in card mode. Can be set only if `pager` is set.","type":"Number","fullName":"zing-grid-pageSizeCard","demoLink":"https://app.zingsoft.com/demos/create/PX40SN3K","default":"page-size value","acceptedValues":["<number>"],"displayValues":["10"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:layout:card"},{"name":"page-size-options","description":"Sets the options for page size in `zg-option-list`. Can be set only if `pager` is set.","type":"String","fullName":"zing-grid-pageSizeOptions","demoLink":"https://app.zingsoft.com/demos/create/3X4H4PE4","default":"\"5,10,50\"","acceptedValues":["<string separated number list>"],"displayValues":["\"15,20,35\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:pager:true"},{"name":"page-size-row","description":"Sets the number of rows to display per page when in row mode. Can be set only if `pager` is set.","type":"Number","fullName":"zing-grid-pageSizeRow","demoLink":"https://app.zingsoft.com/demos/create/W4XKN314","default":"page-size value","acceptedValues":["<number>"],"displayValues":["10"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:pager:true"},{"name":"pager","description":"Adds pagination functionality and controls to the grid","type":"Boolean","fullName":"zing-grid-pager","demoLink":"https://app.zingsoft.com/demos/create/LWCB9C12","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"pager-button-limit","description":"Determines max number of page buttons to display.  Default is 5.","type":"Number","fullName":"zing-grid-pagerButtonLimit","demoLink":"https://app.zingsoft.com/demos/create/4RGO3XLK","default":"5","acceptedValues":["Number"],"displayValues":["3"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:pager-type:button-arrow"},{"name":"pager-position","description":"Sets pager position. Note: `pager` attribute or `<zg-pager>` must be present in\norder to position pager.","type":"String","fullName":"zing-grid-pagerPosition","demoLink":"https://app.zingsoft.com/demos/create/NZGKTMFN","default":"\"bottom\"","acceptedValues":["Enum"],"displayValues":["\"top\"","\"bottom\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:pager:true"},{"name":"pager-type","description":"Determines which type of pagination to use, input or buttons","type":"String","fullName":"zing-grid-pagerType","demoLink":"https://app.zingsoft.com/demos/create/5EXGD7U7","default":"''","acceptedValues":["Enum"],"displayValues":["\"button-text\"","\"button-arrows\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:pager:true"},{"name":"params","description":"Name/Value pairs of `<zg-param>` values.  More appropriate to use `<zg-param>` in most cases.","type":"Object","fullName":"zing-grid-params","demoLink":"https://app.zingsoft.com/demos/create/CX509ALI","default":"{}","acceptedValues":["<object>"],"displayValues":["{\"idKey\": \"id\", \"sortByKey\": \"_sort\", \"sortBy\": \"capital\"}"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/CX509ALI"},{"name":"preserve-state-id","description":"The ID to use as the key in storing the state.  Each grid should have a unique ID or else the state data \nwill be shared across grids.","type":"String","fullName":"zing-grid-preserveStateId","demoLink":"https://app.zingsoft.com/demos/create/760HIL9C","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"zg-client-grid\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"It is recommended to enable other features (layout, pager, search, sort, etc) when testing this feature."},{"name":"preserve-state-load","description":"The method to call when state is ready to be retrieved.  Must also set preserveStateSave and preserveStateId","type":"String","fullName":"zing-grid-preserveStateLoad","demoLink":"https://app.zingsoft.com/demos/create/RQVTBRWY","default":"\"n/a\"","acceptedValues":["<string>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/RQVTBRWY"},{"name":"preserve-state-options","description":"Comma separated list of features to save in state preservation.  \nOptions are 'columnfrozen', 'columnposition', 'columnvisibility', 'columnwidth', 'filter', 'rowgroup', 'layout', 'page', 'pagesize', 'rowfrozen', 'rowgroup', 'rowselector', 'search', 'selector', 'sort'\nNOTE:  If columnfrozen is set, then columnposition will implicitly be set as well","type":"String","fullName":"zing-grid-preserveStateOptions","demoLink":"https://app.zingsoft.com/demos/create/R372W0RN","default":"\"all\"","acceptedValues":["<string>"],"displayValues":["\"sort, filter, search\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:preserve-state-id"},{"name":"preserve-state-save","description":"The method to call when state is ready to be saved.  Must also set preserveStateLoad and preserveStateId.","type":"String","fullName":"zing-grid-preserveStateSave","demoLink":"https://app.zingsoft.com/demos/create/RQVTBRWY","default":"\"n/a\"","acceptedValues":["<string>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/RQVTBRWY"},{"name":"record-count","description":"Sets the total record count.  Useful for `loadByPage` when the response packet\ndoes not return total count of records.","type":"Number","fullName":"zing-grid-recordCount","demoLink":"https://app.zingsoft.com/demos/create/QHPET8QF","default":"\"\"","acceptedValues":["<number>"],"displayValues":["1000"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/QHPET8QF"},{"name":"record-duplicate","description":"Adds the duplicate control to the end of the row before the edit controls","type":"Boolean","fullName":"zing-grid-recordDuplicate","demoLink":"https://app.zingsoft.com/demos/create/2J2B950P","default":"false","acceptedValues":["<boolean>"],"displayValues":["n/a"],"values":[],"category":"Attribute","tsType":"Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"record-key","description":"Adds the record key column to the grid.  If set to a string, the string is the header text.","type":"Boolean | String","fullName":"zing-grid-recordKey","demoLink":"https://app.zingsoft.com/demos/create/JOW2SKTW","default":"false","acceptedValues":["<string>"],"displayValues":["\"Name\""],"values":[],"category":"Attribute","tsType":"String | Boolean","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"dataset"},{"name":"row-class","description":"Adds a class to each `<zg-row>` element. To\napply a class conditionally, set the value to the name of the function to run\non each cell value. The function takes the parameters `data`, `rowIndex` (1-based),\n `domRow`, and `rowObject`, `rowParent`, `bodyRowIndex` (1 based), and returns a string which is the class name to apply.","type":"String","fullName":"zing-grid-rowClass","demoLink":"https://app.zingsoft.com/demos/create/YEF6YEV8","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"userClassName\"","\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/YEF6YEV8","storyControl":"select","storyOptions":"teal, textUppercase"},{"name":"row-details-renderer","description":"Renderer for the row details component\nTo use a custom renderer, the attribute should be set to the name of the function.\nThe renderer function takes in the following arguments, `recordData`, `domRowDetails`, and `rowObject`\nThe returned value of the renderer function is set as the innerHTML of the zg-row-details component.","type":"String","fullName":"zing-grid-rowDetailsRenderer","demoLink":"https://app.zingsoft.com/demos/create/WXLCYC8S","default":"\"\"","acceptedValues":["<String>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"2.x.x","storyAlert":"https://app.zingsoft.com/demos/create/WXLCYC8S"},{"name":"row-details-template","description":"Points to an external template element to be used as the template for the row's details","type":"String","fullName":"zing-grid-rowDetailsTemplate","demoLink":"https://app.zingsoft.com/demos/create/VZXL4P1R","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"myTemplateId\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"2.x.x","storyAlert":"https://app.zingsoft.com/demos/create/VZXL4P1R"},{"name":"row-height","description":"Sets the height of each data row.  By default, the body row height is set to 'auto' where it will auto fit the content.\nIf you wish to apply the height to rows besides data row, specify with the `[rowHeightScope]` attribute.","type":"String | Number","fullName":"zing-grid-rowHeight","demoLink":"https://app.zingsoft.com/demos/create/0ABNLHKV","default":"\"auto\"","acceptedValues":["<string>","<number>"],"displayValues":["\"auto\"","\"48px\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"2.x.x"},{"name":"row-height-scope","description":"If `[rowHeight]`  is set, it specifies which rows to apply row height to.\nChoices are `data`, `headers, and `all`.  Can combine with comma separated list","type":"String","fullName":"zing-grid-rowHeightScope","demoLink":"https://app.zingsoft.com/demos/create/IJJX1SOW","default":"\"data\"","acceptedValues":["<comma separated enum list>"],"displayValues":["\"data\"","\"headers\"","\"all\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"2.x.x"},{"name":"row-selector","description":"Adds `selector` type column to the rows as the first column","type":"Boolean","fullName":"zing-grid-rowSelector","demoLink":"https://app.zingsoft.com/demos/create/OW6D6ADD","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"recommend:editor-controls:true"},{"name":"search","description":"Turns on the search feature and adds `<zg-search>` to the grid.\nThe search button appears in the caption header.","type":"Boolean","fullName":"zing-grid-search","demoLink":"https://app.zingsoft.com/demos/create/JTKMYN3V","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"selector","description":"Turns on the selector feature on the grid and adds\n`<zg-selector-mask>` to the grid","type":"Boolean","fullName":"zing-grid-selector","demoLink":"https://app.zingsoft.com/demos/create/W591I8MY","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"server-rendered","description":"Indicates that the grid was completely rendered on the server and embedded in the page","type":"Boolean","fullName":"zing-grid-serverRendered","demoLink":"http://app.zingsoft.com/demos/create/CLJKANYJ","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"http://app.zingsoft.com/demos/create/CLJKANYJ"},{"name":"sort","description":"Enables sorting on all columns.  It is possible to disable specific columns\nvia the column's object or setting `sort=\"disabled\"` to specified columns.","type":"Boolean","fullName":"zing-grid-sort","demoLink":"https://app.zingsoft.com/demos/create/0LV2QHO9","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"sort-intl","description":"Overrides default behavior for international sorting.  Turn off international sorting with `sort-intl=\"disabled\"`.","type":"String","fullName":"zing-grid-sortIntl","demoLink":"https://app.zingsoft.com/demos/create/15S1N2OD","default":"\"\"","acceptedValues":["Enum"],"displayValues":["\"disabled\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/15S1N2OD"},{"name":"sorter","description":"Override the column sorting by passing in method name of sort function instead.  Sorter function\ntakes in two values (a, b) and returns 1, -1, or 0 indicating if `a > b`, `a < b`, or `a = b`.","type":"String","fullName":"zing-grid-sorter","demoLink":"https://app.zingsoft.com/demos/create/7UT0EEI4","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"functionName\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/7UT0EEI4"},{"name":"source","description":"Defines the source of the data in the grid. Adds the `<zg-source>` element.","type":"String","fullName":"zing-grid-source","demoLink":"https://app.zingsoft.com/demos/create/GEEBIRSG","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"Source: Wikipedia\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"src","description":"Specifies the absolute or relative URL to fetch data from to populate the grid","type":"String","fullName":"zing-grid-src","demoLink":"https://app.zingsoft.com/demos/create/P607ZSA3","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"https://url-to-your-api\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"static-menu","description":"Adds a display button that launches the contextmenu.  If\nset to a custom menu and `<zg-menu>` has the `replace` attribute present, then the custom menu will replace the context-menu.\nOtherwise the contents of the custom menu is appended to the end of context menu.\nNote that custom static-menu cannot not be used together with a `\"browser\"` context-menu.","type":"Boolean","fullName":"zing-grid-staticMenu","demoLink":"https://app.zingsoft.com/demos/create/M8C1YMB8","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"status-delay","description":"Changes the duration a status message will remain visible until it automatically closes (in milliseconds)","type":"Number","fullName":"zing-grid-statusDelay","demoLink":"https://app.zingsoft.com/demos/create/ZFMD4YHD","default":"\"3000\"","acceptedValues":["Any number (in milliseconds)"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/ZFMD4YHD"},{"name":"status-persist","description":"Prevents status messages from automatically closing after a delay","type":"Boolean","fullName":"zing-grid-statusPersist","demoLink":"https://app.zingsoft.com/demos/create/4D5FTJBG","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/4D5FTJBG"},{"name":"status-position","description":"Positions the status message in one of nine positions relative to the grid","type":"String","fullName":"zing-grid-statusPosition","demoLink":"https://app.zingsoft.com/demos/create/KRKIHPFC","default":"\"top right\"","acceptedValues":["Enum"],"displayValues":["\"top left\"","\"center left\"","\"bottom left\"","\"top center\"","\"center\"","\"bottom center\"","\"top right\"","\"center right\"","\"bottom right\"","\"bar\""],"values":[],"category":"Attribute","tsType":"Enum","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/KRKIHPFC"},{"name":"template-end-delimiter","description":"Defines the regex expression for closing data binding","type":"String","fullName":"zing-grid-templateEndDelimiter","demoLink":"https://app.zingsoft.com/demos/create/DRUZJ8JY","default":"\"]]\"","acceptedValues":["<string>"],"displayValues":["\"}}\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/DRUZJ8JY"},{"name":"template-start-delimiter","description":"Defines the regex expression for starting data binding","type":"String","fullName":"zing-grid-templateStartDelimiter","demoLink":"https://app.zingsoft.com/demos/create/DRUZJ8JY","default":"\"[[\"","acceptedValues":["<string>"],"displayValues":["\"{{\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/DRUZJ8JY"},{"name":"theme","description":"Sets the theme of the grid.  Built-in themes are specified by keyword, but custom theme\nnames are also accepted by setting a URL path to your custom css theme file.  For custom themes, on load set `theme`\nto the path to the custom theme file.  After, set to theme name to switch themes.","type":"String","fullName":"zing-grid-theme","demoLink":"https://app.zingsoft.com/demos/create/UAP0KFF1","default":"\"default\"","acceptedValues":["Enum"],"displayValues":["\"android\"","\"black\"","\"default\"","\"dark\"","\"ios\"","\"urlToThemeFile\"","\"customThemeName\""],"values":[],"category":"Attribute","tsType":"Enum | String","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"type-selector-page-persist","description":"If there is a selector column, it maintains selection between pages.  This means that rows can be selected and not on the current page.","type":"Boolean","fullName":"zing-grid-typeSelectorPagePersist","demoLink":"","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"2.x.x"},{"name":"validation-error-message","description":"Sets the default validation error message","type":"String","fullName":"zing-grid-validationErrorMessage","demoLink":"https://app.zingsoft.com/demos/create/Q5IXSMBQ","default":"\"Validation Failed\"","acceptedValues":["<string>"],"displayValues":["\"Please provide valid input.\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/Q5IXSMBQ"},{"name":"validation-required-message","description":"Sets the default validation required message","type":"String","fullName":"zing-grid-validationRequiredMessage","demoLink":"https://app.zingsoft.com/demos/create/WDVQXHYG","default":"\"Field Required\"","acceptedValues":["<string>"],"displayValues":["\"Please provide valid input.\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x","storyAlert":"https://app.zingsoft.com/demos/create/WDVQXHYG"},{"name":"viewport","description":"Internal attribute.  Should not be set.","type":"String","fullName":"zing-grid-viewport","demoLink":"","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"viewport-pause","description":"Keeps current value of `viewport` and freezes the breakpoint","type":"Boolean","fullName":"zing-grid-viewportPause","demoLink":"https://app.zingsoft.com/demos/create/JQPB9V1U","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"viewport-stop","description":"Removes `viewport` attribute, disabling viewport resizing","type":"Boolean","fullName":"zing-grid-viewportStop","demoLink":"https://app.zingsoft.com/dmos/create/1IO1C18N","default":"\"\"","acceptedValues":["N/A"],"displayValues":["N/A"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"viewport-types","description":"Sets custom `viewport` breakpoints (value string-object must be valid JSON).\nNOTE: If you don't set `mobile`, the grid won't auto-set card or row mode.","type":"String","fullName":"zing-grid-viewportTypes","demoLink":"https://app.zingsoft.com/demos/create/HABTF2ID","default":"false","acceptedValues":["<string>"],"displayValues":["{ mobile: 500, test: 600, desktop: 800 }"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"width","description":"Sets the width of the grid.  If the width is less than the size of the content, scroll is added to `<zg-body>`.","type":"String | Number","fullName":"zing-grid-width","demoLink":"https://app.zingsoft.com/demos/create/MIYZG4F2","default":"inherit","acceptedValues":["<string length value>"],"displayValues":["\"500\"","\"500px\"","\"5em\"","\"5%\"","\"50vw\"","500"],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"},{"name":"zebra","description":"Presence of attribute adds the classes, `zebra-1` and `zebra-2`, alternating on `<zg-row>` elements.  Setting to a\nlist of class names will assign classes in sequential order.  For conditional zebra classes, `zebra` also accepts name of function that\nreturns a class name to use for zebra striping.","type":"String","fullName":"zing-grid-zebra","demoLink":"https://app.zingsoft.com/demos/create/QXWXL4WD","default":"\"\"","acceptedValues":["<string>"],"displayValues":["\"userCustomStyle\""],"values":[],"category":"Attribute","tsType":"","internalDocs":"","tagName":"zing-grid","version":"1.x.x"}]}}