Dojo API CheatSheet
var
  • d = dojo,
  • $ = d.query,
  • dk = d.keys
Key Constants
  • (dojo.keys.*)
  • BACKSPACE
  • TAB
  • CLEAR
  • ENTER
  • SHIFT
  • CTRL
  • ALT
  • META
  • PAUSE
  • CAPS_LOCK
  • ESCAPE
  • SPACE
  • PAGE_UP
  • PAGE_DOWN
  • END
  • HOME
  • LEFT_ARROW
  • UP_ARROW
  • RIGHT_ARROW
  • DOWN_ARROW
  • INSERT
  • DELETE
  • HELP
  • LEFT_WINDOW
  • RIGHT_WINDOW
  • SELECT
  • NUMPAD_0
  • NUMPAD_1
  • NUMPAD_2
  • NUMPAD_3
  • NUMPAD_4
  • NUMPAD_5
  • NUMPAD_6
  • NUMPAD_7
  • NUMPAD_8
  • NUMPAD_9
  • NUMPAD_MULTIPLY
  • NUMPAD_PLUS
  • NUMPAD_ENTER
  • NUMPAD_MINUS
  • NUMPAD_PERIOD
  • NUMPAD_DIVIDE
  • F1
  • F2
  • F3
  • F4
  • F5
  • F6
  • F7
  • F8
  • F9
  • F10
  • F11
  • F12
  • F13
  • F14
  • F15
  • NUM_LOCK
  • SCROLL_LOCK
  • UP_DPAD
  • DOWN_DPAD
  • LEFT_DPAD
  • RIGHT_DPAD
  • copyKey
