dojox/grid/DataGrid (version 1.10)

dojox/grid/_Grid

Usage

var foo = new DataGrid(params,srcNodeRef);
dijit/_Widget
Parameter Type Description
params Object | null

Hash of initialization parameters for widget, including scalar values (like title, duration etc.) and functions, typically callbacks like onClick. The hash can contain any of the widget's properties, excluding read-only properties.

srcNodeRef DOMNode | String
Optional

If a srcNodeRef (DOM node) is specified:

  • use srcNodeRef.innerHTML as my contents
  • if this is a behavioral widget then apply behavior to that srcNodeRef
  • otherwise, replace srcNodeRef with my generated DOM tree

See the dojox/grid/DataGrid reference documentation for more information.

Property Summary

  • _attachEventsList of connections associated with data-dojo-attach-event=... in the template
  • _attachPointsList of widget attribute names associated with data-dojo-attach-point=... in the template, ex: ["containerNode", "labelNode"]
  • _attrPairNames
  • _blankGifPath to a blank 1x1 image.
  • _bop
  • _by_idty
  • _by_idx
  • _cache
  • _click
  • _eop
  • _focusManager
  • _isLoaded
  • _isLoading
  • _pages
  • _pending_requests
  • _placeholders
  • _renderedNot normally use, but this flag can be set by the app if the server has already rendered the template, i.e. already inlining the template for the widget into the main page.
  • _requests
  • _setClassAttr
  • _setDirAttr
  • _setIdAttr
  • _setLangAttr
  • _setSummaryAttr
  • _setTypeAttr
  • _skipNodeCache
  • _startedstartup() has completed.
  • _store_connects
  • attachScopeObject to which attach points and events will be scoped.
  • attributeMapDeprecated.
  • autoHeightIf autoHeight is true, grid height is automatically set to fit the data.
  • autoRenderIf autoRender is true, grid will render itself after initialization.
  • autoWidthIf autoWidth is true, grid width is automatically set to fit the data.
  • baseClassRoot CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate widget state.
  • cellOverClasscss class to apply to grid cells over which the cursor is placed.
  • class
  • classTagCSS class applied to the grid's domNode
  • columnReorderingIf set to true, will add drag and drop reordering to views with one row of columns.
  • containerNodeDesignates where children of the source DOM node will be placed. "Children" in this case refers to both DOM nodes and widgets.
  • defaultHeightdefault height of the grid, measured in any valid css unit.
  • delayScroll
  • dirBi-directional support, as defined by the HTML DIR attribute.
  • domNodeThis is our visible representation of the widget!
  • editableindicates if the grid contains editable cells, default is false set to true if editable cell encountered during rendering
  • elasticViewOverride defaults and make the indexed grid view elastic, thus filling available horizontal space.
  • errorMessageMessage that shows when the grid encounters an error loading
  • escapeHTMLInDataThis will escape HTML brackets from the data to prevent HTML from user-inputted data being rendered with may contain JavaScript and result in XSS attacks.
  • fastScrollflag modifies vertical scrolling behavior.
  • fetchText
  • focusedThis widget or a widget it contains has focus, or is "active" because it was recently clicked.
  • formatterScopeAn object to execute format functions within.
  • headerMenuIf set to a dijit.Menu, will use this as a context menu for the grid headers.
  • heightexplicit height of the grid, measured in any valid css unit.
  • idA unique, opaque ID string that can be assigned by users or by the system.
  • initialWidthA css string to use to set our initial width (only used if autoWidth is true).
  • invalidated
  • items
  • keepRowsNumber of rows to keep in the rendering cache.
  • keepSelectionWhether keep selection after sort, filter etc.
  • langRarely used.
  • loadingMessageMessage that shows while the grid is loading
  • noDataMessageMessage that shows if the grid has no data - wrap it in a span with class 'dojoxGridNoData' if you want it to be styled similar to the loading and error messages
  • observer
  • ownerDocumentThe document this widget belongs to.
  • placeholderLabelLabel of placeholders to search for in the header menu to replace with column toggling menu items.
  • query
  • queryOptions
  • rowCount
  • rowHeightIf rowHeight is set to a positive number, it will define the height of the rows in pixels.
  • rowSelectorIf set to true, will add a row selector view to this grid.
  • rowsPerPageNumber of rows to render at a time.
  • scrollRedrawThresholdpixel distance a user must scroll vertically to trigger grid scrolling.
  • searchContainerNode
  • selectableSet to true if you want to be able to select the text within the grid.
  • selectionModeSet the selection mode of grid's Selection.
  • singleClickEditSingle-click starts editing.
  • sortFields
  • sortInfo
  • srcNodeRefpointer to original DOM node
  • store
  • structureView layout definition.
  • styleHTML style attributes as cssText string or name/value hash
  • summaryCustomizable summary descriptions which will be added to grid.domNode
  • templatePathPath to template (HTML file) for this widget relative to dojo.baseUrl.
  • templateString
  • titleHTML title attribute.
  • tooltipWhen this widget's title attribute is used to for a tab label, accordion pane title, etc., this specifies the tooltip to appear when the mouse is hovered over that text.
  • updateDelayTime, in milliseconds, to delay updates automatically so that multiple calls to onSet/onNew/onDelete don't keep rerendering the grid.
  • updating

Method Summary

