Dojo: The Definitive Guide

Dijit API Drive-By

The functions listed in Table 11-4 are too commonly used not to especially call out. They're available as part of Dijit Base and get pulled in whenever you require Dijit resources into the page. You can also fetch them by issuing a dojo.require("dijit.dijit") statement, as they are included in the standard build profile, which you'll read more about in Chapter 16.

Tip

For comprehensive API documentation, visit Dojo's online documentation at http://api.dojotoolkit.org.

Table 11-4. Commonly used Dijit functions

Function/Member	Comment
dijit.registry( )	The registry contains a complete record of all dijits that are on the page and may be used to explicitly iterate through them, to check for the existence of a particular dijit, etc. For example, you could uniformly manipulate every dijit on a page via the dijit.registry.forEach function or you could query the page for a particular type of widget via dijit.registry.byClass (where "class" is in the OOP sense).
dijit.byNode(/* DOM Node */ node)	Given a node, returns the dijit that represents this node.
dijit.getEnclosingWidget(/* DOM Node */ node)	Given a node, returns the dijit whose DOM tree contains this node. This method is especially handy for situations in which you need a quick reference to a dijit via a DOM event. For example, you might use this method to easily find a dijit via the target property of the event object that is associated with a mouse click when a user clicks the mouse on some part of a dijit.
dijit.getViewport( ...