Dojo Toolkit API Overview

Dojo API CheatSheet

Top
Key Constants (59)
Arrays (18)
DOM Manipulation (17)
NodeList Events (17)
Effects (13)
DOM Attributes (11)
Styles CSS (11)
Objects OO (10)
Language Helpers (10)
Package System (9)
Event System (9)
Sniffing (8)
JSON (8)
Ajax (7)
Miscellaneous (6)
Colors (6)
Advanced Scope (5)
djConfig (5)
Document Lifecycle (3)

var

d = dojo,
$ = d.query,
dk = d.keys

Key Constants

Arrays

d.indexOf(array, value, fromIndex, findLast)
d.lastIndexOf(array, value, fromIndex)
d.forEach(arr, callback, thisObject)
d.every(arr, callback, thisObject)
d.some(arr, callback, thisObject)
d.map(arr, callback, thisObject)
d.filter(arr, callback, thisObject)
$('.nodes').slice()
$('.nodes').splice()
$('.nodes').indexOf()
$('.nodes').lastIndexOf()
$('.nodes').every()
$('.nodes').some()
$('.nodes').concat(item)
$('.nodes').map(func, obj)
$('.nodes').forEach(callback, thisObj)
$('.nodes').filter(simpleFilter)
$('.nodes').at()

DOM Manipulation

d.clone(o)
d.body()
d.byId(id, doc)
d.destroy(node)
d.place(node, refNode, position)
d.create(nodeType, attrs, refNode, pos)
d.empty(node)
d.query(query, scope)
$('.nodes').empty()
$('.nodes').place(queryOrNode, position)
$('.nodes').orphan(simpleFilter)
$('.nodes').adopt(queryOrListOrNode, position)
$('.nodes').query(queryStr)
$('.nodes').addContent(content, position)
$('.nodes').destroy()
$('.nodes').create(tagName)
$('.nodes').clone()

NodeList Events

$('.nodes').onblur(a, b)
$('.nodes').onfocus(a, b)
$('.nodes').onchange(a, b)
$('.nodes').onclick(a, b)
$('.nodes').onerror(a, b)
$('.nodes').onkeydown(a, b)
$('.nodes').onkeypress(a, b)
$('.nodes').onkeyup(a, b)
$('.nodes').onload(a, b)
$('.nodes').onmousedown(a, b)
$('.nodes').onmouseenter(a, b)
$('.nodes').onmouseleave(a, b)
$('.nodes').onmousemove(a, b)
$('.nodes').onmouseout(a, b)
$('.nodes').onmouseover(a, b)
$('.nodes').onmouseup(a, b)
$('.nodes').onsubmit(a, b)

Effects

new d._Animation()
d.fadeIn(args)
d.fadeOut(args)
d.animateProperty(args)
d.anim(node, properties, duration, easing, onEnd, delay)
anim.duration
anim.repeat
anim.rate
anim.play(delay, gotoStart)
anim.pause()
anim.gotoPercent(percent, andPlay)
anim.stop(gotoEnd)
anim.status()

DOM Attributes

d.isDescendant(node, ancestor)
d.setSelectable(node, selectable)
d.marginBox(node, box)
d.contentBox(node, box)
d.coords(node, includeScroll)
d.hasAttr(node, name)
d.attr(node, name, value)
d.removeAttr(node, name)
$('.nodes').attr()
$('.nodes').coords()
$('.nodes').val(value)

Styles CSS

d.boxModel
d.getComputedStyle(node)
d.style(node, style, value)
d.hasClass(node, classStr)
d.addClass(node, classStr)
d.removeClass(node, classStr)
d.toggleClass(node, classStr, condition)
$('.nodes').style()
$('.nodes').addClass()
$('.nodes').removeClass()
$('.nodes').toggleClass()

Objects OO

d.mixin(obj, props)
d.setObject(name, value, context)
d.getObject(name, create, context)
d.exists(name, obj)
d.extend(constructor, props)
d.hitch(scope, method)
d.delegate(obj, props)
d.partial(method)
d.declare(className, superclass, props)
$('.nodes').instantiate(declaredClass, properties)

Language Helpers

d.eval(scriptFragment)
d.isString(it)
d.isArray(it)
d.isFunction(it)
d.isObject(it)
d.isArrayLike(it)
d.isAlien(it)
d._toArray(obj, offset, startWith)
d.trim(str)
new d.Deferred(canceller)

Package System

d.require(moduleName, omitModuleCheck)
d.provide(resourceName)
d.platformRequire(modMap)
d.requireIf(condition, resourceName)
d.requireAfterIf(condition, resourceName)
d.registerModulePath(module, prefix)
d.requireLocalization(moduleName, bundleName, locale, availableFlatLocales)
d.moduleUrl(module, url)
d.load()

Event System

d.connect(obj, event, context, method, dontFix)
d.disconnect(handle)
d.subscribe(topic, context, method)
d.unsubscribe(handle)
d.publish(topic, args)
d.connectPublisher(topic, obj, event)
d.fixEvent(evt, sender)
d.stopEvent(evt)
$('.nodes').connect()

Sniffing

d.isBrowser
d.isKhtml
d.isWebKit
d.isChrome
d.isMoz
d.isMozilla
d.isFF
d.isQuirks

JSON

d.fromJson(json)
d.toJsonIndentStr
d.toJson(it, prettyPrint, _indentStr)
d.formToObject(formNode)
d.objectToQuery(map)
d.formToQuery(formNode)
d.formToJson(formNode, prettyPrint)
d.queryToObject(str)

Ajax

d.xhr(method, args, hasBody)
d.xhrGet(args)
d.xhrPost(args)
d.rawXhrPost(args)
d.xhrPut(args)
d.rawXhrPut(args)
d.xhrDelete(args)

Miscellaneous

d.config
d.locale
d.version
d.experimental()
d.deprecated()
d.baseUrl

Colors

new d.Color(color)
d.blendColors(start, end, weight, obj)
d.colorFromRgb(color, obj)
d.colorFromHex(color, obj)
d.colorFromArray(a, obj)
d.colorFromString(str, obj)

Advanced Scope

d.global
d.doc
d.setContext(globalObject, globalDocument)
d.withGlobal(globalObject, callback, thisObject, cbArguments)
d.withDoc(documentObject, callback, thisObject, cbArguments)

djConfig

djConfig.parseOnLoad
djConfig.requires
djConfig.isDebug
djConfig.debugAtAllCosts
djConfig.baseUrl

Document Lifecycle

d.addOnLoad(obj, functionName)
d.addOnWindowUnload(obj, functionName)
d.addOnUnload(obj, functionName)

Dojo 1.3.0 (17146) Docs generated 2009-03-29