Dojo
Dojo is divided into two parts: dojo.js ,and the rest of Dojo Core. Typically,if a function or Class exists within the dojo namespace directly (eg: dojo.require() ,dojo.addOnLoad() ) it is provided directly by dojo.js . If the function or Class exists beneath the dojo namespace (eg: dojo.dnd.Mover ),you will need to require the appropriate module (eg: dojo.require("dojo.dnd.Mover"); )
These pages cover both cases,and indicate how they are provided.
Base Dojo: dojo.js
Dojo Base is the functionality you get by just including a stock built dojo.js or dojo.xd.js in your page.
Configuring Dojo
Array utilities
Details on dojo.every,dojo.filter,dojo.forEach,dojo.indexOf,dojo.lastIndexOf,dojo.map,and dojo.some. See the Array QuickStart for an overview.
- @H_403_40@dojo.forEach
Invokes a callback function for every item in array
- @H_403_40@dojo.map
Applies a callback to each element of arr and returns an Array with the results
- @H_403_40@dojo.some
Iterate over an array,escaping when the callback returns true for some logic check.
- @H_403_40@dojo.every
Iterate over an array,escaping when the callback returns false for some logic check.
- @H_403_40@dojo.filter
Iterate over an array,reducing the array based on the callback return.
- @H_403_40@dojo.indexOf
Find the index of some element in an Array.
- @H_403_40@NodeList array methods
- NodeList.indexOf,NodeList.lastIndexOf,NodeList.forEach,NodeList.every,NodeList.some,NodeList.concat,NodeList.map,NodeList.filter,NodeList.at
Language Utilities
- @H_403_40@dojo.Deferred
Communication between threads
- @H_403_40@dojo.hitch
Function that generates a wrapper function that ensures a function that will only ever execute in a defined scope.
- @H_403_40@dojo.partial
Function that generates a wrapper function that ensures a function will only ever execute globally.
- @H_403_40@dojo.delegate
Returns a new object which “looks” to obj for properties which it does not have a value for.
- @H_403_40@dojo.isString
Checks if the parameter is a String
- @H_403_40@dojo.isArray
Checks if the parameter is an Array
- @H_403_40@dojo.isFunction
Checks if the parameter is a Function
- @H_403_40@dojo.isObject
Checks if the parameter is an Object
- @H_403_40@dojo.isArrayLike
Checks if the parameter is like an Array
- @H_403_40@dojo.isAlien
Checks if the parameter is a built-in function
String Utilities
- @H_403_40@dojo.trim
Trim whitespace from a String
- @H_403_40@dojo.replace
Simple templates with parameterized substitutions.
DOM
- @H_403_40@dojo.query
The swiss army knife of DOM node manipulation in Dojo.
- @H_403_40@dojo.NodeList
A class to handle a list of DOM nodes. Most commonly returned from a dojo.query call.
- @H_403_40@dojo.doc
Alias for the current document
- @H_403_40@dojo.body
Return the body element of the document
- @H_403_40@dojo.byId
Select a DOM node by ‘id’
- @H_403_40@Manipulation
- @H_403_40@dojo.create
Creates a dom node with optional values and placement
- @H_403_40@dojo.place
Place DOM nodes relative to others
- @H_403_40@NodeList.place
Place DOM nodes in list relative to others
- @H_403_40@NodeList.orphan
- @H_403_40@NodeList.adopt
- @H_403_40@NodeList.clone
- @H_403_40@NodeList.addContent
- @H_403_40@dojo.destroy
Destroy a DOM element
- @H_403_40@dojo.empty
Empty the contents of a DOM element
- @H_403_40@NodeList.empty
- @H_403_40@dojo.create
- @H_403_40@Attributes
- @H_403_40@dojo.formToJson
Create an object from an form node
- @H_403_40@dojo.attr
Modifying DOM node attributes
- @H_403_40@dojo.NodeList.attr
Set/Get attributes for nodes in the list
- @H_403_40@dojo.hasAttr
- @H_403_40@dojo.removeAttr
- @H_403_40@dojo.getNodeProp
- @H_403_40@dojo.formToObject
- @H_403_40@dojo.formToQuery
- @H_403_40@dojo.isDescendant
- @H_403_40@dojo.setSelectable
- @H_403_40@dojo.formToJson
- @H_403_40@Styles
- @H_403_40@dojo.coords
Getter for the coordinates (relative to parent and absolute) of a DOM node. Deprecated in Dojo 1.4.
- @H_403_40@NodeList.coords
Getter for the coordinates of each node in the list. Deprecated in Dojo 1.4.
- @H_403_40@dojo.position
Getter for the border-Box x/y coordinates and size of a DOM node.
- @H_403_40@NodeList.position
Calls dojo.position for each node in the list and returns those objects as an Array.
- @H_403_40@dojo.style
A getter/setter for styles on a DOM node
- @H_403_40@dojo.getComputedStyle
Return a cachable object of all computed styles for a node
- @H_403_40@Class Utilities
- @H_403_40@dojo.hasClass
Returns a boolean depending on whether or not a node has a passed class string.
- @H_403_40@dojo.addClass
Adds a CSS class to a node.
- @H_403_40@dojo.removeClass
Removes a class from a Node.
- @H_403_40@dojo.toggleClass
Toggles a className (or now in 1.4 an array of classNames).
- @H_403_40@dojo.hasClass
- @H_403_40@dojo.marginBox
Getter/setter for the margin-Box of node
- @H_403_40@dojo.contentBox
Getter/setter for the content-Box of node
- @H_403_40@dojo.coords
Effects
- @H_403_40@dojo.animateProperty
The workhorse of most dojo.fx animations. Used for animating CSS properties
- @H_403_40@dojo.Animation
1.4+ prevIoUsly dojo._Animation,the class behind all dojo.fx
- @H_403_40@dojo.anim
Shorthand version of animateProperty using positional arguments
- @H_403_40@dojo.fadeOut
- @H_403_40@dojo.fadeIn
Events
- @H_403_40@dojo.connect
Connects events to methods
- @H_403_40@NodeList.connect
Connects events to every node in the list,like dojo.connect
- @H_403_40@NodeList.events
Common event names mapped as functions on a NodeList - eg: .onclick(function(){})
- @H_403_40@@L_301_60@
Disconnects methods from linked topics
- @H_403_40@dojo.subscribe
Linked a listener to a named topic
- @H_403_40@dojo.unsubscribe
Remove a topic listener
- @H_403_40@dojo.publish
Publish an event to all subscribers of a topic
- @H_403_40@dojo.connectPublisher
Ensure that everytime an event is called,a message is published on the topic.
- @H_403_40@dojo.stopEvent
Stop an event’s bubbling and propagation.
Document Lifecycle
- @H_403_40@dojo.addOnLoad
Call functions after the DOM has finished loading and widgets declared in markup have been instantiated
- @H_403_40@dojo.ready
1.4+ Alias for dojo.addOnLoad
- @H_403_40@dojo.addOnUnload
Call functions when the page unloads
- @H_403_40@dojo.addOnWindowUnload
Call functions when window.onunload fires
- @H_403_40@dojo.windowUnloaded
Signal fired by impending window destruction
Ajax / IO
- @H_403_40@IO Pipeline Topics
- @H_403_40@dojo.contentHandlers
1.4+ Pre-defined XHR content handlers,and an extension point to add your own custom handling.
- @H_403_40@dojo.xhr
Core for all xhr* verbs,eg: xhrPost,getGet
- @H_403_40@dojo.xhrDelete
- @H_403_40@dojo.xhrGet
- @H_403_40@dojo.xhrPost
- @H_403_40@dojo.xhrPut
- @H_403_40@dojo.rawXhrPost
- @H_403_40@dojo.rawXhrPut
Package System
- @H_403_40@dojo.registerModulePath
Maps module name to a path
- @H_403_40@dojo.require
Loads a Javascript module from the appropriate URI
- @H_403_40@dojo.provide
- @H_403_40@dojo.moduleUrl
JSON Tools
- @H_403_40@dojo.fromJson
Parses a JSON string to return a JavaScript object
- @H_403_40@@L_403_86@
Returns a JSON serialization of an object
Objects / OO Tools
- @H_403_40@dojo.mixin
Mixes one object into another. Can be used as a shallow copy
- @H_403_40@dojo.declare
Creates a constructor using a compact notation for inheritance and prototype extension
- @H_403_40@dojo.extend
- @H_403_40@dojo.exists
Determine if an object supports a given method
- @H_403_40@dojo.delegate
Delegate an Object (beget)
- @H_403_40@dojo.getObject
Get a property from a dot-separated string,such as “A.B.C”
- @H_403_40@dojo.setObject
Set a property from a dot-separated string,such as “A.B.C”
- @H_403_40@dojo.objectToQuery
- @H_403_40@dojo.queryToObject
- @H_403_40@NodeList.instantiate
Create classes out of each node in the list
Colors
Miscellaneous Base
- @H_403_40@dojo.deprecated
Log a debug message to indicate that a behavior has been deprecated
- @H_403_40@dojo.eval
Evaluate some string of JavaScript
- @H_403_40@dojo.global
Alias for the global scope
- @H_403_40@dojo.keys
A collection of key constants.
- @H_403_40@dojo.locale
A string containing the current locale as defined by Dojo
- @H_403_40@dojo.setContext
Changes the behavior of many core Dojo functions that deal with namespace and DOM lookup
- @H_403_40@dojo.version
The current version number of Dojo
- @H_403_40@dojo.withDoc
Call callback with documentObject as dojo.doc
- @H_403_40@dojo.withGlobal
Call callback with globalObject as dojo.global and globalObject.document as dojo.doc
Dojo Core
- @H_403_40@dojo.AdapterRegistry
A registry to make contextual calling/searching easier
- @H_403_40@dojo.back
Browser history management resources (Back button functionality)
- @H_403_40@dojo.behavior
Utility for unobtrusive/progressive event binding,DOM traversal,and manipulation
- @H_403_40@dojo.cldr
A Common Locale Data Repository (CLDR) implementation
- @H_403_40@dojo.cache
1.4+ A mechanism to cache inline text.
- @H_403_40@@L_403_113@
CSS color manipulation functions
- @H_403_40@dojo.cookie
Simple HTTP cookie manipulation
- @H_403_40@dojo.currency
Localized formatting and parsing routines for currency data
- @H_403_40@dojo.data
A uniform data access layer
- @H_403_40@dojo.date
Date manipulation utilities
- @H_403_40@dojo.date.locale
Offers a library of localization methods to format and parse dates and times
- @H_403_40@dojo.date.locale.addCustomFormats
Adds a reference to a bundle containing localized custom formats to be used by date/time formatting and parsing routines.
- @H_403_40@dojo.date.locale.format
Formats a Date object as a String,using locale-specific settings or custom patterns.
- @H_403_40@dojo.date.locale.getNames
Used to get localized strings from dojo.cldr for day or month names.
- @H_403_40@dojo.date.locale.isWeekend
Determines if the date falls on a weekend,according to local custom.
- @H_403_40@dojo.date.locale.parse
Converts a properly formatted string to a primitive Date object,using locale-specific settings.
- @H_403_40@dojo.date.locale.regexp
Builds the regular needed to parse a localized date
- @H_403_40@dojo.date.locale.addCustomFormats
- @H_403_40@dojo.date.locale
- @H_403_40@dojo.DeferredList
Event handling for a group of Deferred objects
- @H_403_40@dojo.dnd
Drag and Drop
- @H_403_40@dojo.fx
Effects library on top of Base animations
- @H_403_40@dojo.gears
Google Gears
- @H_403_40@dojo.hash
Normalized onhashchange module
- @H_403_40@dojo.html
Inserting contents in HTML nodes
- @H_403_40@dojo.i18n
Utility classes to enable loading of resources for internationalization
- @H_403_40@Additional AJAX I/O transports (dojo.io)
- @H_403_40@dojo.io.iframe
Sends an AJAX I/O call using an IFrame
- @H_403_40@dojo.io.script
Sends a JSONP request using a script tag
- @H_403_40@dojo.io.iframe
- @H_403_40@dojo.jaxer
- @H_403_40@dojo.NodeList-data
Adds a .data() and .removeData() API to dojo.query operations
- @H_403_40@dojo.NodeList-fx
Adds dojo.fx animation support to dojo.query()
- @H_403_40@dojo.NodeList-html
Adds a chainable html method to dojo.query()
- @H_403_40@dojo.NodeList-manipulate
1.4+ Method extensions to dojo.NodeList/dojo.query() that manipulate HTML.
- @H_403_40@dojo.NodeList-traverse
1.4+ Method extensions to dojo.NodeList/dojo.query() for traversing the DOM.
- @H_403_40@dojo.number
Localized formatting and parsing methods for number data
- @H_403_40@dojo.parser
The Dom/Widget parsing package
- @H_403_40@dojo.regexp
Regular expressions and Builder resources
- @H_403_40@dojo.robot
experimental module for DOH users
- @H_403_40@dojo.robotx
experimental module for DOH users
- @H_403_40@dojo.rpc
Communicate via Remote Procedure Calls (RPC) with Backend Servers
- @H_403_40@dojo.rpc.JsonpService
Generic JSONP service
- @H_403_40@dojo.rpc.JsonService
JSON RPC service
- @H_403_40@dojo.rpc.RpcService
RPC service class
- @H_403_40@dojo.rpc.JsonpService
- @H_403_40@dojo.string
String utilities for Dojo