Event Summary

  • _onBlur() This is where widgets do processing for when they stop being active, such as changing CSS classes.
  • _onDelete(item)
  • _onFetchBegin(size,req)
  • _onFetchComplete(items,req)
  • _onFetchError(err,req)
  • _onFocus() This is where widgets do processing for when they are active, such as changing CSS classes.
  • _onMap(type) Maps on() type parameter (ex: "mousemove") to method name (ex: "onMouseMove").
  • _onNew(item,parentInfo)
  • _onRevert()
  • _onSet(item,attribute,oldValue,newValue)
  • _onShow() Internal method called when this widget is made visible.
  • onApplyCellEdit(inValue,inRowIndex,inFieldIndex) Event fired when editing is applied for a given grid cell
  • onApplyEdit(inRowIndex) Event fired when editing is applied for a given grid row
  • onBlur() Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden.
  • onCancelEdit(inRowIndex) Event fired when editing is cancelled for a given grid cell
  • onCanDeselect(inRowIndex) Event to determine if a grid row may be deselected
  • onCanSelect(inRowIndex) Event to determine if a grid row may be selected
  • onCellClick(e) Event fired when a cell is clicked.
  • onCellContextMenu(e) Event fired when a cell context menu is accessed via mouse right click.
  • onCellDblClick(e) Event fired when a cell is double-clicked.
  • onCellFocus(inCell,inRowIndex) Event fired when a cell receives focus.
  • onCellMouseDown(e) Event fired when mouse is down in a header cell.
  • onCellMouseOut(e) Event fired when mouse moves out of a cell.
  • onCellMouseOver(e) Event fired when mouse is over a cell.
  • onClick(event) Connect to this function to receive notifications of mouse click events.
  • onClose() Called when this widget is being displayed as a popup (ex: a Calendar popped up from a DateTextBox), and it is hidden.
  • onContentEvent(e) Top level handler for Content events
  • onDblClick(event) Connect to this function to receive notifications of mouse double click events.
  • onDeselected(inRowIndex) Event fired when a grid row is deselected
  • onFetchError(err,req)
  • onFocus() Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.
  • onHeaderCellClick(e) Event fired when a header cell is clicked.
  • onHeaderCellContextMenu(e) Event fired when a header cell context menu is accessed via mouse right click.
  • onHeaderCellDblClick(e) Event fired when a header cell is double clicked.
  • onHeaderCellMouseDown(e) Event fired when mouse is down in a header cell.
  • onHeaderCellMouseOut(e) Event fired when mouse moves out of a header cell.
  • onHeaderCellMouseOver(e) Event fired when mouse moves over a header cell.
  • onHeaderClick(e) Event fired when the grid header is clicked.
  • onHeaderContextMenu(e) Event fired when the grid header context menu is accessed via mouse right click.
  • onHeaderDblClick(e) Event fired when the grid header is double clicked.
  • onHeaderEvent(e) Top level handler for header events
  • onHeaderMouseOut(e) Event fired when mouse moves out of the grid header.
  • onHeaderMouseOver(e) Event fired when mouse moves over the grid header.
  • onHide() Called when another widget becomes the selected pane in a dijit/layout/TabContainer, dijit/layout/StackContainer, dijit/layout/AccordionContainer, etc.
  • onKeyDown(event) Connect to this function to receive notifications of keys being pressed down.
  • onKeyEvent(e) top level handler for Key Events
  • onKeyPress(event) Connect to this function to receive notifications of printable keys being typed.
  • onKeyUp(event) Connect to this function to receive notifications of keys being released.
  • onMouseDown(event) Connect to this function to receive notifications of when the mouse button is pressed down.
  • onMouseDownRow(e) Event fired when mouse is down inside grid row
  • onMouseEnter(event) Connect to this function to receive notifications of when the mouse moves onto this widget.
  • onMouseLeave(event) Connect to this function to receive notifications of when the mouse moves off of this widget.
  • onMouseMove(event) Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.
  • onMouseOut(event) Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.
  • onMouseOutRow(e) Event fired when mouse moves out of any row (data or header).
  • onMouseOver(event) Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.
  • onMouseOverRow(e) Event fired when mouse is over any row (data or header).
  • onMouseUp(event) Connect to this function to receive notifications of when the mouse button is released.
  • onMoveColumn()
  • onResizeColumn(cellIdx)
  • onRowClick(e) Event fired when a row is clicked.
  • onRowContextMenu(e) Event fired when a row context menu is accessed via mouse right click.
  • onRowDblClick(e) Event fired when a row is double clicked.
  • onRowMouseDown(e) Event fired when mouse is down in a row.
  • onRowMouseOut(e) Event fired when mouse moves out of a data row.
  • onRowMouseOver(e) Event fired when mouse moves over a data row.
  • onSelected(inRowIndex) Event fired when a grid row is selected
  • onSelectionChanged()
  • onShow() Called when this widget becomes the selected pane in a dijit/layout/TabContainer, dijit/layout/StackContainer, dijit/layout/AccordionContainer, etc.
  • onStartEdit(inCell,inRowIndex) Event fired when editing is started for a given grid cell
  • onStyleRow(inRow)

Properties

_attachEvents
Defined by: dijit/_AttachMixin

List of connections associated with data-dojo-attach-event=... in the template

_attachPoints
Defined by: dijit/_AttachMixin

List of widget attribute names associated with data-dojo-attach-point=... in the template, ex: ["containerNode", "labelNode"]

_attrPairNames
Defined by: dijit/_WidgetBase
_blankGif
Defined by: dijit/_WidgetBase

Path to a blank 1x1 image. Used by <img> nodes in templates that really get their image via CSS background-image.

_bop
Defined by: dojox/grid/DataGrid
_by_idty
Defined by: dojox/grid/DataGrid
_by_idx
Defined by: dojox/grid/DataGrid
_cache
Defined by: dojox/grid/DataGrid
_click
Defined by: dojox/grid/_Grid
_eop
Defined by: dojox/grid/DataGrid
_focusManager
Defined by: dijit/_FocusMixin
_isLoaded
Defined by: dojox/grid/DataGrid
_isLoading
Defined by: dojox/grid/DataGrid
_pages
Defined by: dojox/grid/DataGrid
_pending_requests
Defined by: dojox/grid/DataGrid
_placeholders
Defined by: dojox/grid/_Grid
_rendered
Defined by: dijit/_TemplatedMixin

Not normally use, but this flag can be set by the app if the server has already rendered the template, i.e. already inlining the template for the widget into the main page. Reduces _TemplatedMixin to just function like _AttachMixin.

_requests
Defined by: dojox/grid/DataGrid
_setClassAttr
Defined by: dijit/_WidgetBase
_setDirAttr
Defined by: dijit/_WidgetBase
_setIdAttr
Defined by: dijit/_WidgetBase
_setLangAttr
Defined by: dijit/_WidgetBase
_setSummaryAttr
Defined by: dojox/grid/_Grid
_setTypeAttr
Defined by: dijit/_WidgetBase
_skipNodeCache
Defined by: dijit/_TemplatedMixin
_started
Defined by: dijit/_WidgetBase

startup() has completed.

_store_connects
Defined by: dojox/grid/DataGrid
attachScope
Defined by: dijit/_AttachMixin

Object to which attach points and events will be scoped. Defaults to 'this'.

attributeMap
Defined by: dijit/_WidgetBase

Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute for each XXX attribute to be mapped to the DOM.

attributeMap sets up a "binding" between attributes (aka properties) of the widget and the widget's DOM. Changes to widget attributes listed in attributeMap will be reflected into the DOM.

For example, calling set('title', 'hello') on a TitlePane will automatically cause the TitlePane's DOM to update with the new title.

attributeMap is a hash where the key is an attribute of the widget, and the value reflects a binding to a:

  • DOM node attribute

    focus: {node: "focusNode", type: "attribute"} Maps this.focus to this.focusNode.focus

  • DOM node innerHTML

    title: { node: "titleNode", type: "innerHTML" } Maps this.title to this.titleNode.innerHTML

  • DOM node innerText

    title: { node: "titleNode", type: "innerText" } Maps this.title to this.titleNode.innerText

  • DOM node CSS class

    myClass: { node: "domNode", type: "class" } Maps this.myClass to this.domNode.className

If the value is an array, then each element in the array matches one of the formats of the above list.

There are also some shorthands for backwards compatibility:

  • string --> { node: string, type: "attribute" }, for example:
"focusNode" ---> { node: "focusNode", type: "attribute" }
  • "" --> { node: "domNode", type: "attribute" }
autoHeight
Defined by: dojox/grid/_Grid

If autoHeight is true, grid height is automatically set to fit the data. If it is an integer, the height will be automatically set to fit the data if there are fewer than that many rows - and the height will be set to show that many rows if there are more

autoRender
Defined by: dojox/grid/_Grid

