zinggrid/docs_output/methods/zg-column-api-methods.json

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

[{"name":"column","description":"Fetches the targeted column.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/YG2ADVW8","acceptedValues":[],"displayValues":[],"params":[{"type":"Array","description":"Field index of column to fetch.","name":"fieldIndex"}],"returns":[{"type":"Object","description":"Column object."}],"tagName":"zing-grid","fullName":"zing-grid-method-column","category":"Method"},{"name":"filterColumn","description":"Filters the column specified by column index. Note: `filter` attribute must be present for\nthis method to work.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/N3YC3ANH","acceptedValues":[],"displayValues":["('firstName', 'John')"],"params":[{"type":"String","description":"Index of column.","name":"columnIndex"},{"type":"String","description":"Filter string.","name":"filter"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-filterColumn","category":"Method"},{"name":"getColClass","description":"Gets the value of the `col-class` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/DWFXF284","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute"}],"tagName":"zing-grid","fullName":"zing-grid-method-getColClass","category":"Method"},{"name":"getFrozenColumnsLeft","description":"Gets the value of the `frozen-columns-left` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/H9DBXDZP","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute"}],"tagName":"zing-grid","fullName":"zing-grid-method-getFrozenColumnsLeft","category":"Method"},{"name":"getFrozenColumnsRight","description":"Gets the value of the `frozen-columns-right` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/Q0AZYCO8","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"String","description":"Value of the attribute"}],"tagName":"zing-grid","fullName":"zing-grid-method-getFrozenColumnsRight","category":"Method"},{"name":"getHeaderAutoFormat","description":"Gets the value of the `header-auto-format` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/UJ1F3ZZ5","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"Boolean","description":"Value of the attribute"}],"tagName":"zing-grid","fullName":"zing-grid-method-getHeaderAutoFormat","category":"Method"},{"name":"getNestedDataSeparator","description":"Gets the value of the `nested-data-separator` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/S7MVK7MR","acceptedValues":[],"displayValues":[],"params":[],"returns":[{"type":"Boolean","description":"Value of the attribute"}],"tagName":"zing-grid","fullName":"zing-grid-method-getNestedDataSeparator","category":"Method"},{"name":"hideColumn","description":"Hides a column based on index","type":null,"demoLink":"https://app.zingsoft.com/demos/create/HNG153JM","acceptedValues":[],"displayValues":["firstName"],"params":[{"type":"String","description":"Index of column to hide","name":"columnIndex"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-hideColumn","category":"Method"},{"name":"setColClass","description":"Sets the `col-class` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/F22M97JN","acceptedValues":[],"displayValues":["\"userClassName\"","\"functionName\""],"params":[{"type":"String","description":"Class name or function name","name":"type"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setColClass","category":"Method"},{"name":"setColumns","description":"Sets the `columns` property","type":null,"demoLink":"https://app.zingsoft.com/demos/create/2KXB4WP6","acceptedValues":[],"displayValues":["Array"],"params":[{"type":"Array","description":"Array of column objects","name":"columns"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setColumns","category":"Method"},{"name":"setColumnsControl","description":"Sets the `columns-control` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/4BO1V47O","acceptedValues":[],"displayValues":["true","false"],"params":[{"type":"Boolean","description":"Value to add or remove","name":"activate"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setColumnsControl","category":"Method"},{"name":"setFrozenColumnsLeft","description":"Sets the `frozen-columns-left` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/RFEN3LCZ","acceptedValues":[],"displayValues":["1"],"params":[{"type":"Number","description":"The number of columns to freeze to the left","name":"type"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setFrozenColumnsLeft","category":"Method"},{"name":"setFrozenColumnsRight","description":"Sets the `frozen-columns-right` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/LSSHGJPP","acceptedValues":[],"displayValues":["1"],"params":[{"type":"Number","description":"The number of columns to freeze to the right","name":"type"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setFrozenColumnsRight","category":"Method"},{"name":"setHeaderAutoFormat","description":"Sets the `header-auto-format` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/9Q9QPOXB","acceptedValues":[],"displayValues":["true","false"],"params":[{"type":"Boolean","description":"Value to add or remove","name":"activate"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setHeaderAutoFormat","category":"Method"},{"name":"setNestedDataSeparator","description":"Sets the `nested-data-separator` attribute","type":null,"demoLink":"https://app.zingsoft.com/demos/create/RMRSFXAI","acceptedValues":[],"displayValues":["\".\"","\"/\"","\"disabled\""],"params":[{"type":"String","description":"The separator value","name":"separator"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-setNestedDataSeparator","category":"Method"},{"name":"showColumn","description":"Sets column to be visible","type":null,"demoLink":"https://app.zingsoft.com/demos/create/UQHH8ZQ1","acceptedValues":[],"displayValues":["firstName"],"params":[{"type":"String","description":"Index of column to show","name":"columnIndex"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-showColumn","category":"Method"},{"name":"sortColumn","description":"Sorts the given column with the given sort direction","type":null,"demoLink":"https://app.zingsoft.com/demos/create/ON5CARNY","acceptedValues":[],"displayValues":["(firstName, asc)","(firstName, desc)","(firstName)"],"params":[{"type":"String","description":"Index of column to sort","name":"columnIndex"},{"type":"String","description":"Sort Direction: asc, desc, or none","name":"direction"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-sortColumn","category":"Method"},{"name":"toggleColumn","description":"Toggles the visibility of a column by index","type":null,"demoLink":"https://app.zingsoft.com/demos/create/9EUFZQIR","acceptedValues":[],"displayValues":["(firstName, true)","(firstName, false)"],"params":[{"type":"String","description":"Index of column to toggle","name":"columnIndex"},{"type":"Boolean","description":"Visibility of column","name":"hide"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-toggleColumn","category":"Method"}]