Class Index | File Index

Classes


Class LABKEY.GridView

DEPRECATED - Consider using Ext.grid.EditorGridPanel instead.

The LABKEY.ext.EditorGridPanel class is very similar to this class, except that it is a proper extension of the Ext.grid.EditorGridPanel class, and thus exposes all of its properties, methods, and events, and can participate in complex Ext layouts.

To transition from this class to the new LABKEY.ext.EditorGridPanel class, follow these steps:


Defined in: GridView.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
LABKEY.GridView(config)
Config Summary
Config Attributes Config Name and Description
 
Callback function that allows you to adjust the column model without providing a full GridPanel config.
 
The container path in which the schemaName and queryName are defined.
 
Whether the grid should be made editable.
 
Function that should be called after the grid has been constructed and populated with data.
 
Sets the display configuration for the new grid.
 
Name of a query defined within the specified schema in the current container.
 
Name of the div in which to place the grid.
 
Name of a schema defined within the current container.
 
Config object that is passed to the underlying Store.
 
Name of a custom view defined over the specified query.
Method Summary
Method Attributes Method Name and Description
 
Returns the Ext.data.Store used to manage the data displayed in the grid.
 
Renders the grid view to the div specified in the renderTo config property.
Class Detail
LABKEY.GridView(config)
Parameters:
{Object} config
Describes the GridView's properties.
Config Detail
{Function(columnModel)} config.columnModelListener
Callback function that allows you to adjust the column model without providing a full GridPanel config. The columnModel element/object contains information about how one may interact with the columns within a user interface. This format is generated to match the requirements of the Ext grid component. See Ext.grid.ColumnModel for further information.

{String} config.containerPath
The container path in which the schemaName and queryName are defined. If not supplied, the current container path will be used.

{Bool} config.editable
Whether the grid should be made editable. Note that not all tables and columns are editable, and not all users have permission to edit. For this reason, part or all of the grid may degrade to being non-editable despite the 'editable' parameter.

{Function(Ext.grid.GridPanel)} config.gridCustomizeCallback
Function that should be called after the grid has been constructed and populated with data. You can use this to further customize the grid's appearance, add toolbar buttons, or call any method on the Ext GridPanel object. The function passed as this config property should look like this:

{Object} config.gridPanelConfig
Sets the display configuration for the new grid. This configuration is passed through to the underlying Ext.grid.GridPanel implementation, so all GridPanel config options are valid.

Note that providing this configuration is optional. Further, if you do provide it, you take responsibility for providing a valid and complete config object. If you do not set the GridPanel config, LabKey Server will use a default configuration option.


{Object} config.queryName
Name of a query defined within the specified schema in the current container. Example: 'SpecimenDetail'. See also: How To Find schemaName, queryName & viewName.

{String} config.renderTo
Name of the div in which to place the grid.

{Object} config.schemaName
Name of a schema defined within the current container. Example: 'study'. See also: How To Find schemaName, queryName & viewName.

{Object} config.storeConfig
Config object that is passed to the underlying Store. This configuration is passed through to the underlying Ext.data.Store implementation, so all Store config options are valid.

Note that providing this configuration is optional. Further, if you do provide it, you take responsibility for providing a valid and complete config object. If you do not set the Store config, LabKey Server will use a default configuration option.


{Object} config.viewName
Name of a custom view defined over the specified query. in the current container. Example: 'SpecimenDetail'. See also: How To Find schemaName, queryName & viewName.
Method Detail
getStore()
Returns the Ext.data.Store used to manage the data displayed in the grid. You can use the returned object to programmatically manipulate the store.

See http://www.extjs.com/deploy/dev/docs/?class=Ext.data.Store for more information on the Ext.data.Store class.

Example:
//this code will programmatically refresh the data
//displayed in the myGrid object
myGrid.getStore().reload();

render()
Renders the grid view to the div specified in the renderTo config property.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Jun 11 2020 17:30:56 GMT-0000 (UTC)