zinggrid/docs_output/objectMethods/methods.json

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

{"ZingGrid":{"methods":[{"name":"customizeDialog","description":"Customizes the user's dialog for all instances of ZingGrid","type":null,"demoLink":"","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"The type of dialog to customize.  If you set as null, the config will be applied to all dialogs.\nOptions are:\n<ul>\n<li>record-create\n<li>record-delete\n<li>record-info\n<li>record-update\n<li>view-error\n<li>view-info\n<li>view-success\n<li>view-warn\n<li>zg-version\n</ul>","name":"type"},{"type":"Object","description":"Options for the data retrieval.  Options are:\n<ul>\n<li>cancel: Text for the Cancel Button\n<li>confirm: Text for the Confirm Button\n<li>label: Label to display on the Dialog\n</ul>","name":"config"}],"returns":[{"type":"ZingGrid","description":"Returns the component so that you can chain methods together"}],"tagName":"zing-grid","fullName":"zing-grid-method-customizeDialog","category":"Method"},{"name":"formatDate","description":"Formats a Date","type":null,"demoLink":"https://app.zingsoft.com/demos/create/K05RV08J","acceptedValues":[],"displayValues":[],"params":[{"type":"String | Date","description":"The Date to format","name":"date"},{"type":"String","description":"The tokenized format to format the date","name":"format"},{"type":"String","description":"The locale to use for the formatting.  Optional.","name":"locale"}],"returns":[{"type":"String","description":"Formatted date"}],"tagName":"zing-grid","fullName":"zing-grid-method-formatDate","category":"Method"},{"name":"fromNow","description":"Formats a Date in from now format","type":null,"demoLink":"https://app.zingsoft.com/demos/create/DOHQJTDO","acceptedValues":[],"displayValues":[],"params":[{"type":"Date","description":"The Date to format","name":"date"},{"type":"Boolean","description":"Indicates if we should include 'ago/to' to indicate past/future","name":"raw"}],"returns":[{"type":"String","description":"Formatted date from now"}],"tagName":"zing-grid","fullName":"zing-grid-method-fromNow","category":"Method"},{"name":"registerAdapter","description":"Register a method to make connecting a remote data src to your grid even easier. If you\nhave your own standardized endpoints this is very useful. A way for us to provide an ES6 style import\n mechanism and pattern for building custom data sources.","type":null,"demoLink":"","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"The string name for the adapter","name":"sType"},{"type":"Object","description":"Option list of of adapter variables you want to define. You can define ANY\nzg-param name value pair here in this option. Refer to the Store.js variable this.oDefaultDataFormat","name":"oOptions"}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-registerAdapter","category":"Method"},{"name":"registerCellType","description":"Register a custom column type to reduce redundant markup and re-use\nsimilar code.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/T7YD4CIL","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"Name of cell type.","name":"sType"},{"type":"Object","description":"An object to define the renderer and/or editor for the cell type.","name":"oOptions"}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-registerCellType","category":"Method"},{"name":"registerEditor","description":"Register the life cycle hooks for cell editing. This allows you to import\nand inherit editors for your library.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/AKZ56TZW","acceptedValues":[],"displayValues":[],"params":[{"type":"String","description":"Cell type editor to override","name":"sCellType"},{"type":"Object","description":"Object containing editor hooks","name":"oConfig"}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-registerEditor","category":"Method"},{"name":"registerMethod","description":"Register a method to make it available to ZingGrid even if it outside the window scope.\nThis can be used to make a method accessible to renderer, editor, sorter, and custom styles\nThis is useful for methods within a class or local methods.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/IS6Q1HGM","acceptedValues":[],"displayValues":[],"params":[{"type":"function","description":"The method that you wish to expose to ZingGrid.","name":"method"},{"type":"String","description":"The name to refer to the method.  If the method is not anonymous, the name will default to the\nname of the method.  If it is anonymous, a name must be set.  Whatever is set here is how you should refer to the method\nin the grid. Optional.","name":"name"},{"type":"Object","description":"The scope of the method.  When the method is called `this` will be set to the `scope` value. Optional.","name":"scope"}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-registerMethod","category":"Method"},{"name":"registerNamespace","description":"Register a namespace to make it available to ZingGrid even if it outside the window scope.\nOnce a namespace is registered, the methods within the namespace will be accessible to ZingGrid without having to call `ZingGrid.registerMethod`","type":null,"demoLink":"https://app.zingsoft.com/demos/create/SV33R7QE","acceptedValues":[],"displayValues":[],"params":[{"type":"function","description":"The namespace that you wish to expose to ZingGrid.","name":"namespace"},{"type":"String","description":"The name to refer to the namespace. Optional.","name":"name"},{"type":"Object","description":"The scope of the namespace.  When a method within the namespace is called, `this` will be set to the `scope` value.\nDefaults to the namespace itself. Optional.","name":"scope"}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-registerNamespace","category":"Method"},{"name":"registerValidator","description":"Register the life cycle hooks for cell validation. This allows you to import\nand inherit validators for your library.","type":null,"demoLink":"","acceptedValues":[],"displayValues":[],"params":[{"type":"Object","description":"The validator that you wish to expose to ZingGrid.","name":"oValidator"},{"type":"String","description":"The name to refer to the validator. Optional.","name":"name"},{"type":"Object","description":"The scope of the method.  When the method is called `this` will be set to the `scope` value. Optional.","name":"scope"}],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-registerValidator","category":"Method"},{"name":"searchIsTable","description":"Searches for table element(s) with the `[is=\"zing-grid\"]` attribute to\ninsert the zing-grid. This method should only be used when `table[is=\"zing-grid\"]`\nis added after the Document has been loaded.","type":null,"demoLink":"https://app.zingsoft.com/demos/create/5RH46IV4","acceptedValues":[],"displayValues":[],"params":[],"returns":[],"tagName":"zing-grid","fullName":"zing-grid-method-searchIsTable","category":"Method"}]}}