If autoRender is true, grid will render itself after initialization.

autoWidth
Defined by: dojox/grid/_Grid

If autoWidth is true, grid width is automatically set to fit the data.

baseClass
Defined by: dijit/_WidgetBase

Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate widget state.

cellOverClass
Defined by: dojox/grid/_Events

css class to apply to grid cells over which the cursor is placed.

class
Defined by: dijit/_WidgetBase
classTag
Defined by: dojox/grid/_Grid

CSS class applied to the grid's domNode

columnReordering
Defined by: dojox/grid/_Grid

If set to true, will add drag and drop reordering to views with one row of columns.

containerNode
Defined by: dijit/_WidgetBase

Designates where children of the source DOM node will be placed. "Children" in this case refers to both DOM nodes and widgets. For example, for myWidget:

<div data-dojo-type=myWidget>
    <b> here's a plain DOM node
    <span data-dojo-type=subWidget>and a widget</span>
    <i> and another plain DOM node </i>
</div>

containerNode would point to:

<b> here's a plain DOM node
<span data-dojo-type=subWidget>and a widget</span>
<i> and another plain DOM node </i>

In templated widgets, "containerNode" is set via a data-dojo-attach-point assignment.

containerNode must be defined for any widget that accepts innerHTML (like ContentPane or BorderContainer or even Button), and conversely is null for widgets that don't, like TextBox.

defaultHeight
Defined by: dojox/grid/_Grid

default height of the grid, measured in any valid css unit.

delayScroll
Defined by: dojox/grid/_Grid
dir
Defined by: dijit/_WidgetBase

Bi-directional support, as defined by the HTML DIR attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's default direction.

domNode
Defined by: dijit/_WidgetBase

This is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's data-dojo-attach-point syntax, but the domNode property is the canonical "top level" node in widget UI.

editable
Defined by: dojox/grid/_Grid

indicates if the grid contains editable cells, default is false set to true if editable cell encountered during rendering

elasticView
Defined by: dojox/grid/_Grid

Override defaults and make the indexed grid view elastic, thus filling available horizontal space.

errorMessage
Defined by: dojox/grid/_Grid

Message that shows when the grid encounters an error loading

escapeHTMLInData
Defined by: dojox/grid/_Grid

This will escape HTML brackets from the data to prevent HTML from user-inputted data being rendered with may contain JavaScript and result in XSS attacks. This is true by default, and it is recommended that it remain true. Setting this to false will allow data to be displayed in the grid without filtering, and should be only used if it is known that the data won't contain malicious scripts. If HTML is needed in grid cells, it is recommended that you use the formatter function to generate the HTML (the output of formatter functions is not filtered, even with escapeHTMLInData set to true).

fastScroll
Defined by: dojox/grid/_Grid

flag modifies vertical scrolling behavior. Defaults to true but set to false for slower scroll performance but more immediate scrolling feedback

fetchText
Defined by: dojox/grid/DataGrid
focused
Defined by: dijit/_FocusMixin

This widget or a widget it contains has focus, or is "active" because it was recently clicked.

formatterScope
Defined by: dojox/grid/_Grid

An object to execute format functions within. If not set, the format functions will execute within the scope of the cell that has a format function.

headerMenu
Defined by: dojox/grid/_Grid

If set to a dijit.Menu, will use this as a context menu for the grid headers.

height
Defined by: dojox/grid/_Grid

explicit height of the grid, measured in any valid css unit. This will be populated (and overridden) if the height: css attribute exists on the source node.

id
Defined by: dijit/_WidgetBase

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.

initialWidth
Defined by: dojox/grid/_Grid

A css string to use to set our initial width (only used if autoWidth is true). The first rendering of the grid will be this width, any resizing of columns, etc will result in the grid switching to autoWidth mode. Note, this width will override any styling in a stylesheet or directly on the node.

invalidated
Defined by: dojox/grid/_Grid
items
Defined by: dojox/grid/DataGrid
keepRows
Defined by: dojox/grid/_Grid

Number of rows to keep in the rendering cache.

keepSelection
Defined by: dojox/grid/DataGrid

Whether keep selection after sort, filter etc.

lang
Defined by: dijit/_WidgetBase

Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the HTML LANG attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to RFC 3066 (like en-us).

loadingMessage
Defined by: dojox/grid/_Grid

Message that shows while the grid is loading

noDataMessage
Defined by: dojox/grid/_Grid

Message that shows if the grid has no data - wrap it in a span with class 'dojoxGridNoData' if you want it to be styled similar to the loading and error messages

observer
ownerDocument
Defined by: dijit/_WidgetBase

The document this widget belongs to. If not specified to constructor, will default to srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global

placeholderLabel
Defined by: dojox/grid/_Grid

Label of placeholders to search for in the header menu to replace with column toggling menu items.

query
Defined by: dojox/grid/DataGrid
queryOptions
Defined by: dojox/grid/DataGrid
rowCount
Defined by: dojox/grid/DataGrid
rowHeight
Defined by: dojox/grid/_Grid

If rowHeight is set to a positive number, it will define the height of the rows in pixels. This can provide a significant performance advantage, since it eliminates the need to measure row sizes during rendering, which is one the primary bottlenecks in the DataGrid's performance.

rowSelector
Defined by: dojox/grid/_Grid

If set to true, will add a row selector view to this grid. If set to a CSS width, will add a row selector of that width to this grid.

rowsPerPage
Defined by: dojox/grid/_Grid

Number of rows to render at a time.

scrollRedrawThreshold
Defined by: dojox/grid/_Grid

pixel distance a user must scroll vertically to trigger grid scrolling.

searchContainerNode
Defined by: dijit/_TemplatedMixin
selectable
Defined by: dojox/grid/_Grid

Set to true if you want to be able to select the text within the grid.

selectionMode
Defined by: dojox/grid/_Grid

Set the selection mode of grid's Selection. Value must be 'single', 'multiple', or 'extended'. Default is 'extended'.

singleClickEdit
Defined by: dojox/grid/_Grid

Single-click starts editing. Default is double-click

sortFields
Defined by: dojox/grid/DataGrid
sortInfo
Defined by: dojox/grid/_Grid
srcNodeRef
Defined by: dijit/_WidgetBase

pointer to original DOM node

store
Defined by: dojox/grid/DataGrid
structure
Defined by: dojox/grid/DataGrid

View layout definition.

style
Defined by: dijit/_WidgetBase

HTML style attributes as cssText string or name/value hash

summary
Defined by: dojox/grid/_Grid

Customizable summary descriptions which will be added to grid.domNode

templatePath
Defined by: dijit/_TemplatedMixin

Path to template (HTML file) for this widget relative to dojo.baseUrl. Deprecated: use templateString with require([... "dojo/text!..."], ...) instead

templateString
Defined by: dojox/grid/_Grid
title
Defined by: dijit/_WidgetBase

HTML title attribute.

For form widgets this specifies a tooltip to display when hovering over the widget (just like the native HTML title attribute).

For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, etc., it's used to specify the tab label, accordion pane title, etc. In this case it's interpreted as HTML.