Miscellaneous
  • d.config
  • d.baseUrl
  • d.locale
  • d.version
  • d.experimentalfunction()
  • d.deprecatedfunction()
    • Advanced Scope
    • d.global
  • d.doc
  • d.setContextfunction(/*Object*/ globalObject, /*DocumentElement*/ globalDocument)
  • d.withGlobalfunction( /*Object*/ globalObject, /*Function*/ callback, /*Object?*/ thisObject, /*Array?*/ cbArguments)
  • d.withDocfunction( /*DocumentElement*/ documentObject, /*Function*/ callback, /*Object?*/ thisObject, /*Array?*/ cbArguments)
    • Document Lifecycle
    • d.addOnLoadfunction(priority, context, callback)
  • d.readyfunction(priority, context, callback)
  • d.addOnWindowUnloadfunction(/*Object|Function?*/ obj, /*String|Function?*/ functionName)
  • d.addOnUnloadfunction(/*Object?|Function?*/ obj, /*String|Function?*/ functionName)
    • Unknown Tag
    • d.dojox
  • d.scopeMap
  • d.exitfunction()
  • d.clearCachefunction()
  • d.isIos
  • d.isAndroid
  • d.isWii
  • d.isAir
  • d.getAttrgetAttr(/*DOMNode|String*/ node, /*String*/ name)
  • d.setAttrsetAttr(/*DOMNode|String*/ node, /*String|Object*/ name, /*String?*/ value)
  • d.toDomtoDom(frag, doc)
  • d.getPadExtentsgetPadExtents(/*DomNode*/ node, /*Object*/ computedStyle)
  • d.getBorderExtentsgetBorderExtents(/*DomNode*/ node, /*Object*/ computedStyle)
  • d.getPadBorderExtentsgetPadBorderExtents(/*DomNode*/ node, /*Object*/ computedStyle)
  • d.getMarginExtentsgetMarginExtents(node, computedStyle)
  • d.getMarginSizegetMarginSize(/*DomNode*/ node, /*Object*/ computedStyle)
  • d.getMarginBoxgetMarginBox(/*DomNode*/ node, /*Object*/ computedStyle)
  • d.setMarginBoxsetMarginBox(/*DomNode*/ node, /*Object*/ box, /*Object*/ computedStyle)
  • d.getContentBoxgetContentBox(node, computedStyle)
  • d.setContentSizesetContentSize(/*DomNode*/ node, /*Object*/ box, /*Object*/ computedStyle)
  • d.isBodyLtrisBodyLtr(/*Document?*/ doc)
  • d.docScrolldocScroll(/*Document?*/ doc)
  • d.getIeDocumentElementOffsetfunction(/*Document?*/ doc)
  • d.fixIeBiDiScrollLeftfixIeBiDiScrollLeft(/*Integer*/ scrollLeft, /*Document?*/ doc)
  • d.getPropgetProp(/*DOMNode|String*/ node, /*String*/ name)
  • d.setPropsetProp(/*DOMNode|String*/ node, /*String|Object*/ name, /*String?*/ value)
  • d.propfunction(/*DomNode|String*/node, /*String|Object*/name, /*String?*/value)
  • d.getStylegetStyle(/*DOMNode|String*/ node, /*String?*/ name)
  • d.setStylesetStyle(/*DOMNode|String*/ node, /*String|Object*/ name, /*String?*/ value)
  • d.toPixelValuefunction(element, value)
  • $('.nodes').constructorfunction(array)
  • $('.nodes').toStringfunction()
    • Package System
    • d.isAsync
  • d.moduleUrlfunction(/*String*/module, /*String?*/url)
  • d.providefunction(mid)
  • d.requirefunction(moduleName, omitModuleCheck)
  • d.registerModulePathfunction(/*String*/moduleName, /*String*/prefix)
  • d.platformRequirefunction(/*Object*/modMap)
  • d.requireAfterIffunction(/*Boolean*/ condition, /*String*/ moduleName, /*Boolean?*/omitModuleCheck)
  • d.requireIffunction(/*Boolean*/ condition, /*String*/ moduleName, /*Boolean?*/omitModuleCheck)
  • d.requireLocalizationfunction(/*String*/moduleName, /*String*/bundleName, /*String?*/locale)
    • Ajax
    • d.contentHandlers
  • d.xhrfunction(/*String*/ method, /*dojo.__XhrArgs*/ args, /*Boolean?*/ hasBody)
  • d.xhrGetfunction(/*dojo.__XhrArgs*/ args)
  • d.xhrPostfunction(/*dojo.__XhrArgs*/ args)
  • d.rawXhrPostfunction(/*dojo.__XhrArgs*/ args)
  • d.xhrPutfunction(/*dojo.__XhrArgs*/ args)
  • d.rawXhrPutfunction(/*dojo.__XhrArgs*/ args)
  • d.xhrDeletefunction(/*dojo.__XhrArgs*/ args)
    • Arrays
    • d.everyfunction(a, fn, o)
  • d.somefunction(a, fn, o)
  • d.indexOffunction(a, x, from, last)
  • d.lastIndexOffunction(a, x, from, last)
  • d.forEachfunction(arr, callback, thisObject)
  • d.mapfunction(arr, callback, thisObject, Ctr)
  • d.filterfunction(arr, callback, thisObject)
  • $('.nodes').slicefunction()
  • $('.nodes').splicefunction()
  • $('.nodes').indexOffunction()
  • $('.nodes').lastIndexOffunction()
  • $('.nodes').everyfunction()
  • $('.nodes').somefunction()
  • $('.nodes').endfunction()
  • $('.nodes').concatfunction(item)
  • $('.nodes').mapfunction(/*Function*/ func, /*Function?*/ obj)
  • $('.nodes').forEachfunction(callback, thisObj)
  • $('.nodes').filterfunction(/*String|Function*/ filter)
  • $('.nodes').atfunction(/*===== index =====*/)
    • Language Helpers
    • d.evalfunction()
  • d.isStringfunction(it)
  • d.isArrayisArray()
  • d.isFunctionfunction(it)
  • d.isObjectfunction(it)
  • d.isArrayLikefunction(it)
  • d.isAlienfunction(it)
  • d._toArrayfunction(obj, offset, startWith)
  • d.trimfunction(str)
  • d.replacefunction(tmpl, map, pattern)
  • new d.Deferredfunction(/*Function?*/ canceller)
  • d.whenwhen(valueOrPromise, callback, errback, progback)
    • Objects OO
    • d.mixinfunction(dest, sources)
  • d.setObjectfunction(name, value, context)
  • d.getObjectfunction(name, create, context)
  • d.existsfunction(name, obj)
  • d.extendfunction(ctor, props)
  • d.hitchfunction(scope, method)
  • d.delegatefunction(obj, props)
  • d.partialfunction(/*Function|String*/ method /*, ...*/)
  • d.safeMixinsafeMixin(target, source)
  • d.declaredeclare(className, superclass, props)
  • $('.nodes').instantiatefunction(/*String|Object*/ declaredClass, /*Object?*/ properties)
    • DOM Manipulation
    • d.clonefunction(/*anything*/ src)
  • d.bodyfunction(/*Document?*/ doc)
  • d.byIdfunction(id, doc)
  • d.placeplace(node, refNode, position)
  • d.createcreate(/*DOMNode|String*/ tag, /*Object*/ attrs, /*DOMNode|String?*/ refNode, /*String?*/ pos)
  • d.emptyfunction(node)
  • d.destroyfunction(node)
  • d.queryfunction(/*String*/ query, /*String|DOMNode?*/ root)
  • $('.nodes').emptyfunction()
  • $('.nodes').placefunction(/*String||Node*/ queryOrNode, /*String*/ position)
  • $('.nodes').orphanfunction(/*String?*/ filter)
  • $('.nodes').adoptfunction(/*String||Array||DomNode*/ queryOrListOrNode, /*String?*/ position)
  • $('.nodes').queryfunction(/*String*/ queryStr)
  • $('.nodes').addContentfunction(/*String||DomNode||Object||dojo/NodeList*/ content, /*String||Integer?*/ position)
    • NodeList Events
    • $('.nodes').onblurfunction(a, b)
  • $('.nodes').onfocusfunction(a, b)
  • $('.nodes').onchangefunction(a, b)
  • $('.nodes').onclickfunction(a, b)
  • $('.nodes').onerrorfunction(a, b)
  • $('.nodes').onkeydownfunction(a, b)
  • $('.nodes').onkeypressfunction(a, b)
  • $('.nodes').onkeyupfunction(a, b)
  • $('.nodes').onloadfunction(a, b)
  • $('.nodes').onmousedownfunction(a, b)
  • $('.nodes').onmouseenterfunction(a, b)
  • $('.nodes').onmouseleavefunction(a, b)
  • $('.nodes').onmousemovefunction(a, b)
  • $('.nodes').onmouseoutfunction(a, b)
  • $('.nodes').onmouseoverfunction(a, b)
  • $('.nodes').onmouseupfunction(a, b)
  • $('.nodes').onsubmitfunction(a, b)
    • Event System
    • d.fixEventfunction(/*Event*/ evt, /*DOMNode*/ sender)
  • d.stopEventfunction(/*Event*/ evt)
  • d.mouseButtons
  • d.connectfunction(obj, event, context, method, dontFix)
  • d.disconnectfunction(handle)
  • d.subscribefunction(topic, context, method)
  • d.publishfunction(topic, args)
  • d.connectPublisherfunction(topic, obj, event)
  • d.isCopyKeyfunction(e)
  • d.unsubscribefunction(handle)
  • $('.nodes').onfunction(eventName, listener)
  • $('.nodes').connectfunction()
    • Sniffing
    • d.isBrowser
  • d.isFF
  • d.isIE
  • d.isKhtml
  • d.isWebKit
  • d.isMozilla
  • d.isMoz
  • d.isOpera
  • d.isSafari
  • d.isChrome
  • d.isMac
  • d.isQuirks
    • DOM Attributes
    • d.isDescendantfunction(/*DOMNode|String*/ node, /*DOMNode|String*/ ancestor)
  • d.setSelectablefunction(node, selectable)
  • d.hasAttrhasAttr(/*DOMNode|String*/ node, /*String*/ name)
  • d.removeAttrremoveAttr(/*DOMNode|String*/ node, /*String*/ name)
  • d.getNodePropgetNodeProp(/*DomNode|String*/ node, /*String*/ name)
  • d.attrfunction(node, name, value)
  • d.positionfunction(/*DomNode*/ node, /*Boolean?*/ includeScroll)
  • d.marginBoxmarginBox(/*DomNode|String*/node, /*Object?*/box)
  • d.contentBoxcontentBox(/*DomNode|String*/node, /*Object?*/box)
  • d.coordsfunction(/*DomNode|String*/node, /*Boolean?*/includeScroll)
  • $('.nodes').positionfunction()
  • $('.nodes').attrfunction()
  • $('.nodes').removeAttrfunction()
  • $('.nodes').marginBoxfunction()
  • $('.nodes').coordsfunction()
    • Styles CSS
    • d.hasClasscontainsClass(/*DomNode|String*/ node, /*String*/ classStr)
  • d.addClassaddClass(/*DomNode|String*/ node, /*String|Array*/ classStr)
  • d.removeClassremoveClass(/*DomNode|String*/ node, /*String|Array?*/ classStr)
  • d.toggleClasstoggleClass(/*DomNode|String*/ node, /*String|Array*/ classStr, /*Boolean?*/ condition)
  • d.replaceClassreplaceClass(/*DomNode|String*/ node, /*String|Array*/ addClassStr, /*String|Array?*/ removeClassStr)
  • d.getComputedStylefunction(/*DomNode*/ node)
  • d.stylefunction(node, name, value)
  • $('.nodes').stylefunction()
  • $('.nodes').addClassfunction()
  • $('.nodes').removeClassfunction()
  • $('.nodes').toggleClassfunction()
  • $('.nodes').replaceClassfunction()
    • Effects
    • new d.Animationfunction(args)
  • d.fadeInfunction(/*__FadeArgs*/ args)
  • d.fadeOutfunction(/*__FadeArgs*/ args)
  • d.animatePropertyfunction(/*__AnimArgs*/ args)
  • d.animfunction( /*DOMNode|String*/ node, /*Object*/ properties, /*Integer?*/ duration, /*Function?*/ easing, /*Function?*/ onEnd, /*Integer?*/ delay)
  • anim.duration
  • anim.repeat
  • anim.rate
  • anim.playfunction(/*int?*/ delay, /*Boolean?*/ gotoStart)
  • anim.pausefunction()
  • anim.gotoPercentfunction(/*Decimal*/ percent, /*Boolean?*/ andPlay)
  • anim.stopfunction(/*boolean?*/ gotoEnd)
  • anim.destroyfunction()
  • anim.statusfunction()
  • anim.onfunction(type, listener)
  • anim.emitfunction(type, event)
    • JSON
    • d.fromJsonfunction(/*String*/ js)
  • d.toJsonIndentStr
  • d.toJsonfunction(/*Object*/ it, /*Boolean?*/ prettyPrint)
  • d.objectToQueryobjectToQuery(/*Object*/ map)
  • d.queryToObjectqueryToObject(/*String*/ str)
  • d.fieldToObjectfieldToObject(/*DOMNode|String*/ inputNode)
  • d.formToObjectformToObject(/*DOMNode|String*/ formNode)
  • d.formToQueryformToQuery(/*DOMNode|String*/ formNode)
  • d.formToJsonformToJson(/*DOMNode|String*/ formNode, /*Boolean?*/ prettyPrint)
    • Colors
    • new d.Colorfunction(/*Array|String|Object*/ color)
  • d.blendColorsfunction( /*Color*/ start, /*Color*/ end, /*Number*/ weight, /*Color?*/ obj )
  • d.colorFromRgbfunction(/*String*/ color, /*Color?*/ obj)
  • d.colorFromHexfunction(/*String*/ color, /*Color?*/ obj)
  • d.colorFromArrayfunction(/*Array*/ a, /*Color?*/ obj)
  • d.colorFromStringfunction(/*String*/ str, /*Color?*/ obj)
    • djConfig
    • djConfig.parseOnLoad
    • djConfig.requires
    • djConfig.packages
    • djConfig.trace
    • djConfig.async
    • djConfig.waitSeconds
    • djConfig.baseUrl
    • djConfig.config
    • djConfig.locale
    • djConfig.afterOnLoad
    1.18.0-pre (NaN)