Constructordojox.VirtualGrid

dojo.require("dojox.grid.VirtualGrid");
defined in dojox/grid/VirtualGrid.js

VirtualGrid provides the full set of grid features without any direct connection to a data store.

The grid exposes a get function for the grid, or optionally individual columns, to populate cell contents.

The grid is rendered based on its structure, an object describing column and cell layout.

Usage

function ()
parametertypedescription
paramsObjectOptional.
srcNodeRefDomNode|String 

Examples

Example 1

A quick sample:

define a get function function get(inRowIndex){ // called in cell context return [this.index, inRowIndex].join(', '); }

define the grid structure: var structure = [ // array of view objects { cells: [// array of rows, a row is an array of cells [ { name: "Alpha", width: 6 }, { name: "Beta" }, { name: "Gamma", get: get }] ]} ];


Jump to PropertiesFunctionsBack to top

Add a row to the grid.
Use to make multiple changes to rows while queueing row updating. NOTE: not currently supporting nested begin/endUpdate calls
Construct the UI for this widget from a template, setting this.domNode.
FunctioncanSort(inSortInfo: Integer)
Determines if the grid can be sorted
Functionconnect(obj: Object, event: String, method: String|Function)
Defined by dijit._Widget
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
Functioncreate(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
Kick off the life-cycle of a widget
Creates a new Grid layout
create grid managers for various tasks including rows, focus, selection, editing row manager
Creates a new virtual scroller
FunctioncreateView(inClass)
Functiondestroy(finalize: Boolean)
Overrides dijit._Widget
Destroy this widget, but not its descendants
Defined by dijit._Widget
Recursively destroy the children of this widget and their descendants.
Defined by dijit._Widget
Destroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
Defined by dijit._Widget
Destroys the DOM nodes associated with this widget
Functiondisconnect(handles: Object)
Defined by dijit._Widget
Disconnects handle created by this.connect. Also removes handle from this widget's list of connects
FunctiondoApplyCellEdit(inValue, inRowIndex, inFieldIndex)
FunctiondoApplyEdit(inRowIndex)
FunctiondoCancelEdit(inRowIndex)
FunctiondoStartEdit(inCell, inRowIndex)
Use after calling beginUpdate to render any changes made to rows.
Functionget(inRowIndex: Integer)
Default data getter.
FunctiongetCell(inIndex: Integer)
Retrieves the cell object for a given grid column.
FunctiongetCellName(inCell)
Returns the cell name of a passed cell
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
FunctiongetSortAsc(inSortInfo)
Returns true if grid is sorted in an ascending direction.
FunctiongetSortIndex(inSortInfo)
Returns the index of the column on which the grid is sorted
Defined by dijit._Widget
Return true if this widget can currently be focused and false if not
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.
Overrides dijit._Widget
Called after a widget's dom has been setup
Defined by dijit._Widget
Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
Functionpostscript(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
Remove the selected rows from the grid.
FunctionrenderRow(inRowIndex, inNodes)
private, used internally to render rows
Functionresize(sizeBox: Object?)
Update the grid's rendering dimensions and resize it
Update grid when the height of a row has changed. Row height is handled automatically as rows are rendered. Use this function only to update a row's height outside the normal rendering process.
FunctionrowRemoved(inRowIndex)
private, used internally to remove rows
FunctionscrollTo(inTop: Integer)
Vertically scroll the grid to a given pixel position
FunctionscrollToRow(inRowIndex: Integer)
Scroll the grid to a specific row.
FunctionsetAttribute(attr: String, value)
Defined by dijit._Widget
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
FunctionsetCellWidth(inIndex, inUnitWidth)
FunctionsetScrollTop(inTop)
FunctionsetSortIndex(inIndex: Integer, inAsc: Boolean)
Sort the grid on a column in a specified direction
FunctionsetSortInfo(inSortInfo)
FunctionsetStructure(inStructure: Object)
Install a new structure and rebuild the grid.
Functionsort()
Defined by dijit._Widget
Called after a widget's children, and other widgets on the page, have been created. Provides an opportunity to manipulate any children before they are displayed. This is useful for composite widgets that need to control or layout sub-widgets. Many layout widgets can use this as a wiring phase.
FunctionstyleRowNode(inRowIndex, inRowNode)
Defined by dijit._Widget
Defined by dijit._Widget
stub function. Override to implement custom widget tear-down behavior.
FunctionupdateRow(inRowIndex: Integer)
Render a single row.
FunctionupdateRowCount(inRowCount: Integer)
Change the number of rows.
FunctionupdateRowStyles(inRowIndex)
Update the styles for a row after it's state has changed.
Function_attachTemplateNodes(rootNode: DomNode, getAttrFunc: Function?)
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Function_dispatch(m, e)
Defined by dijit._Templated
relocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown
Defined by dijit._Widget
Defined by dijit._Widget
Defined by dijit._Templated

Jump to FunctionsPropertiesBack to top

Defined by dijit._Widget
A map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
If autoHeight is true, grid height is automatically set to fit the data.
If autoRender is true, grid will render itself after initialization.
If autoWidth is true, grid width is automatically set to fit the data.
Defined by dijit._Widget
HTML class attribute
CSS class applied to the grid's domNode
Defined by dijit._Templated
holds child elements. "containerNode" is generally set via a dojoAttachPoint assignment and it designates where children of the src dom node will be placed
default height of the grid, measured in any valid css unit.
Defined by dijit._Widget
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
this is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPonit syntax, but the domNode property is the canonical "top level" node in widget UI.
Override defaults and make the indexed grid view elastic, thus filling available horizontal space.
flag modifies vertical scrolling behavior. Defaults to true but set to false for slower scroll performance but more immediate scrolling feedback
Defined by dijit._Widget
a unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
Number of rows to keep in the rendering cache.
Defined by dijit._Widget
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Integer Number of rows to display.
Number of rows to render at a time.
pixel distance a user must scroll vertically to trigger grid scrolling.
Single-click starts editing. Default is double-click
Defined by dijit._Widget
pointer to original dom node
View layout defintion. Can be set to a layout object, or to the (string) name of a layout object.
Defined by dijit._Widget
HTML style attribute
Defined by dijit._Templated
a node that represents the widget template. Pre-empts both templateString and templatePath.
Overrides dijit._Templated
Path to template (HTML file) for this widget relative to dojo.baseUrl
Defined by dijit._Templated
a string that represents the widget template. Pre-empts the
Defined by dijit._Widget
Defined by dijit._Templated
should we parse the template to find widgets that might be declared in markup inside it? false by default.
Defined by dijit._Widget