tooltip
Defined by: dijit/_WidgetBase

When this widget's title attribute is used to for a tab label, accordion pane title, etc., this specifies the tooltip to appear when the mouse is hovered over that text.

updateDelay
Defined by: dojox/grid/DataGrid

Time, in milliseconds, to delay updates automatically so that multiple calls to onSet/onNew/onDelete don't keep rerendering the grid. Set to 0 to immediately cause updates. A higher value will result in better performance at the expense of responsiveness of the grid.

updating
Defined by: dojox/grid/_Grid

Methods

_addItem(item,index,noUpdate)
Defined by dojox/grid/DataGrid
Parameter Type Description
item undefined
index undefined
noUpdate undefined
_applyAttributes()
Defined by dijit/_WidgetBase

Step during widget creation to copy widget attributes to the DOM according to attributeMap and _setXXXAttr objects, and also to call custom _setXXXAttr() methods.

Skips over blank/false attribute values, unless they were explicitly specified as parameters to the widget, since those are the default anyway, and setting tabIndex="" is different than not setting tabIndex at all.

For backwards-compatibility reasons attributeMap overrides _setXXXAttr when _setXXXAttr is a hash/string/array, but _setXXXAttr as a functions override attributeMap.

_attach(node,type,func)
Defined by dijit/_AttachMixin

Roughly corresponding to dojo/on, this is the default function for processing a data-dojo-attach-event. Meant to attach to DOMNodes, not to widgets.

Parameter Type Description
node DOMNode

The node to setup a listener on.

type String

Event name like "click".

func undefined
Returns:undefined
_attachTemplateNodes(rootNode)
Defined by dijit/_AttachMixin

Iterate through the dom nodes and attach functions and nodes accordingly.

Map widget properties and functions to the handlers specified in the dom node and it's descendants. This function iterates over all nodes and looks for these properties:

  • dojoAttachPoint/data-dojo-attach-point
  • dojoAttachEvent/data-dojo-attach-event
Parameter Type Description
rootNode DomNode

The node to search for properties. All descendants will be searched.

_attrToDom(attr,value,commands)
Defined by dijit/_WidgetBase

Reflect a widget attribute (title, tabIndex, duration etc.) to the widget DOM, as specified by commands parameter. If commands isn't specified then it's looked up from attributeMap. Note some attributes like "type" cannot be processed this way as they are not mutable.

Parameter Type Description
attr String

Name of member variable (ex: "focusNode" maps to this.focusNode) pointing to DOMNode inside the widget, or alternately pointing to a subwidget

value String
commands Object
Optional
_beforeFillContent()
Defined by dijit/_AttachMixin
_changeAttrValue(name,value)
Defined by dojo/Stateful

Internal helper for directly changing an attribute value.

Directly change the value of an attribute on an object, bypassing any accessor setter. Also handles the calling of watch and emitting events. It is designed to be used by descendant class when there are two values of attributes that are linked, but calling .set() is not appropriate.

Parameter Type Description
name String

The property to set.

value Mixed

The value to set in the property.

Returns:function

Internal helper for directly changing an attribute value.

_checkUpdateStatus()
Defined by dojox/grid/DataGrid
_clearData()
Defined by dojox/grid/DataGrid
_copyAttr(idx,attr)
Defined by dojox/grid/DataGrid
Parameter Type Description
idx undefined
attr undefined
Returns:undefined
_createItem(item,index)
Defined by dojox/grid/DataGrid
Parameter Type Description
item undefined
index undefined
Returns:object
_detachTemplateNodes()
Defined by dijit/_AttachMixin

Detach and clean up the attachments made in _attachtempalteNodes.

_dispatch(m,e)
Defined by dojox/grid/_Grid
Parameter Type Description
m undefined
e undefined
Returns:undefined | boolean
_escapeValue(val)

Escape a value to be inserted into the template, either into an attribute value (ex: foo="${bar}") or as inner text of an element (ex: ${foo})

Parameter Type Description
val String
Returns:undefined
_fetch(start,isRender)
Defined by dojox/grid/DataGrid
Parameter Type Description
start undefined
isRender undefined
_fillContent(source)

Relocate source contents to templated container node. this.containerNode must be able to receive children, or exceptions will be thrown.

Parameter Type Description
source DomNode
_get(name)
Defined by dijit/_WidgetBase

Helper function to get value for specified property stored by this._set(), i.e. for properties with custom setters. Used mainly by custom getters.

For example, CheckBox._getValueAttr() calls this._get("value").

Parameter Type Description
name String
Returns:undefined
_getAttrNames(name)
Defined by dijit/_WidgetBase

Helper function for get() and set(). Caches attribute name values so we don't do the string ops every time.

Parameter Type Description
name undefined
Returns:undefined | object
_getHeaderHeight()
Defined by dojox/grid/_Grid
Returns:undefined
_getItemAttr(idx,attr)
Defined by dojox/grid/DataGrid
Parameter Type Description
idx undefined
attr undefined
Returns:undefined
_getItemIndex(item,isDeleted)
Defined by dojox/grid/DataGrid
Parameter Type Description
item undefined
isDeleted undefined
Returns:number
_getPadBorder()
Defined by dojox/grid/_Grid
Returns:undefined
_getRowCountAttr()
Defined by dojox/grid/_Grid
Returns:undefined
_introspect()
Defined by dijit/_WidgetBase

Collect metadata about this widget (only once per class, not once per instance):

- list of attributes with custom setters, storing in this.constructor._setterAttrs
- generate this.constructor._onMap, mapping names like "mousedown" to functions like onMouseDown
_layoutClass()
Defined by dojox/grid/_Grid

The class to use for our layout - can be overridden by grid subclasses

_mouseOut(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
_needPage(inPageIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inPageIndex undefined
_pageToRow(inPageIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inPageIndex undefined
Returns:undefined
_preparePage(inRowIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inRowIndex undefined
_processTemplateNode(baseNode,getAttrFunc,attachFunc)
Defined by dijit/_AttachMixin

Process data-dojo-attach-point and data-dojo-attach-event for given node or widget. Returns true if caller should process baseNode's children too.

Parameter Type Description
baseNode DOMNode | Widget
getAttrFunc Function

Function to get the specified property for a given DomNode/Widget.

attachFunc Function
Optional

Attaches an event handler from the specified node/widget to specified function.

Returns:boolean
_refresh(isRender)
Defined by dojox/grid/DataGrid
Parameter Type Description
isRender undefined
_render()
Defined by dojox/grid/DataGrid
_requestPage(inPageIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inPageIndex undefined
_requestsPending(inRowIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inRowIndex undefined
Returns:undefined
_resize(changeSize,resultSize)
Defined by dojox/grid/_Grid
Parameter Type Description
changeSize undefined
resultSize undefined
_rowToPage(inRowIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inRowIndex undefined
Returns:undefined
_set(name,value)
Defined by dijit/_WidgetBase

Helper function to set new value for specified property, and call handlers registered with watch() if the value has changed.

Parameter Type Description
name String
value anything
_setAutoHeightAttr(ah,skipRender)
Defined by dojox/grid/_Grid
Parameter Type Description
ah undefined
skipRender undefined
_setFocusedAttr(val)
Defined by dijit/_Widget
Parameter Type Description
val undefined
_setHeaderMenuAttr(menu)
Defined by dojox/grid/_Grid
Parameter Type Description
menu undefined
_setOwnerDocumentAttr(val)
Defined by dijit/_WidgetBase
Parameter Type Description
val undefined
_setQuery(query,queryOptions)
Defined by dojox/grid/DataGrid
Parameter Type Description
query undefined
queryOptions undefined
_setStore(store)
Defined by dojox/grid/DataGrid
Parameter Type Description
store undefined
_setStructureAttr(structure)
Defined by dojox/grid/_Grid
Parameter Type Description
structure undefined
_setStyleAttr(value)
Defined by dijit/_WidgetBase

Sets the style attribute of the widget according to value, which is either a hash like {height: "5px", width: "3px"} or a plain string

Determines which node to set the style on based on style setting in attributeMap.

Parameter Type Description
value String | Object
_setTextDirAttr(textDir)
Parameter Type Description
textDir undefined
_stringRepl(tmpl)

Does substitution of ${foo} type properties in template string

Parameter Type Description
tmpl undefined
Returns:undefined
_structureChanged()
Defined by dojox/grid/_Grid
adaptHeight(inHeaderHeight)
Defined by dojox/grid/_Grid

measures and normalizes header height, then sets view heights, and then updates scroller content extent

Parameter Type Description
inHeaderHeight undefined
adaptWidth()
Defined by dojox/grid/_Grid

sets width and position for views and update grid width if necessary

addRow()
Defined by dojox/grid/_Grid

Add a row to the grid.

attr(name,value)
Defined by dijit/_Widget

This method is deprecated, use get() or set() directly.

Parameter Type Description
name String | Object

The property to get or set. If an object is passed here and not a string, its keys are used as names of attributes to be set and the value of the object as values to set in the widget.

value Object
Optional

Optional. If provided, attr() operates as a setter. If omitted, the current value of the named property is returned.

Returns:undefined
beginUpdate()
Defined by dojox/grid/_Grid

Use to make multiple changes to rows while queueing row updating.

buildRendering()
Defined by dojox/grid/_Grid
buildViews()
Defined by dojox/grid/_Grid
canEdit(inCell,inRowIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inCell undefined
inRowIndex undefined
Returns:undefined
canSort()
Defined by dojox/grid/DataGrid
Returns:boolean
cell_markupFactory(cellFunc,node,cellDef)
Defined by dojox/grid/DataGrid
Parameter Type Description
cellFunc undefined
node undefined
cellDef undefined
connect(obj,event,method)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead.

Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy.

Provide widget-specific analog to dojo.connect, except with the implicit use of this widget as the target object. Events connected with this.connect are disconnected upon destruction.

Parameter Type Description
obj Object | null
event String | Function
method String | Function
Returns:any | undefined

A handle that can be passed to disconnect in order to disconnect before the widget is destroyed.

Examples

Example 1

var btn = new Button();
// when foo.bar() is called, call the listener we're going to
// provide in the scope of btn
btn.connect(foo, "bar", function(){
    console.debug(this.toString());
});
create(params,srcNodeRef)
Defined by dijit/_WidgetBase

Kick off the life-cycle of a widget

Create calls a number of widget methods (postMixInProperties, buildRendering, postCreate, etc.), some of which of you'll want to override. See http://dojotoolkit.org/reference-guide/dijit/_WidgetBase.html for a discussion of the widget creation lifecycle.

Of course, adventurous developers could override create entirely, but this should only be done as a last resort.

Parameter Type Description
params Object | null

Hash of initialization parameters for widget, including scalar values (like title, duration etc.) and functions, typically callbacks like onClick. The hash can contain any of the widget's properties, excluding read-only properties.

srcNodeRef DOMNode | String
Optional

If a srcNodeRef (DOM node) is specified:

  • use srcNodeRef.innerHTML as my contents
  • if this is a behavioral widget then apply behavior to that srcNodeRef
  • otherwise, replace srcNodeRef with my generated DOM tree
createLayout()
Defined by dojox/grid/_Grid

Creates a new Grid layout

createManagers()
Defined by dojox/grid/_Grid

create grid managers for various tasks including rows, focus, selection, editing

createScroller()
Defined by dojox/grid/_Grid

Creates a new virtual scroller

createSelection()
Defined by dojox/grid/DataGrid
createView(inClass,idx)
Defined by dojox/grid/_Grid
Parameter Type Description
inClass undefined
idx undefined
Returns:instance
createViews()
Defined by dojox/grid/_Grid
defaultUpdate()
Defined by dojox/grid/_Grid
defer(fcn,delay)
Defined by dijit/_WidgetBase

Wrapper to setTimeout to avoid deferred functions executing after the originating widget has been destroyed. Returns an object handle with a remove method (that returns null) (replaces clearTimeout).

Parameter Type Description
fcn Function

Function reference.

delay Number
Optional

Delay, defaults to 0.

Returns:object
destroy()
Defined by dojox/grid/DataGrid
destroyDescendants(preserveDom)
Defined by dijit/_WidgetBase

Recursively destroy the children of this widget and their descendants.

Parameter Type Description
preserveDom Boolean
Optional

If true, the preserveDom attribute is passed to all descendant widget's .destroy() method. Not for use with _Templated widgets.

destroyRecursive(preserveDom)
Defined by dijit/_WidgetBase

Destroy this widget and its 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 is removed from the manager object.

Parameter Type Description
preserveDom Boolean
Optional

If true, this method will leave the original DOM structure alone of descendant Widgets. Note: This will NOT work with dijit._TemplatedMixin widgets.

destroyRendering(preserveDom)
Defined by dijit/_WidgetBase

Destroys the DOM nodes associated with this widget.

Parameter Type Description
preserveDom Boolean
Optional

If true, this method will leave the original DOM structure alone during tear-down. Note: this will not work with _Templated widgets yet.

disconnect(handle)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use handle.remove() instead.

Disconnects handle created by connect.

Parameter Type Description
handle undefined
dispatchContentEvent(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
dispatchHeaderEvent(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
dispatchKeyEvent(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
doApplyCellEdit(inValue,inRowIndex,inAttrName)
Defined by dojox/grid/DataGrid
Parameter Type Description
inValue undefined
inRowIndex undefined
inAttrName undefined
doApplyEdit(inRowIndex,inDataAttr)
Defined by dojox/grid/DataGrid
Parameter Type Description
inRowIndex undefined
inDataAttr undefined
doCancelEdit(inRowIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inRowIndex undefined
doclick(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
docontextmenu(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
dodblclick(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
doheaderclick(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
doheadercontextmenu(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
doheaderdblclick(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
dokeydown(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
doKeyEvent(e)
Defined by dojox/grid/_Grid
Parameter Type Description
e undefined
doStartEdit(inCell,inRowIndex)
Defined by dojox/grid/DataGrid
Parameter Type Description
inCell undefined
inRowIndex undefined
emit(type,eventObj,callbackArgs)
Defined by dijit/_WidgetBase

Used by widgets to signal that a synthetic event occurred, ex:

myWidget.emit("attrmodified-selectedChildWidget", {}).

Emits an event on this.domNode named type.toLowerCase(), based on eventObj. Also calls onType() method, if present, and returns value from that method. By default passes eventObj to callback, but will pass callbackArgs instead, if specified. Modifies eventObj by adding missing parameters (bubbles, cancelable, widget).

Parameter Type Description
type String
eventObj Object
Optional
callbackArgs Array
Optional
Returns:undefined
endUpdate()
Defined by dojox/grid/_Grid

Use after calling beginUpdate to render any changes made to rows.

filter(query,reRender)
Defined by dojox/grid/DataGrid
Parameter Type Description
query undefined
reRender undefined
finishScrollJob()
Defined by dojox/grid/_Grid
get(inRowIndex,inItem)
Defined by dojox/grid/DataGrid

Default data getter.

Provides data to display in a grid cell. Called in grid cell context. So this.cell.index is the column index.

Parameter Type Description
inRowIndex Integer

Row for which to provide data

inItem undefined
Returns:any | undefined

Data to display for a given grid cell.

getCell(inIndex)
Defined by dojox/grid/_Grid

Retrieves the cell object for a given grid column.

Parameter Type Description
inIndex Integer

Grid column index of cell to retrieve

Returns:any | undefined

a grid cell

getCellName(inCell)
Defined by dojox/grid/DataGrid
Parameter Type Description
inCell undefined
Returns:undefined
getCellNodeTextDirection(inColIndex,inRowIndex)
Parameter Type Description
inColIndex undefined
inRowIndex undefined
Returns:undefined
getChildren()
Defined by dijit/_WidgetBase

Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent is this widget. Note that it does not return all descendants, but rather just direct children. Analogous to Node.childNodes, except containing widgets rather than DOMNodes.

The result intentionally excludes internally created widgets (a.k.a. supporting widgets) outside of this.containerNode.

Note that the array returned is a simple array. Application code should not assume existence of methods like forEach().

Returns:Array
getColumnTogglingItems()
Defined by dojox/grid/_Grid

returns an array of dijit.CheckedMenuItem widgets that can be added to a menu for toggling columns on and off.

Returns:undefined
getDescendants()
Defined by dijit/_Widget

Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. This method should generally be avoided as it returns widgets declared in templates, which are supposed to be internal/hidden, but it's left here for back-compat reasons.

Returns:Array
getItem(idx)
Defined by dojox/grid/DataGrid
Parameter Type Description
idx undefined
Returns:null | undefined
getItemIndex(item)
Defined by dojox/grid/DataGrid
Parameter Type Description
item undefined
Returns:undefined
getParent()
Defined by dijit/_WidgetBase

Returns the parent widget of this widget.

Returns:undefined
getRowNode(inRowIndex)
Defined by dojox/grid/_Grid

find the rowNode that is not a rowSelector

Parameter Type Description
inRowIndex undefined
Returns:undefined | null
getSortAsc(inSortInfo)
Defined by dojox/grid/_Grid

Returns true if grid is sorted in an ascending direction.

Parameter Type Description
inSortInfo undefined
Returns:undefined
getSortIndex(inSortInfo)
Defined by dojox/grid/_Grid

Returns the index of the column on which the grid is sorted

Parameter Type Description
inSortInfo undefined
Returns:number
getSortProps()
Defined by dojox/grid/DataGrid
Returns:undefined | null | Array
hasLayout()
Defined by dojox/grid/_Grid
Returns:undefined
isFocusable()
Defined by dijit/_WidgetBase

Return true if this widget can currently be focused and false if not

Returns:undefined
isLeftToRight()
Defined by dijit/_WidgetBase

Return this widget's explicit or implicit orientation (true for LTR, false for RTL)

Returns:undefined
markupFactory(props,node,ctor,cellFunc)
Defined by dojox/grid/DataGrid
Parameter Type Description
props undefined
node undefined
ctor undefined
cellFunc undefined
on(type,func)
Defined by dijit/_Widget
Parameter Type Description
type String | Function

protected

func Function
Returns:undefined
own()
Defined by dijit/Destroyable

Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.

Returns:any | undefined

The array of specified handles, so you can do for example:

var handle = this.own(on(...))[0];
placeAt(reference,position)
Defined by dijit/_WidgetBase

Place this widget somewhere in the DOM based on standard domConstruct.place() conventions.

A convenience function provided in all _Widgets, providing a simple shorthand mechanism to put an existing (or newly created) Widget somewhere in the dom, and allow chaining.

Parameter Type Description
reference String | DomNode | DocumentFragment | dijit/_WidgetBase

Widget, DOMNode, DocumentFragment, or id of widget or DOMNode

position String | Int
Optional

If reference is a widget (or id of widget), and that widget has an ".addChild" method, it will be called passing this widget instance into that method, supplying the optional position index passed. In this case position (if specified) should be an integer.

If reference is a DOMNode (or id matching a DOMNode but not a widget), the position argument can be a numeric index or a string "first", "last", "before", or "after", same as dojo/dom-construct::place().

Returns:dijit/_WidgetBase | function

Provides a useful return of the newly created dijit._Widget instance so you can "chain" this function by instantiating, placing, then saving the return value to a variable.

Examples

Example 1

// create a Button with no srcNodeRef, and place it in the body:
var button = new Button({ label:"click" }).placeAt(win.body());
// now, 'button' is still the widget reference to the newly created button
button.on("click", function(e){ console.log('click'); }));

Example 2

// create a button out of a node with id="src" and append it to id="wrapper":
var button = new Button({},"src").placeAt("wrapper");

Example 3

// place a new button as the first element of some div
var button = new Button({ label:"click" }).placeAt("wrapper","first");

Example 4

// create a contentpane and add it to a TabContainer
var tc = dijit.byId("myTabs");
new ContentPane({ href:"foo.html", title:"Wow!" }).placeAt(tc)
postCreate()
Defined by dojox/grid/DataGrid
postMixInProperties()
Defined by dojox/grid/_Grid
postrender()
Defined by dojox/grid/_Grid
postresize()
Defined by dojox/grid/_Grid
postscript(params,srcNodeRef)
Defined by dijit/_WidgetBase

Kicks off widget instantiation. See create() for details.

Parameter Type Description
params Object
Optional
srcNodeRef DomNode | String
prerender()
Defined by dojox/grid/_Grid
removeSelectedRows()
Defined by dojox/grid/DataGrid

Remove the selected rows from the grid.

render()
Defined by dojox/grid/_Grid

Render the grid, headers, and views. Edit and scrolling states are reset. To retain edit and scrolling states, see Update.

renderRow(inRowIndex,inNodes)
Defined by dojox/grid/_Grid

used internally to render rows

Parameter Type Description
inRowIndex undefined
inNodes undefined
resize(changeSize,resultSize)
Defined by dojox/grid/_Grid

Update the grid's rendering dimensions and resize it

Parameter Type Description
changeSize undefined
resultSize undefined
rowHeightChanged(inRowIndex)
Defined by dojox/grid/_Grid

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.

Parameter Type Description
inRowIndex Integer

index of the row that has changed height

rowRemoved(inRowIndex)
Defined by dojox/grid/_Grid

used internally to remove rows

Parameter Type Description
inRowIndex undefined
scrollTo(inTop)
Defined by dojox/grid/_Grid

Vertically scroll the grid to a given pixel position

Parameter Type Description
inTop Integer

vertical position of the grid in pixels

scrollToRow(inRowIndex)
Defined by dojox/grid/_Grid

Scroll the grid to a specific row.

Parameter Type Description
inRowIndex Integer

grid row index

set(name,value)
Defined by dijit/_WidgetBase

Set a property on a widget

Sets named properties on a widget which may potentially be handled by a setter in the widget.

For example, if the widget has properties foo and bar and a method named _setFooAttr(), calling myWidget.set("foo", "Howdy!") would be equivalent to calling widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) would be equivalent to the statement widget.bar = 3;

set() may also be called with a hash of name/value pairs, ex:

myWidget.set({
    foo: "Howdy",
    bar: 3
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

Parameter Type Description
name undefined

The property to set.

value undefined

The value to set in the property.

Returns:function | string

Set a property on a widget

setAttribute(attr,value)
Defined by dijit/_Widget

Deprecated. Use set() instead.

Parameter Type Description
attr String
value anything
setCellNodeTextDirection(inColIndex,inRowIndex,textDir)
Parameter Type Description
inColIndex undefined
inRowIndex undefined
textDir undefined
setCellWidth(inIndex,inUnitWidth)
Defined by dojox/grid/_Grid
Parameter Type Description
inIndex undefined
inUnitWidth undefined
setHeaderMenu(menu)
Defined by dojox/grid/_Grid
Parameter Type Description
menu dijit/Menu
setItems(items)
Defined by dojox/grid/DataGrid
Parameter Type Description
items undefined
setQuery(query,queryOptions)
Defined by dojox/grid/DataGrid
Parameter Type Description
query undefined
queryOptions undefined
setScrollTop(inTop)
Defined by dojox/grid/_Grid
Parameter Type Description
inTop undefined
setSortIndex(inIndex,inAsc)
Defined by dojox/grid/_Grid

Sort the grid on a column in a specified direction

Parameter Type Description
inIndex Integer

Column index on which to sort.

inAsc Boolean

If true, sort the grid in ascending order, otherwise in descending order

setSortInfo(inSortInfo)
Defined by dojox/grid/_Grid
Parameter Type Description
inSortInfo undefined
setStore(store,query,queryOptions)
Defined by dojox/grid/DataGrid
Parameter Type Description
store undefined
query undefined
queryOptions undefined
setStructure(inStructure)
Defined by dojox/grid/_Grid

Install a new structure and rebuild the grid.

Parameter Type Description
inStructure dojox.grid.__ViewDef | dojox.grid.__ViewDef[] | dojox.grid.__CellDef[] | Array[dojox.grid.__CellDef[]]
setupHeaderMenu()
Defined by dojox/grid/_Grid
showMessage(message)
Defined by dojox/grid/_Grid
Parameter Type Description
message undefined
sizeChange()
Defined by dojox/grid/_Grid
sort()
Defined by dojox/grid/DataGrid
startup()
Defined by dojox/grid/_Grid
styleRowNode(inRowIndex,inRowNode)
Defined by dojox/grid/_Grid

styling (used internally to style individual parts of a row)

Parameter Type Description
inRowIndex undefined
inRowNode undefined
styleRowState(inRow)
Defined by dojox/grid/DataGrid

Perform row styling

Parameter Type Description
inRow undefined
subscribe(t,method)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead.

Subscribes to the specified topic and calls the specified method of this object and registers for unsubscribe() on widget destroy.

Provide widget-specific analog to dojo.subscribe, except with the implicit use of this widget as the target object.

Parameter Type Description
t String

The topic

method Function

The callback

Returns:undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
textSizeChanged()
Defined by dojox/grid/_Grid
toString()
Defined by dijit/_WidgetBase

Returns a string that represents the widget.

When a widget is cast to a string, this method will be used to generate the output. Currently, it does not implement any sort of reversible serialization.

Returns:string
uninitialize()
Defined by dijit/_WidgetBase

Deprecated. Override destroy() instead to implement custom widget tear-down behavior.

Returns:boolean
unsubscribe(handle)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use handle.remove() instead.

Unsubscribes handle created by this.subscribe. Also removes handle from this widget's list of subscriptions

Parameter Type Description
handle Object
update()
Defined by dojox/grid/_Grid

Update the grid, retaining edit and scrolling states.

updateRow(inRowIndex)
Defined by dojox/grid/_Grid

Render a single row.

Parameter Type Description
inRowIndex Integer

Index of the row to render

updateRowCount(inRowCount)
Defined by dojox/grid/_Grid

Change the number of rows.

Parameter Type Description
inRowCount int

Number of rows in the grid.

updateRows(startIndex,howMany)
Defined by dojox/grid/_Grid

Render consecutive rows at once.

Parameter Type Description
startIndex Integer

Index of the starting row to render

howMany Integer

How many rows to update.

updateRowStyles(inRowIndex)
Defined by dojox/grid/_Grid

Update the styles for a row after it's state has changed.

Parameter Type Description
inRowIndex undefined
watch(name,callback)
Defined by dojo/Stateful

Watches a property for changes

Parameter Type Description
name String
Optional

Indicates the property to watch. This is optional (the callback may be the only parameter), and if omitted, all the properties will be watched

callback Function

The function to execute when the property changes. This will be called after the property has been changed. The callback will be called with the |this| set to the instance, the first argument as the name of the property, the second argument as the old value and the third argument as the new value.

Returns:any | object

An object handle for the watch. The unwatch method of this object can be used to discontinue watching this property:

var watchHandle = obj.watch("foo", callback);
watchHandle.unwatch(); // callback won't be called now

Events

_onBlur()
Defined by: dijit/_FocusMixin

This is where widgets do processing for when they stop being active, such as changing CSS classes. See onBlur() for more details.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onDelete(item)
Defined by: dojox/grid/DataGrid
Parameter Type Description
item undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onFetchBegin(size,req)
Defined by: dojox/grid/DataGrid
Parameter Type Description
size undefined
req undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onFetchComplete(items,req)
Defined by: dojox/grid/DataGrid
Parameter Type Description
items undefined
req undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onFetchError(err,req)
Defined by: dojox/grid/DataGrid
Parameter Type Description
err undefined
req undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onFocus()
Defined by: dijit/_FocusMixin

This is where widgets do processing for when they are active, such as changing CSS classes. See onFocus() for more details.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onMap(type)
Defined by: dijit/_WidgetBase

Maps on() type parameter (ex: "mousemove") to method name (ex: "onMouseMove"). If type is a synthetic event like touch.press then returns undefined.

Parameter Type Description
type String | Function
Returns:undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onNew(item,parentInfo)
Defined by: dojox/grid/DataGrid
Parameter Type Description
item undefined
parentInfo undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onRevert()
Defined by: dojox/grid/DataGrid

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onSet(item,attribute,oldValue,newValue)
Defined by: dojox/grid/DataGrid
Parameter Type Description
item undefined
attribute undefined
oldValue undefined
newValue undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onShow()
Defined by: dijit/_Widget

Internal method called when this widget is made visible. See onShow for details.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onApplyCellEdit(inValue,inRowIndex,inFieldIndex)
Defined by: dojox/grid/_Events

Event fired when editing is applied for a given grid cell

Parameter Type Description
inValue String

Value from cell editor

inRowIndex Integer

Index of the grid row

inFieldIndex Integer

Index in the grid's data store

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onApplyEdit(inRowIndex)
Defined by: dojox/grid/_Events

Event fired when editing is applied for a given grid row

Parameter Type Description
inRowIndex Integer

Index of the grid row

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onBlur()
Defined by: dijit/_FocusMixin

Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCancelEdit(inRowIndex)
Defined by: dojox/grid/_Events

Event fired when editing is cancelled for a given grid cell

Parameter Type Description
inRowIndex Integer

Index of the grid row

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCanDeselect(inRowIndex)
Defined by: dojox/grid/_Events

Event to determine if a grid row may be deselected

Parameter Type Description
inRowIndex Integer

Index of the grid row

Returns:Boolean | boolean

true if the row can be deselected

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCanSelect(inRowIndex)
Defined by: dojox/grid/_Events

Event to determine if a grid row may be selected

Parameter Type Description
inRowIndex Integer

Index of the grid row

Returns:Boolean | boolean

true if the row can be selected

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCellClick(e)
Defined by: dojox/grid/_Events

Event fired when a cell is clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCellContextMenu(e)
Defined by: dojox/grid/_Events

Event fired when a cell context menu is accessed via mouse right click.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCellDblClick(e)
Defined by: dojox/grid/_Events

Event fired when a cell is double-clicked.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCellFocus(inCell,inRowIndex)
Defined by: dojox/grid/_Events

Event fired when a cell receives focus.

Parameter Type Description
inCell Object

Cell object containing properties of the grid column.

inRowIndex Integer

Index of the grid row

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCellMouseDown(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down in a header cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCellMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of a cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onCellMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse is over a cell.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onClick(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of mouse click events.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onClose()
Defined by: dijit/_Widget

Called when this widget is being displayed as a popup (ex: a Calendar popped up from a DateTextBox), and it is hidden. This is called from the dijit.popup code, and should not be called directly.

Also used as a parameter for children of dijit/layout/StackContainer or subclasses. Callback if a user tries to close the child. Child will be closed if this function returns true.

Returns:boolean

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onContentEvent(e)
Defined by: dojox/grid/_Events

Top level handler for Content events

Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onDblClick(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of mouse double click events.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onDeselected(inRowIndex)
Defined by: dojox/grid/_Events

Event fired when a grid row is deselected

Parameter Type Description
inRowIndex Integer

Index of the grid row

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onFetchError(err,req)
Defined by: dojox/grid/DataGrid
Parameter Type Description
err undefined
req undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onFocus()
Defined by: dijit/_FocusMixin

Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderCellClick(e)
Defined by: dojox/grid/_Events

Event fired when a header cell is clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderCellContextMenu(e)
Defined by: dojox/grid/_Events

Event fired when a header cell context menu is accessed via mouse right click.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderCellDblClick(e)
Defined by: dojox/grid/_Events

Event fired when a header cell is double clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderCellMouseDown(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down in a header cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderCellMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of a header cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderCellMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves over a header cell.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderClick(e)
Defined by: dojox/grid/_Events

Event fired when the grid header is clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderContextMenu(e)
Defined by: dojox/grid/_Events

Event fired when the grid header context menu is accessed via mouse right click.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderDblClick(e)
Defined by: dojox/grid/_Events

Event fired when the grid header is double clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderEvent(e)
Defined by: dojox/grid/_Events

Top level handler for header events

Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of the grid header.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHeaderMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves over the grid header.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onHide()
Defined by: dijit/_Widget

Called when another widget becomes the selected pane in a dijit/layout/TabContainer, dijit/layout/StackContainer, dijit/layout/AccordionContainer, etc.

Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onKeyDown(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of keys being pressed down.

Parameter Type Description
event undefined

key Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onKeyEvent(e)
Defined by: dojox/grid/_Events

top level handler for Key Events

Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onKeyPress(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of printable keys being typed.

Parameter Type Description
event undefined

key Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onKeyUp(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of keys being released.

Parameter Type Description
event undefined

key Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseDown(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of when the mouse button is pressed down.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseDownRow(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down inside grid row

Parameter Type Description
e Event

Decorated event object that contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseEnter(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of when the mouse moves onto this widget.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseLeave(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of when the mouse moves off of this widget.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseMove(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseOut(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseOutRow(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of any row (data or header).

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseOver(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseOverRow(e)
Defined by: dojox/grid/_Events

Event fired when mouse is over any row (data or header).

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMouseUp(event)
Defined by: dijit/_Widget

Connect to this function to receive notifications of when the mouse button is released.

Parameter Type Description
event undefined

mouse Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onMoveColumn()
Defined by: dojox/grid/_Grid

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onResizeColumn(cellIdx)
Defined by: dojox/grid/_Grid
Parameter Type Description
cellIdx int

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRowClick(e)
Defined by: dojox/grid/_Events

Event fired when a row is clicked.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRowContextMenu(e)
Defined by: dojox/grid/_Events

Event fired when a row context menu is accessed via mouse right click.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRowDblClick(e)
Defined by: dojox/grid/_Events

Event fired when a row is double clicked.

Parameter Type Description
e Event

decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRowMouseDown(e)
Defined by: dojox/grid/_Events

Event fired when mouse is down in a row.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRowMouseOut(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves out of a data row.

Parameter Type Description
e Event

Decorated event object contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onRowMouseOver(e)
Defined by: dojox/grid/_Events

Event fired when mouse moves over a data row.

Parameter Type Description
e Event

Decorated event object which contains reference to grid, cell, and rowIndex

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onSelected(inRowIndex)
Defined by: dojox/grid/_Events

Event fired when a grid row is selected

Parameter Type Description
inRowIndex Integer

Index of the grid row

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onSelectionChanged()
Defined by: dojox/grid/_Events

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onShow()
Defined by: dijit/_Widget

Called when this widget becomes the selected pane in a dijit/layout/TabContainer, dijit/layout/StackContainer, dijit/layout/AccordionContainer, etc.

Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onStartEdit(inCell,inRowIndex)
Defined by: dojox/grid/_Events

Event fired when editing is started for a given grid cell

Parameter Type Description
inCell Object

Cell object containing properties of the grid column.

inRowIndex Integer

Index of the grid row

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onStyleRow(inRow)
Defined by: dojox/grid/DataGrid
Parameter Type Description
inRow undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
Error in the documentation? Can’t find what you are looking for? Let us know!