transform and alpha properties concatenated with their parent\nContainer.\n\nFor example, a {{#crossLink \"Shape\"}}{{/crossLink}} with x=100 and alpha=0.5, placed in a Container with x=50\nand alpha=0.7 will be rendered to the canvas at x=150 and alpha=0.35.\nContainers have some overhead, so you generally shouldn't create a Container to hold a single child.\n\n| Tiny | Method | Tiny | Method |
| mt | {{#crossLink \"Graphics/moveTo\"}}{{/crossLink}} | \nlt | {{#crossLink \"Graphics/lineTo\"}}{{/crossLink}} |
| a/at | {{#crossLink \"Graphics/arc\"}}{{/crossLink}} / {{#crossLink \"Graphics/arcTo\"}}{{/crossLink}} | \nbt | {{#crossLink \"Graphics/bezierCurveTo\"}}{{/crossLink}} |
| qt | {{#crossLink \"Graphics/quadraticCurveTo\"}}{{/crossLink}} (also curveTo) | \nr | {{#crossLink \"Graphics/rect\"}}{{/crossLink}} |
| cp | {{#crossLink \"Graphics/closePath\"}}{{/crossLink}} | \nc | {{#crossLink \"Graphics/clear\"}}{{/crossLink}} |
| f | {{#crossLink \"Graphics/beginFill\"}}{{/crossLink}} | \nlf | {{#crossLink \"Graphics/beginLinearGradientFill\"}}{{/crossLink}} |
| rf | {{#crossLink \"Graphics/beginRadialGradientFill\"}}{{/crossLink}} | \nbf | {{#crossLink \"Graphics/beginBitmapFill\"}}{{/crossLink}} |
| ef | {{#crossLink \"Graphics/endFill\"}}{{/crossLink}} | \nss / sd | {{#crossLink \"Graphics/setStrokeStyle\"}}{{/crossLink}} / {{#crossLink \"Graphics/setStrokeDash\"}}{{/crossLink}} |
| s | {{#crossLink \"Graphics/beginStroke\"}}{{/crossLink}} | \nls | {{#crossLink \"Graphics/beginLinearGradientStroke\"}}{{/crossLink}} |
| rs | {{#crossLink \"Graphics/beginRadialGradientStroke\"}}{{/crossLink}} | \nbs | {{#crossLink \"Graphics/beginBitmapStroke\"}}{{/crossLink}} |
| es | {{#crossLink \"Graphics/endStroke\"}}{{/crossLink}} | \ndr | {{#crossLink \"Graphics/drawRect\"}}{{/crossLink}} |
| rr | {{#crossLink \"Graphics/drawRoundRect\"}}{{/crossLink}} | \nrc | {{#crossLink \"Graphics/drawRoundRectComplex\"}}{{/crossLink}} |
| dc | {{#crossLink \"Graphics/drawCircle\"}}{{/crossLink}} | \nde | {{#crossLink \"Graphics/drawEllipse\"}}{{/crossLink}} |
| dp | {{#crossLink \"Graphics/drawPolyStar\"}}{{/crossLink}} | \np | {{#crossLink \"Graphics/decodePath\"}}{{/crossLink}} |
tween.to() to animate and set properties (use no duration to have it set\nimmediately), and the tween.wait() method to create delays between animations. Note that using the\ntween.set() method to affect properties will likely not provide the desired result.",
"mainName": "MovieClip",
"tag": "main",
"itemtype": "main",
"_main": true,
"extends": "Container",
"is_constructor": 1,
"params": [
{
"name": "mode",
"description": "Initial value for the mode property. One of MovieClip.INDEPENDENT,\nMovieClip.SINGLE_FRAME, or MovieClip.SYNCHED. The default is MovieClip.INDEPENDENT.",
"type": "String",
"optional": true,
"optdefault": "independent"
},
{
"name": "startPosition",
"description": "Initial value for the startPosition property.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "loop",
"description": "Initial value for the loop property. The default is true.",
"type": "Boolean",
"optional": true,
"optdefault": "true"
},
{
"name": "labels",
"description": "A hash of labels to pass to the timeline instance associated with this MovieClip.\nLabels only need to be passed if they need to be used.",
"type": "Object",
"optional": true,
"optdefault": "null"
}
]
},
"MovieClipPlugin": {
"name": "MovieClipPlugin",
"shortname": "MovieClipPlugin",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "EaselJS",
"namespace": "",
"file": "easeljs/display/MovieClip.js",
"line": 642,
"description": "This plugin works with TweenJS to prevent the startPosition\nproperty from tweening.",
"access": "private",
"tagname": "",
"is_constructor": 1
},
"Shadow": {
"name": "Shadow",
"shortname": "Shadow",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "EaselJS",
"namespace": "",
"file": "easeljs/display/Shadow.js",
"line": 41,
"description": "This class encapsulates the properties required to define a shadow to apply to a {{#crossLink \"DisplayObject\"}}{{/crossLink}}\nvia its shadow property.\n\nUID.get())\nand should not be instantiated.",
"static": 1
},
"EaselJS": {
"name": "EaselJS",
"shortname": "EaselJS",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "EaselJS",
"namespace": "",
"file": "easeljs/version.js",
"line": 9,
"description": "Static class holding library specific information such as the version and buildDate of\nthe library."
}
},
"classitems": [
{
"file": "createjs/events/Event.js",
"line": 64,
"description": "The type of event.",
"itemtype": "property",
"name": "type",
"type": "String",
"class": "Event",
"module": "CreateJS"
},
{
"file": "createjs/events/Event.js",
"line": 71,
"description": "The object that generated an event.",
"itemtype": "property",
"name": "target",
"type": "Object",
"default": "null",
"readonly": "",
"class": "Event",
"module": "CreateJS"
},
{
"file": "createjs/events/Event.js",
"line": 80,
"description": "The current target that a bubbling event is being dispatched from. For non-bubbling events, this will\nalways be the same as target. For example, if childObj.parent = parentObj, and a bubbling event\nis generated from childObj, then a listener on parentObj would receive the event with\ntarget=childObj (the original target) and currentTarget=parentObj (where the listener was added).",
"itemtype": "property",
"name": "currentTarget",
"type": "Object",
"default": "null",
"readonly": "",
"class": "Event",
"module": "CreateJS"
},
{
"file": "createjs/events/Event.js",
"line": 92,
"description": "For bubbling events, this indicates the current event phase:paused property\nof the event will be `true`. Also, while paused the `runTime` will not increase. See {{#crossLink \"Ticker/tick:event\"}}{{/crossLink}},\n{{#crossLink \"Ticker/getTime\"}}{{/crossLink}}, and {{#crossLink \"Ticker/getEventTime\"}}{{/crossLink}} for more\ninfo.\n\nArray.sort\ndocumentation for details.",
"type": "Function"
}
],
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 363,
"description": "Returns the index of the specified child in the display list, or -1 if it is not in the display list.\n\ngetObjectsUnderPoint(), but is still potentially an expensive\noperation. See {{#crossLink \"Container/getObjectsUnderPoint\"}}{{/crossLink}} for more information.",
"itemtype": "method",
"name": "getObjectUnderPoint",
"params": [
{
"name": "x",
"description": "The x position in the container to test.",
"type": "Number"
},
{
"name": "y",
"description": "The y position in the container to test.",
"type": "Number"
},
{
"name": "mode",
"description": "The mode to use to determine which display objects to include. 0-all, 1-respect mouseEnabled/mouseChildren, 2-only mouse opaque objects.",
"type": "Number"
}
],
"return": {
"description": "The top-most display object under the specified coordinates.",
"type": "DisplayObject"
},
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 507,
"description": "Docced in superclass.",
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 515,
"description": "Docced in superclass.",
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 522,
"description": "Returns a clone of this Container. Some properties that are specific to this instance's current context are\nreverted to their defaults (for example .parent).",
"itemtype": "method",
"name": "clone",
"params": [
{
"name": "recursive",
"description": "If true, all of the descendants of this container will be cloned recursively. If false, the\nproperties of the container will be cloned, but the new instance will not have any children.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
],
"return": {
"description": "A clone of the current Container instance.",
"type": "Container"
},
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 536,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 547,
"itemtype": "method",
"name": "_tick",
"params": [
{
"name": "evtObj",
"description": "An event object that will be dispatched to all tick listeners. This object is reused between dispatchers to reduce construction & GC costs.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 562,
"description": "Recursively clones all children of this container, and adds them to the target container.",
"itemtype": "method",
"name": "cloneChildren",
"access": "protected",
"tagname": "",
"params": [
{
"name": "o",
"description": "The target container.",
"type": "Container"
}
],
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 578,
"itemtype": "method",
"name": "_getObjectsUnderPoint",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "arr",
"description": "",
"type": "Array"
},
{
"name": "mouse",
"description": "If true, it will respect mouse interaction properties like mouseEnabled, mouseChildren, and active listeners.",
"type": "Boolean"
},
{
"name": "activeListener",
"description": "If true, there is an active mouse event listener on a parent object.",
"type": "Boolean"
},
{
"name": "currentDepth",
"description": "Indicates the current depth of the search.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "DisplayObject"
},
"access": "protected",
"tagname": "",
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 632,
"itemtype": "method",
"name": "_testMask",
"params": [
{
"name": "target",
"description": "",
"type": "DisplayObject"
},
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
}
],
"return": {
"description": "Indicates whether the x/y is within the masked region.",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/Container.js",
"line": 663,
"itemtype": "method",
"name": "_getBounds",
"params": [
{
"name": "matrix",
"description": "",
"type": "Matrix2D"
},
{
"name": "ignoreTransform",
"description": "If true, does not apply this object's transform.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Rectangle"
},
"access": "protected",
"tagname": "",
"class": "Container",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 85,
"description": "The DOM object to manage.",
"itemtype": "property",
"name": "htmlElement",
"type": "HTMLElement",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 94,
"itemtype": "property",
"name": "_oldMtx",
"type": "Matrix2D",
"access": "protected",
"tagname": "",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 108,
"description": "Returns true or false indicating whether the display object would be visible if drawn to a canvas.\nThis does not account for whether it would be visible within the boundaries of the stage.\nNOTE: This method is mainly for internal use, though it may be useful for advanced uses.",
"itemtype": "method",
"name": "isVisible",
"return": {
"description": "Boolean indicating whether the display object would be visible if drawn to a canvas",
"type": "Boolean"
},
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 119,
"description": "Draws the display object into the specified context ignoring its visible, alpha, shadow, and transform.\nReturns true if the draw was handled (useful for overriding functionality).\nNOTE: This method is mainly for internal use, though it may be useful for advanced uses.",
"itemtype": "method",
"name": "draw",
"params": [
{
"name": "ctx",
"description": "The canvas 2D context object to draw into.",
"type": "CanvasRenderingContext2D"
},
{
"name": "ignoreCache",
"description": "Indicates whether the draw operation should ignore any current cache.\nFor example, used for drawing the cache (to prevent it from simply drawing an existing cache back\ninto itself).",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 136,
"description": "Not applicable to DOMElement.",
"itemtype": "method",
"name": "cache",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 142,
"description": "Not applicable to DOMElement.",
"itemtype": "method",
"name": "uncache",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 148,
"description": "Not applicable to DOMElement.",
"itemtype": "method",
"name": "updateCache",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 154,
"description": "Not applicable to DOMElement.",
"itemtype": "method",
"name": "hitTest",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 160,
"description": "Not applicable to DOMElement.",
"itemtype": "method",
"name": "localToGlobal",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 166,
"description": "Not applicable to DOMElement.",
"itemtype": "method",
"name": "globalToLocal",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 172,
"description": "Not applicable to DOMElement.",
"itemtype": "method",
"name": "localToLocal",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 178,
"description": "DOMElement cannot be cloned. Throws an error.",
"itemtype": "method",
"name": "clone",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 186,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 195,
"description": "Interaction events should be added to `htmlElement`, and not the DOMElement instance, since DOMElement instances\nare not full EaselJS display objects and do not participate in EaselJS mouse events.",
"itemtype": "event",
"name": "click",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 201,
"description": "Interaction events should be added to `htmlElement`, and not the DOMElement instance, since DOMElement instances\nare not full EaselJS display objects and do not participate in EaselJS mouse events.",
"itemtype": "event",
"name": "dblClick",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 207,
"description": "Interaction events should be added to `htmlElement`, and not the DOMElement instance, since DOMElement instances\nare not full EaselJS display objects and do not participate in EaselJS mouse events.",
"itemtype": "event",
"name": "mousedown",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 213,
"description": "The HTMLElement can listen for the mouseover event, not the DOMElement instance.\nSince DOMElement instances are not full EaselJS display objects and do not participate in EaselJS mouse events.",
"itemtype": "event",
"name": "mouseover",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 219,
"description": "Not applicable to DOMElement.",
"itemtype": "event",
"name": "tick",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 226,
"itemtype": "method",
"name": "_tick",
"params": [
{
"name": "evtObj",
"description": "An event object that will be dispatched to all tick listeners. This object is reused between dispatchers to reduce construction & GC costs.\nfunction.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DOMElement.js",
"line": 238,
"itemtype": "method",
"name": "_handleDrawEnd",
"params": [
{
"name": "evt",
"description": "",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "DOMElement",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 144,
"description": "The alpha (transparency) for this display object. 0 is fully transparent, 1 is fully opaque.",
"itemtype": "property",
"name": "alpha",
"type": "{Number}",
"default": "1",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 152,
"description": "If a cache is active, this returns the canvas that holds the cached version of this display object. See {{#crossLink \"cache\"}}{{/crossLink}}\nfor more information.",
"itemtype": "property",
"name": "cacheCanvas",
"type": "{HTMLCanvasElement | Object}",
"default": "null",
"readonly": "",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 162,
"description": "Returns an ID number that uniquely identifies the current cache for this display object. This can be used to\ndetermine if the cache has changed since a previous check.",
"itemtype": "property",
"name": "cacheID",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 171,
"description": "Unique ID for this display object. Makes display objects easier for some uses.",
"itemtype": "property",
"name": "id",
"type": "{Number}",
"default": "-1",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 179,
"description": "Indicates whether to include this object when running mouse interactions. Setting this to `false` for children\nof a {{#crossLink \"Container\"}}{{/crossLink}} will cause events on the Container to not fire when that child is\nclicked. Setting this property to `false` does not prevent the {{#crossLink \"Container/getObjectsUnderPoint\"}}{{/crossLink}}\nmethod from returning the child.\n\nNote: In EaselJS 0.7.0, the mouseEnabled property will not work properly with nested Containers. Please\ncheck out the latest NEXT version in GitHub for an updated version with this issue resolved. The fix will be\nprovided in the next release of EaselJS.",
"itemtype": "property",
"name": "mouseEnabled",
"type": "{Boolean}",
"default": "true",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 194,
"description": "If false, the tick will not run on this display object (or its children). This can provide some performance benefits.\nIn addition to preventing the \"tick\" event from being dispatched, it will also prevent tick related updates\non some display objects (ex. Sprite & MovieClip frame advancing, DOMElement visibility handling).",
"itemtype": "property",
"name": "tickEnabled",
"type": "Boolean",
"default": "true",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 204,
"description": "An optional name for this display object. Included in {{#crossLink \"DisplayObject/toString\"}}{{/crossLink}} . Useful for\ndebugging.",
"itemtype": "property",
"name": "name",
"type": "{String}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 213,
"description": "A reference to the {{#crossLink \"Container\"}}{{/crossLink}} or {{#crossLink \"Stage\"}}{{/crossLink}} object that\ncontains this display object, or null if it has not been added\nto one.",
"itemtype": "property",
"name": "parent",
"final": 1,
"type": "{Container}",
"default": "null",
"readonly": "",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 225,
"description": "The left offset for this display object's registration point. For example, to make a 100x100px Bitmap rotate\naround its center, you would set regX and {{#crossLink \"DisplayObject/regY:property\"}}{{/crossLink}} to 50.",
"itemtype": "property",
"name": "regX",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 234,
"description": "The y offset for this display object's registration point. For example, to make a 100x100px Bitmap rotate around\nits center, you would set {{#crossLink \"DisplayObject/regX:property\"}}{{/crossLink}} and regY to 50.",
"itemtype": "property",
"name": "regY",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 243,
"description": "The rotation in degrees for this display object.",
"itemtype": "property",
"name": "rotation",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 251,
"description": "The factor to stretch this display object horizontally. For example, setting scaleX to 2 will stretch the display\nobject to twice its nominal width. To horizontally flip an object, set the scale to a negative number.",
"itemtype": "property",
"name": "scaleX",
"type": "{Number}",
"default": "1",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 260,
"description": "The factor to stretch this display object vertically. For example, setting scaleY to 0.5 will stretch the display\nobject to half its nominal height. To vertically flip an object, set the scale to a negative number.",
"itemtype": "property",
"name": "scaleY",
"type": "{Number}",
"default": "1",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 269,
"description": "The factor to skew this display object horizontally.",
"itemtype": "property",
"name": "skewX",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 277,
"description": "The factor to skew this display object vertically.",
"itemtype": "property",
"name": "skewY",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 285,
"description": "A shadow object that defines the shadow to render on this display object. Set to `null` to remove a shadow. If\nnull, this property is inherited from the parent container.",
"itemtype": "property",
"name": "shadow",
"type": "{Shadow}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 294,
"description": "Indicates whether this display object should be rendered to the canvas and included when running the Stage\n{{#crossLink \"Stage/getObjectsUnderPoint\"}}{{/crossLink}} method.",
"itemtype": "property",
"name": "visible",
"type": "{Boolean}",
"default": "true",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 303,
"description": "The x (horizontal) position of the display object, relative to its parent.",
"itemtype": "property",
"name": "x",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 311,
"itemtype": "property",
"name": "y",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 318,
"description": "If set, defines the transformation for this display object, overriding all other transformation properties\n(x, y, rotation, scale, skew).",
"itemtype": "property",
"name": "transformMatrix",
"type": "{Matrix2D}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 327,
"description": "The composite operation indicates how the pixels of this display object will be composited with the elements\nbehind it. If `null`, this property is inherited from the parent container. For more information, read the\n\nwhatwg spec on compositing.",
"itemtype": "property",
"name": "compositeOperation",
"type": "{String}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 338,
"description": "Indicates whether the display object should be drawn to a whole pixel when\n{{#crossLink \"Stage/snapToPixelEnabled\"}}{{/crossLink}} is true. To enable/disable snapping on whole\ncategories of display objects, set this value on the prototype (Ex. Text.prototype.snapToPixel = true).",
"itemtype": "property",
"name": "snapToPixel",
"type": "{Boolean}",
"default": "true",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 348,
"description": "An array of Filter objects to apply to this display object. Filters are only applied / updated when {{#crossLink \"cache\"}}{{/crossLink}}\nor {{#crossLink \"updateCache\"}}{{/crossLink}} is called on the display object, and only apply to the area that is\ncached.",
"itemtype": "property",
"name": "filters",
"type": "{Array}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 358,
"description": "A Shape instance that defines a vector mask (clipping path) for this display object. The shape's transformation\nwill be applied relative to the display object's parent coordinates (as if it were a child of the parent).",
"itemtype": "property",
"name": "mask",
"type": "{Shape}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 367,
"description": "A display object that will be tested when checking mouse interactions or testing {{#crossLink \"Container/getObjectsUnderPoint\"}}{{/crossLink}}.\nThe hit area will have its transformation applied relative to this display object's coordinate space (as though\nthe hit test object were a child of this display object and relative to its regX/Y). The hitArea will be tested\nusing only its own `alpha` value regardless of the alpha value on the target display object, or the target's\nancestors (parents).\n\nIf set on a {{#crossLink \"Container\"}}{{/crossLink}}, children of the Container will not receive mouse events.\nThis is similar to setting {{#crossLink \"mouseChildren\"}}{{/crossLink}} to false.\n\nNote that hitArea is NOT currently used by the `hitTest()` method, nor is it supported for {{#crossLink \"Stage\"}}{{/crossLink}}.",
"itemtype": "property",
"name": "hitArea",
"type": "{DisplayObject}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 384,
"description": "A CSS cursor (ex. \"pointer\", \"help\", \"text\", etc) that will be displayed when the user hovers over this display\nobject. You must enable mouseover events using the {{#crossLink \"Stage/enableMouseOver\"}}{{/crossLink}} method to\nuse this property. Setting a non-null cursor on a Container will override the cursor set on its descendants.",
"itemtype": "property",
"name": "cursor",
"type": "{String}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 396,
"itemtype": "property",
"name": "_cacheOffsetX",
"access": "protected",
"tagname": "",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 404,
"itemtype": "property",
"name": "_cacheOffsetY",
"access": "protected",
"tagname": "",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 412,
"itemtype": "property",
"name": "_filterOffsetX",
"access": "protected",
"tagname": "",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 420,
"itemtype": "property",
"name": "_filterOffsetY",
"access": "protected",
"tagname": "",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 428,
"itemtype": "property",
"name": "_cacheScale",
"access": "protected",
"tagname": "",
"type": "{Number}",
"default": "1",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 436,
"itemtype": "property",
"name": "_cacheDataURLID",
"access": "protected",
"tagname": "",
"type": "{Number}",
"default": "0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 444,
"itemtype": "property",
"name": "_cacheDataURL",
"access": "protected",
"tagname": "",
"type": "{String}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 452,
"itemtype": "property",
"name": "_props",
"access": "protected",
"tagname": "",
"type": "{DisplayObject}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 460,
"itemtype": "property",
"name": "_rectangle",
"access": "protected",
"tagname": "",
"type": "{Rectangle}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 468,
"itemtype": "property",
"name": "_bounds",
"access": "protected",
"tagname": "",
"type": "{Rectangle}",
"default": "null",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 482,
"description": "Listing of mouse event names. Used in _hasMouseEventListener.",
"itemtype": "property",
"name": "_MOUSE_EVENTS",
"access": "protected",
"tagname": "",
"static": 1,
"type": "{Array}",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 491,
"description": "Suppresses errors generated when using features like hitTest, mouse events, and {{#crossLink \"getObjectsUnderPoint\"}}{{/crossLink}}\nwith cross domain content.",
"itemtype": "property",
"name": "suppressCrossDomainErrors",
"static": 1,
"type": "{Boolean}",
"default": "false",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 501,
"itemtype": "property",
"name": "_snapToPixelEnabled",
"access": "protected",
"tagname": "",
"static": 1,
"type": "{Boolean}",
"default": "false",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 510,
"itemtype": "property",
"name": "_hitTestCanvas",
"type": "{HTMLCanvasElement | Object}",
"static": 1,
"access": "protected",
"tagname": "",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 516,
"itemtype": "property",
"name": "_hitTestContext",
"type": "{CanvasRenderingContext2D}",
"static": 1,
"access": "protected",
"tagname": "",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 529,
"itemtype": "property",
"name": "_nextCacheID",
"type": "{Number}",
"static": 1,
"access": "protected",
"tagname": "",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 539,
"description": "Dispatched when the user presses their left mouse button over the display object. See the \n{{#crossLink \"MouseEvent\"}}{{/crossLink}} class for a listing of event properties.",
"itemtype": "event",
"name": "mousedown",
"since": "0.6.0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 546,
"description": "Dispatched when the user presses their left mouse button and then releases it while over the display object.\nSee the {{#crossLink \"MouseEvent\"}}{{/crossLink}} class for a listing of event properties.",
"itemtype": "event",
"name": "click",
"since": "0.6.0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 553,
"description": "Dispatched when the user double clicks their left mouse button over this display object.\nSee the {{#crossLink \"MouseEvent\"}}{{/crossLink}} class for a listing of event properties.",
"itemtype": "event",
"name": "dblclick",
"since": "0.6.0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 560,
"description": "Dispatched when the user's mouse enters this display object. This event must be enabled using \n{{#crossLink \"Stage/enableMouseOver\"}}{{/crossLink}}. See also {{#crossLink \"DisplayObject/rollover:event\"}}{{/crossLink}}.\nSee the {{#crossLink \"MouseEvent\"}}{{/crossLink}} class for a listing of event properties.",
"itemtype": "event",
"name": "mouseover",
"since": "0.6.0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 568,
"description": "Dispatched when the user's mouse leaves this display object. This event must be enabled using \n{{#crossLink \"Stage/enableMouseOver\"}}{{/crossLink}}. See also {{#crossLink \"DisplayObject/rollout:event\"}}{{/crossLink}}.\nSee the {{#crossLink \"MouseEvent\"}}{{/crossLink}} class for a listing of event properties.",
"itemtype": "event",
"name": "mouseout",
"since": "0.6.0",
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 576,
"description": "This event is similar to {{#crossLink \"DisplayObject/mouseover:event\"}}{{/crossLink}}, with the following\ndifferences: it does not bubble, and it considers {{#crossLink \"Container\"}}{{/crossLink}} instances as an\naggregate of their content.\n\nFor example, myContainer contains two overlapping children: shapeA and shapeB. The user moves their mouse over\nshapeA and then directly on to shapeB. With a listener for {{#crossLink \"mouseover:event\"}}{{/crossLink}} on\nmyContainer, two events would be received, each targeting a child element:true if the draw was handled (useful for overriding functionality).\n\nNOTE: This method is mainly for internal use, though it may be useful for advanced uses.",
"itemtype": "method",
"name": "draw",
"params": [
{
"name": "ctx",
"description": "The canvas 2D context object to draw into.",
"type": "CanvasRenderingContext2D"
},
{
"name": "ignoreCache",
"description": "Indicates whether the draw operation should ignore any current cache. For example,\nused for drawing the cache (to prevent it from simply drawing an existing cache back into itself).",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 717,
"description": "Applies this display object's transformation, alpha, globalCompositeOperation, clipping path (mask), and shadow\nto the specified context. This is typically called prior to {{#crossLink \"DisplayObject/draw\"}}{{/crossLink}}.",
"itemtype": "method",
"name": "updateContext",
"params": [
{
"name": "ctx",
"description": "The canvas 2D to update.",
"type": "CanvasRenderingContext2D"
}
],
"class": "DisplayObject",
"module": "EaselJS"
},
{
"file": "easeljs/display/DisplayObject.js",
"line": 749,
"description": "Draws the display object into a new canvas, which is then used for subsequent draws. For complex content\nthat does not change frequently (ex. a Container with many children that do not move, or a complex vector Shape),\nthis can provide for much faster rendering because the content does not need to be re-rendered each tick. The\ncached display object can be moved, rotated, faded, etc freely, however if its content changes, you must\nmanually update the cache by calling updateCache() or cache() again. You must specify\nthe cache area via the x, y, w, and h parameters. This defines the rectangle that will be rendered and cached\nusing this display object's coordinates.\n\n| All | \n\t\tAll display objects support setting bounds manually using setBounds(). Likewise, display objects that\n\t\thave been cached using cache() will return the bounds of their cache. Manual and cache bounds will override\n\t\tthe automatic calculations listed below.\n\t |
| Bitmap | \n\t\tReturns the width and height of the sourceRect (if specified) or image, extending from (x=0,y=0).\n\t |
| Sprite | \n\t\tReturns the bounds of the current frame. May have non-zero x/y if a frame registration point was specified\n\t\tin the spritesheet data. See also {{#crossLink \"SpriteSheet/getFrameBounds\"}}{{/crossLink}}\n\t |
| Container | \n\t\tReturns the aggregate (combined) bounds of all children that return a non-null value from getBounds().\n\t |
| Shape | \n\t\tDoes not currently support automatic bounds calculations. Use setBounds() to manually define bounds.\n\t |
| Text | \n\t\tReturns approximate bounds. Horizontal values (x/width) are quite accurate, but vertical values (y/height) are\n\t\tnot, especially when using textBaseline values other than \"top\".\n\t |
| BitmapText | \n\t\tReturns approximate bounds. Values will be more accurate if spritesheet frame registration points are close\n\t\tto (x=0,y=0).\n\t |
DisplayObject.mask to draw the clipping path, for example.\n\nNOTE: This method is mainly for internal use, though it may be useful for advanced uses.",
"itemtype": "method",
"name": "drawAsPath",
"params": [
{
"name": "ctx",
"description": "The canvas 2D context object to draw into.",
"type": "CanvasRenderingContext2D"
}
],
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 464,
"description": "Moves the drawing point to the specified position. A tiny API method \"mt\" also exists.",
"itemtype": "method",
"name": "moveTo",
"params": [
{
"name": "x",
"description": "The x coordinate the drawing point should move to.",
"type": "Number"
},
{
"name": "y",
"description": "The y coordinate the drawing point should move to.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls).",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 476,
"description": "Draws a line from the current drawing point to the specified position, which become the new current drawing\npoint. Note that you *must* call {{#crossLink \"Graphics/moveTo\"}}{{/crossLink}} before the first `lineTo()`.\nA tiny API method \"lt\" also exists.\n\nFor detailed information, read the\n\nwhatwg spec.",
"itemtype": "method",
"name": "lineTo",
"params": [
{
"name": "x",
"description": "The x coordinate the drawing point should draw to.",
"type": "Number"
},
{
"name": "y",
"description": "The y coordinate the drawing point should draw to.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 494,
"description": "Draws an arc with the specified control points and radius. For detailed information, read the\n\nwhatwg spec. A tiny API method \"at\" also exists.",
"itemtype": "method",
"name": "arcTo",
"params": [
{
"name": "x1",
"description": "",
"type": "Number"
},
{
"name": "y1",
"description": "",
"type": "Number"
},
{
"name": "x2",
"description": "",
"type": "Number"
},
{
"name": "y2",
"description": "",
"type": "Number"
},
{
"name": "radius",
"description": "",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 511,
"description": "Draws an arc defined by the radius, startAngle and endAngle arguments, centered at the position (x, y). For\nexample, to draw a full circle with a radius of 20 centered at (100, 100):\n\n arc(100, 100, 20, 0, Math.PI*2);\n\nFor detailed information, read the\nwhatwg spec.\nA tiny API method \"a\" also exists.",
"itemtype": "method",
"name": "arc",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "radius",
"description": "",
"type": "Number"
},
{
"name": "startAngle",
"description": "Measured in radians.",
"type": "Number"
},
{
"name": "endAngle",
"description": "Measured in radians.",
"type": "Number"
},
{
"name": "anticlockwise",
"description": "",
"type": "Boolean"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 534,
"description": "Draws a quadratic curve from the current drawing point to (x, y) using the control point (cpx, cpy). For detailed\ninformation, read the \nwhatwg spec. A tiny API method \"qt\" also exists.",
"itemtype": "method",
"name": "quadraticCurveTo",
"params": [
{
"name": "cpx",
"description": "",
"type": "Number"
},
{
"name": "cpy",
"description": "",
"type": "Number"
},
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 550,
"description": "Draws a bezier curve from the current drawing point to (x, y) using the control points (cp1x, cp1y) and (cp2x,\ncp2y). For detailed information, read the\n\nwhatwg spec. A tiny API method \"bt\" also exists.",
"itemtype": "method",
"name": "bezierCurveTo",
"params": [
{
"name": "cp1x",
"description": "",
"type": "Number"
},
{
"name": "cp1y",
"description": "",
"type": "Number"
},
{
"name": "cp2x",
"description": "",
"type": "Number"
},
{
"name": "cp2y",
"description": "",
"type": "Number"
},
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 569,
"description": "Draws a rectangle at (x, y) with the specified width and height using the current fill and/or stroke.\nFor detailed information, read the\n\nwhatwg spec. A tiny API method \"r\" also exists.",
"itemtype": "method",
"name": "rect",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "w",
"description": "Width of the rectangle",
"type": "Number"
},
{
"name": "h",
"description": "Height of the rectangle",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 586,
"description": "Closes the current path, effectively drawing a line from the current drawing point to the first drawing point specified\nsince the fill or stroke was last set. A tiny API method \"cp\" also exists.",
"itemtype": "method",
"name": "closePath",
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 599,
"description": "Clears all drawing instructions, effectively resetting this Graphics instance. Any line and fill styles will need\nto be redefined to draw shapes following a clear call. A tiny API method \"c\" also exists.",
"itemtype": "method",
"name": "clear",
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 613,
"description": "Begins a fill with the specified color. This ends the current sub-path. A tiny API method \"f\" also exists.",
"itemtype": "method",
"name": "beginFill",
"params": [
{
"name": "color",
"description": "A CSS compatible color value (ex. \"red\", \"#FF0000\", or \"rgba(255,0,0,0.5)\"). Setting to\nnull will result in no fill.",
"type": "String"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 625,
"description": "Begins a linear gradient fill defined by the line (x0, y0) to (x1, y1). This ends the current sub-path. For\nexample, the following code defines a black to white vertical gradient ranging from 20px to 120px, and draws a\nsquare to display it:\n\n myGraphics.beginLinearGradientFill([\"#000\",\"#FFF\"], [0, 1], 0, 20, 0, 120).drawRect(20, 20, 120, 120);\n\nA tiny API method \"lf\" also exists.",
"itemtype": "method",
"name": "beginLinearGradientFill",
"params": [
{
"name": "colors",
"description": "An array of CSS compatible color values. For example, [\"#F00\",\"#00F\"] would define a gradient\ndrawing from red to blue.",
"type": "Array"
},
{
"name": "ratios",
"description": "An array of gradient positions which correspond to the colors. For example, [0.1, 0.9] would draw\nthe first color to 10% then interpolating to the second color at 90%.",
"type": "Array"
},
{
"name": "x0",
"description": "The position of the first point defining the line that defines the gradient direction and size.",
"type": "Number"
},
{
"name": "y0",
"description": "The position of the first point defining the line that defines the gradient direction and size.",
"type": "Number"
},
{
"name": "x1",
"description": "The position of the second point defining the line that defines the gradient direction and size.",
"type": "Number"
},
{
"name": "y1",
"description": "The position of the second point defining the line that defines the gradient direction and size.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 649,
"description": "Begins a radial gradient fill. This ends the current sub-path. For example, the following code defines a red to\nblue radial gradient centered at (100, 100), with a radius of 50, and draws a circle to display it:\n\n myGraphics.beginRadialGradientFill([\"#F00\",\"#00F\"], [0, 1], 100, 100, 0, 100, 100, 50).drawCircle(100, 100, 50);\n\nA tiny API method \"rf\" also exists.",
"itemtype": "method",
"name": "beginRadialGradientFill",
"params": [
{
"name": "colors",
"description": "An array of CSS compatible color values. For example, [\"#F00\",\"#00F\"] would define\na gradient drawing from red to blue.",
"type": "Array"
},
{
"name": "ratios",
"description": "An array of gradient positions which correspond to the colors. For example, [0.1,\n0.9] would draw the first color to 10% then interpolating to the second color at 90%.",
"type": "Array"
},
{
"name": "x0",
"description": "Center position of the inner circle that defines the gradient.",
"type": "Number"
},
{
"name": "y0",
"description": "Center position of the inner circle that defines the gradient.",
"type": "Number"
},
{
"name": "r0",
"description": "Radius of the inner circle that defines the gradient.",
"type": "Number"
},
{
"name": "x1",
"description": "Center position of the outer circle that defines the gradient.",
"type": "Number"
},
{
"name": "y1",
"description": "Center position of the outer circle that defines the gradient.",
"type": "Number"
},
{
"name": "r1",
"description": "Radius of the outer circle that defines the gradient.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 674,
"description": "Begins a pattern fill using the specified image. This ends the current sub-path. A tiny API method \"bf\" also\nexists.",
"itemtype": "method",
"name": "beginBitmapFill",
"params": [
{
"name": "image",
"description": "The Image, Canvas, or Video object to use\nas the pattern. Must be loaded prior to creating a bitmap fill, or the fill will be empty.",
"type": "HTMLImageElement | HTMLCanvasElement | HTMLVideoElement"
},
{
"name": "repetition",
"description": "Optional. Indicates whether to repeat the image in the fill area. One of \"repeat\",\n\"repeat-x\", \"repeat-y\", or \"no-repeat\". Defaults to \"repeat\". Note that Firefox does not support \"repeat-x\" or\n\"repeat-y\" (latest tests were in FF 20.0), and will default to \"repeat\".",
"type": "String"
},
{
"name": "matrix",
"description": "Optional. Specifies a transformation matrix for the bitmap fill. This transformation\nwill be applied relative to the parent transform.",
"type": "Matrix2D"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 692,
"description": "Ends the current sub-path, and begins a new one with no fill. Functionally identical to beginFill(null).\nA tiny API method \"ef\" also exists.",
"itemtype": "method",
"name": "endFill",
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 703,
"description": "Sets the stroke style. Like all drawing methods, this can be chained, so you can define\nthe stroke style and color in a single line of code like so:\n\n\tmyGraphics.setStrokeStyle(8,\"round\").beginStroke(\"#F00\");\n\nA tiny API method \"ss\" also exists.",
"itemtype": "method",
"name": "setStrokeStyle",
"params": [
{
"name": "thickness",
"description": "The width of the stroke.",
"type": "Number"
},
{
"name": "caps",
"description": "Indicates the type of caps to use at the end of lines. One of butt,\nround, or square. Defaults to \"butt\". Also accepts the values 0 (butt), 1 (round), and 2 (square) for use with\nthe tiny API.",
"type": "String | Number",
"optional": true,
"optdefault": "0"
},
{
"name": "joints",
"description": "Specifies the type of joints that should be used where two lines meet.\nOne of bevel, round, or miter. Defaults to \"miter\". Also accepts the values 0 (miter), 1 (round), and 2 (bevel)\nfor use with the tiny API.",
"type": "String | Number",
"optional": true,
"optdefault": "0"
},
{
"name": "miterLimit",
"description": "If joints is set to \"miter\", then you can specify a miter limit ratio which\ncontrols at what point a mitered joint will be clipped.",
"type": "Number",
"optional": true,
"optdefault": "10"
},
{
"name": "ignoreScale",
"description": "If true, the stroke will be drawn at the specified thickness regardless\nof active transformations.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 735,
"description": "Sets or clears the stroke dash pattern.\n\n\tmyGraphics.setStrokeDash([20, 10], 0);\n\nA tiny API method `sd` also exists.",
"itemtype": "method",
"name": "setStrokeDash",
"params": [
{
"name": "segments",
"description": "An array specifying the dash pattern, alternating between line and gap.\nFor example, `[20,10]` would create a pattern of 20 pixel lines with 10 pixel gaps between them.\nPassing null or an empty array will clear the existing stroke dash.",
"type": "Array",
"optional": true
},
{
"name": "offset",
"description": "The offset of the dash pattern. For example, you could increment this value to create a \"marching ants\" effect.",
"type": "Number",
"optional": true,
"optdefault": "0"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 755,
"description": "Begins a stroke with the specified color. This ends the current sub-path. A tiny API method \"s\" also exists.",
"itemtype": "method",
"name": "beginStroke",
"params": [
{
"name": "color",
"description": "A CSS compatible color value (ex. \"#FF0000\", \"red\", or \"rgba(255,0,0,0.5)\"). Setting to\nnull will result in no stroke.",
"type": "String"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 767,
"description": "Begins a linear gradient stroke defined by the line (x0, y0) to (x1, y1). This ends the current sub-path. For\nexample, the following code defines a black to white vertical gradient ranging from 20px to 120px, and draws a\nsquare to display it:\n\n myGraphics.setStrokeStyle(10).\n beginLinearGradientStroke([\"#000\",\"#FFF\"], [0, 1], 0, 20, 0, 120).drawRect(20, 20, 120, 120);\n\nA tiny API method \"ls\" also exists.",
"itemtype": "method",
"name": "beginLinearGradientStroke",
"params": [
{
"name": "colors",
"description": "An array of CSS compatible color values. For example, [\"#F00\",\"#00F\"] would define\na gradient drawing from red to blue.",
"type": "Array"
},
{
"name": "ratios",
"description": "An array of gradient positions which correspond to the colors. For example, [0.1,\n0.9] would draw the first color to 10% then interpolating to the second color at 90%.",
"type": "Array"
},
{
"name": "x0",
"description": "The position of the first point defining the line that defines the gradient direction and size.",
"type": "Number"
},
{
"name": "y0",
"description": "The position of the first point defining the line that defines the gradient direction and size.",
"type": "Number"
},
{
"name": "x1",
"description": "The position of the second point defining the line that defines the gradient direction and size.",
"type": "Number"
},
{
"name": "y1",
"description": "The position of the second point defining the line that defines the gradient direction and size.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 792,
"description": "Begins a radial gradient stroke. This ends the current sub-path. For example, the following code defines a red to\nblue radial gradient centered at (100, 100), with a radius of 50, and draws a rectangle to display it:\n\n myGraphics.setStrokeStyle(10)\n .beginRadialGradientStroke([\"#F00\",\"#00F\"], [0, 1], 100, 100, 0, 100, 100, 50)\n .drawRect(50, 90, 150, 110);\n\nA tiny API method \"rs\" also exists.",
"itemtype": "method",
"name": "beginRadialGradientStroke",
"params": [
{
"name": "colors",
"description": "An array of CSS compatible color values. For example, [\"#F00\",\"#00F\"] would define\na gradient drawing from red to blue.",
"type": "Array"
},
{
"name": "ratios",
"description": "An array of gradient positions which correspond to the colors. For example, [0.1,\n0.9] would draw the first color to 10% then interpolating to the second color at 90%, then draw the second color\nto 100%.",
"type": "Array"
},
{
"name": "x0",
"description": "Center position of the inner circle that defines the gradient.",
"type": "Number"
},
{
"name": "y0",
"description": "Center position of the inner circle that defines the gradient.",
"type": "Number"
},
{
"name": "r0",
"description": "Radius of the inner circle that defines the gradient.",
"type": "Number"
},
{
"name": "x1",
"description": "Center position of the outer circle that defines the gradient.",
"type": "Number"
},
{
"name": "y1",
"description": "Center position of the outer circle that defines the gradient.",
"type": "Number"
},
{
"name": "r1",
"description": "Radius of the outer circle that defines the gradient.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 820,
"description": "Begins a pattern fill using the specified image. This ends the current sub-path. Note that unlike bitmap fills,\nstrokes do not currently support a matrix parameter due to limitations in the canvas API. A tiny API method \"bs\"\nalso exists.",
"itemtype": "method",
"name": "beginBitmapStroke",
"params": [
{
"name": "image",
"description": "The Image, Canvas, or Video object to use\nas the pattern. Must be loaded prior to creating a bitmap fill, or the fill will be empty.",
"type": "HTMLImageElement | HTMLCanvasElement | HTMLVideoElement"
},
{
"name": "repetition",
"description": "Optional. Indicates whether to repeat the image in the fill area. One of\n\"repeat\", \"repeat-x\", \"repeat-y\", or \"no-repeat\". Defaults to \"repeat\".",
"type": "String",
"optional": true,
"optdefault": "repeat"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 837,
"description": "Ends the current sub-path, and begins a new one with no stroke. Functionally identical to beginStroke(null).\nA tiny API method \"es\" also exists.",
"itemtype": "method",
"name": "endStroke",
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 848,
"description": "Maps the familiar ActionScript curveTo() method to the functionally similar {{#crossLink \"Graphics/quadraticCurveTo\"}}{{/crossLink}}\nmethod.",
"itemtype": "method",
"name": "quadraticCurveTo",
"params": [
{
"name": "cpx",
"description": "",
"type": "Number"
},
{
"name": "cpy",
"description": "",
"type": "Number"
},
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 861,
"description": "Maps the familiar ActionScript drawRect() method to the functionally similar {{#crossLink \"Graphics/rect\"}}{{/crossLink}}\n method.",
"itemtype": "method",
"name": "drawRect",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "w",
"description": "Width of the rectangle",
"type": "Number"
},
{
"name": "h",
"description": "Height of the rectangle",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 875,
"description": "Draws a rounded rectangle with all corners with the specified radius.",
"itemtype": "method",
"name": "drawRoundRect",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "w",
"description": "",
"type": "Number"
},
{
"name": "h",
"description": "",
"type": "Number"
},
{
"name": "radius",
"description": "Corner radius.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 890,
"description": "Draws a rounded rectangle with different corner radii. Supports positive and negative corner radii. A tiny API\nmethod \"rc\" also exists.",
"itemtype": "method",
"name": "drawRoundRectComplex",
"params": [
{
"name": "x",
"description": "The horizontal coordinate to draw the round rect.",
"type": "Number"
},
{
"name": "y",
"description": "The vertical coordinate to draw the round rect.",
"type": "Number"
},
{
"name": "w",
"description": "The width of the round rect.",
"type": "Number"
},
{
"name": "h",
"description": "The height of the round rect.",
"type": "Number"
},
{
"name": "radiusTL",
"description": "Top left corner radius.",
"type": "Number"
},
{
"name": "radiusTR",
"description": "Top right corner radius.",
"type": "Number"
},
{
"name": "radiusBR",
"description": "Bottom right corner radius.",
"type": "Number"
},
{
"name": "radiusBL",
"description": "Bottom left corner radius.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 909,
"description": "Draws a circle with the specified radius at (x, y).\n\n var g = new createjs.Graphics();\n\t g.setStrokeStyle(1);\n\t g.beginStroke(createjs.Graphics.getRGB(0,0,0));\n\t g.beginFill(createjs.Graphics.getRGB(255,0,0));\n\t g.drawCircle(0,0,3);\n\n\t var s = new createjs.Shape(g);\n\t\ts.x = 100;\n\t\ts.y = 100;\n\n\t stage.addChild(s);\n\t stage.update();\n\nA tiny API method \"dc\" also exists.",
"itemtype": "method",
"name": "drawCircle",
"params": [
{
"name": "x",
"description": "x coordinate center point of circle.",
"type": "Number"
},
{
"name": "y",
"description": "y coordinate center point of circle.",
"type": "Number"
},
{
"name": "radius",
"description": "Radius of circle.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 937,
"description": "Draws an ellipse (oval) with a specified width (w) and height (h). Similar to {{#crossLink \"Graphics/drawCircle\"}}{{/crossLink}},\nexcept the width and height can be different. A tiny API method \"de\" also exists.",
"itemtype": "method",
"name": "drawEllipse",
"params": [
{
"name": "x",
"description": "The left coordinate point of the ellipse. Note that this is different from {{#crossLink \"Graphics/drawCircle\"}}{{/crossLink}}\nwhich draws from center.",
"type": "Number"
},
{
"name": "y",
"description": "The top coordinate point of the ellipse. Note that this is different from {{#crossLink \"Graphics/drawCircle\"}}{{/crossLink}}\nwhich draws from the center.",
"type": "Number"
},
{
"name": "w",
"description": "The height (horizontal diameter) of the ellipse. The horizontal radius will be half of this\nnumber.",
"type": "Number"
},
{
"name": "h",
"description": "The width (vertical diameter) of the ellipse. The vertical radius will be half of this number.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 955,
"description": "Draws a star if pointSize is greater than 0, or a regular polygon if pointSize is 0 with the specified number of\npoints. For example, the following code will draw a familiar 5 pointed star shape centered at 100, 100 and with a\nradius of 50:\n\n myGraphics.beginFill(\"#FF0\").drawPolyStar(100, 100, 50, 5, 0.6, -90);\n // Note: -90 makes the first point vertical\n\nA tiny API method \"dp\" also exists.",
"itemtype": "method",
"name": "drawPolyStar",
"params": [
{
"name": "x",
"description": "Position of the center of the shape.",
"type": "Number"
},
{
"name": "y",
"description": "Position of the center of the shape.",
"type": "Number"
},
{
"name": "radius",
"description": "The outer radius of the shape.",
"type": "Number"
},
{
"name": "sides",
"description": "The number of points on the star or sides on the polygon.",
"type": "Number"
},
{
"name": "pointSize",
"description": "The depth or \"pointy-ness\" of the star points. A pointSize of 0 will draw a regular\npolygon (no points), a pointSize of 1 will draw nothing because the points are infinitely pointy.",
"type": "Number"
},
{
"name": "angle",
"description": "The angle of the first point / corner. For example a value of 0 will draw the first point\ndirectly to the right of the center.",
"type": "Number"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 982,
"description": "Removed in favour of using custom command objects with {{#crossLink \"Graphics/append\"}}{{/crossLink}}.",
"itemtype": "method",
"name": "inject",
"deprecated": true,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 988,
"description": "Appends a graphics command object to the graphics queue. Command objects expose an \"exec\" method\nthat accepts two parameters: the Context2D to operate on, and an arbitrary data object passed into\n{{#crossLink \"Graphics/draw\"}}{{/crossLink}}. The latter will usually be the Shape instance that called draw.\n\nThis method is used internally by Graphics methods, such as drawCircle, but can also be used directly to insert\nbuilt-in or custom graphics commands. For example:\n\n\t\t// attach data to our shape, so we can access it during the draw:\n\t\tmyShape.color = \"red\";\n\n\t\t// append a Circle command object:\n\t\tmyShape.graphics.append(new Graphics.Circle(50, 50, 30));\n\n\t\t// append a custom command object with an exec method that sets the fill style\n\t\t// based on the shape's data, and then fills the circle.\n\t\tmyShape.graphics.append({exec:function(ctx, shape) {\n\t\t\tctx.fillStyle = shape.color;\n\t\t\tctx.fill();\n\t\t}});",
"itemtype": "method",
"name": "append",
"params": [
{
"name": "command",
"description": "A graphics command object exposing an \"exec\" method.",
"type": "Object"
},
{
"name": "clean",
"description": "The clean param is primarily for internal use. A value of true indicates that a command does not generate a path that should be stroked or filled.",
"type": "Boolean"
}
],
"return": {
"description": "The Graphics instance the method is called on (useful for chaining calls.)",
"type": "Graphics"
},
"chainable": 1,
"class": "Graphics",
"module": "EaselJS"
},
{
"file": "easeljs/display/Graphics.js",
"line": 1022,
"description": "Decodes a compact encoded path string into a series of draw instructions.\nThis format is not intended to be human readable, and is meant for use by authoring tools.\nThe format uses a base64 character set, with each character representing 6 bits, to define a series of draw\ncommands.\n\nEach command is comprised of a single \"header\" character followed by a variable number of alternating x and y\nposition values. Reading the header bits from left to right (most to least significant): bits 1 to 3 specify the\ntype of operation (0-moveTo, 1-lineTo, 2-quadraticCurveTo, 3-bezierCurveTo, 4-closePath, 5-7 unused). Bit 4\nindicates whether position values use 12 bits (2 characters) or 18 bits (3 characters), with a one indicating the\nlatter. Bits 5 and 6 are currently unused.\n\nFollowing the header is a series of 0 (closePath), 2 (moveTo, lineTo), 4 (quadraticCurveTo), or 6 (bezierCurveTo)\nparameters. These parameters are alternating x/y positions represented by 2 or 3 characters (as indicated by the\n4th bit in the command char). These characters consist of a 1 bit sign (1 is negative, 0 is positive), followed\nby an 11 (2 char) or 17 (3 char) bit integer value. All position values are in tenths of a pixel. Except in the\ncase of move operations which are absolute, this value is a delta from the previous x or y position (as\nappropriate).\n\nFor example, the string \"A3cAAMAu4AAA\" represents a line starting at -150,0 and ending at 150,0.\ntweenInstance.to() method. Note that using Tween.set is not recommended to\ncreate MovieClip animations. The following example will toggle the target off on frame 0, and then back on for\nframe 1. You can use the \"visible\" property to achieve the same effect.\n\n var tween = createjs.Tween.get(target).to({_off:false})\n .wait(1).to({_off:true})\n .wait(1).to({_off:false});",
"itemtype": "property",
"name": "timeline",
"type": "Timeline",
"default": "null",
"class": "MovieClip",
"module": "EaselJS"
},
{
"file": "easeljs/display/MovieClip.js",
"line": 157,
"description": "If true, the MovieClip's position will not advance when ticked.",
"itemtype": "property",
"name": "paused",
"type": "Boolean",
"default": "false",
"class": "MovieClip",
"module": "EaselJS"
},
{
"file": "easeljs/display/MovieClip.js",
"line": 165,
"description": "If true, actions in this MovieClip's tweens will be run when the playhead advances.",
"itemtype": "property",
"name": "actionsEnabled",
"type": "Boolean",
"default": "true",
"class": "MovieClip",
"module": "EaselJS"
},
{
"file": "easeljs/display/MovieClip.js",
"line": 173,
"description": "If true, the MovieClip will automatically be reset to its first frame whenever the timeline adds\nit back onto the display list. This only applies to MovieClip instances with mode=INDEPENDENT.\ncurrentFrame.",
"itemtype": "property",
"name": "paused",
"type": "{Boolean}",
"default": "false",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 97,
"description": "The SpriteSheet instance to play back. This includes the source image, frame dimensions, and frame\ndata. See {{#crossLink \"SpriteSheet\"}}{{/crossLink}} for more information.",
"itemtype": "property",
"name": "spriteSheet",
"type": "{SpriteSheet}",
"readonly": "",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 106,
"description": "Specifies the current frame index within the currently playing animation. When playing normally, this will increase\nfrom 0 to n-1, where n is the number of frames in the current animation.\n\nThis could be a non-integer value if\nusing time-based playback (see {{#crossLink \"Sprite/framerate\"}}{{/crossLink}}, or if the animation's speed is\nnot an integer.",
"itemtype": "property",
"name": "currentAnimationFrame",
"type": "{Number}",
"default": "0",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 119,
"description": "By default Sprite instances advance one frame per tick. Specifying a framerate for the Sprite (or its related\nSpriteSheet) will cause it to advance based on elapsed time between ticks as appropriate to maintain the target\nframerate.\n\nFor example, if a Sprite with a framerate of 10 is placed on a Stage being updated at 40fps, then the Sprite will\nadvance roughly one frame every 4 ticks. This will not be exact, because the time between each tick will\nvary slightly between frames.\n\nThis feature is dependent on the tick event object (or an object with an appropriate \"delta\" property) being\npassed into {{#crossLink \"Stage/update\"}}{{/crossLink}}.",
"itemtype": "property",
"name": "framerate",
"type": "{Number}",
"default": "0",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 138,
"description": "Current animation object.",
"itemtype": "property",
"name": "_animation",
"access": "protected",
"tagname": "",
"type": "{Object}",
"default": "null",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 147,
"description": "Current frame index.",
"itemtype": "property",
"name": "_currentFrame",
"access": "protected",
"tagname": "",
"type": "{Number}",
"default": "null",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 156,
"description": "Skips the next auto advance. Used by gotoAndPlay to avoid immediately jumping to the next frame",
"itemtype": "property",
"name": "_skipAdvance",
"access": "protected",
"tagname": "",
"type": "{Boolean}",
"default": "false",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 170,
"description": "Constructor alias for backwards compatibility. This method will be removed in future versions.\nSubclasses should be updated to use {{#crossLink \"Utility Methods/extends\"}}{{/crossLink}}.",
"itemtype": "method",
"name": "initialize",
"deprecated": true,
"deprecationMessage": "in favour of `createjs.promote()`",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 180,
"description": "Dispatched when an animation reaches its ends.",
"itemtype": "event",
"name": "animationend",
"params": [
{
"name": "target",
"description": "The object that dispatched the event.",
"type": "Object"
},
{
"name": "type",
"description": "The event type.",
"type": "String"
},
{
"name": "name",
"description": "The name of the animation that just ended.",
"type": "String"
},
{
"name": "next",
"description": "The name of the next animation that will be played, or null. This will be the same as name if the animation is looping.",
"type": "String"
}
],
"since": "0.6.0",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 190,
"description": "Dispatched any time the current frame changes. For example, this could be due to automatic advancement on a tick,\nor calling gotoAndPlay() or gotoAndStop().",
"itemtype": "event",
"name": "change",
"params": [
{
"name": "target",
"description": "The object that dispatched the event.",
"type": "Object"
},
{
"name": "type",
"description": "The event type.",
"type": "String"
}
],
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 200,
"description": "Returns true or false indicating whether the display object would be visible if drawn to a canvas.\nThis does not account for whether it would be visible within the boundaries of the stage.\nNOTE: This method is mainly for internal use, though it may be useful for advanced uses.",
"itemtype": "method",
"name": "isVisible",
"return": {
"description": "Boolean indicating whether the display object would be visible if drawn to a canvas",
"type": "Boolean"
},
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 212,
"description": "Draws the display object into the specified context ignoring its visible, alpha, shadow, and transform.\nReturns true if the draw was handled (useful for overriding functionality).\nNOTE: This method is mainly for internal use, though it may be useful for advanced uses.",
"itemtype": "method",
"name": "draw",
"params": [
{
"name": "ctx",
"description": "The canvas 2D context object to draw into.",
"type": "CanvasRenderingContext2D"
},
{
"name": "ignoreCache",
"description": "Indicates whether the draw operation should ignore any current cache.\nFor example, used for drawing the cache (to prevent it from simply drawing an existing cache back\ninto itself).",
"type": "Boolean"
}
],
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 235,
"description": "Because the content of a Sprite is already in a raster format, cache is unnecessary for Sprite instances.\nYou should not cache Sprite instances as it can degrade performance.",
"itemtype": "method",
"name": "cache",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 241,
"description": "Because the content of a Sprite is already in a raster format, cache is unnecessary for Sprite instances.\nYou should not cache Sprite instances as it can degrade performance.",
"itemtype": "method",
"name": "updateCache",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 247,
"description": "Because the content of a Sprite is already in a raster format, cache is unnecessary for Sprite instances.\nYou should not cache Sprite instances as it can degrade performance.",
"itemtype": "method",
"name": "uncache",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 253,
"description": "Play (unpause) the current animation. The Sprite will be paused if either {{#crossLink \"Sprite/stop\"}}{{/crossLink}}\nor {{#crossLink \"Sprite/gotoAndStop\"}}{{/crossLink}} is called. Single frame animations will remain\nunchanged.",
"itemtype": "method",
"name": "play",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 263,
"description": "Stop playing a running animation. The Sprite will be playing if {{#crossLink \"Sprite/gotoAndPlay\"}}{{/crossLink}}\nis called. Note that calling {{#crossLink \"Sprite/gotoAndPlay\"}}{{/crossLink}} or {{#crossLink \"Sprite/play\"}}{{/crossLink}}\nwill resume playback.",
"itemtype": "method",
"name": "stop",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 273,
"description": "Sets paused to false and plays the specified animation name, named frame, or frame number.",
"itemtype": "method",
"name": "gotoAndPlay",
"params": [
{
"name": "frameOrAnimation",
"description": "The frame number or animation name that the playhead should move to\nand begin playing.",
"type": "String|Number"
}
],
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 285,
"description": "Sets paused to true and seeks to the specified animation name, named frame, or frame number.",
"itemtype": "method",
"name": "gotoAndStop",
"params": [
{
"name": "frameOrAnimation",
"description": "The frame number or animation name that the playhead should move to\nand stop.",
"type": "String|Number"
}
],
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 296,
"description": "Advances the playhead. This occurs automatically each tick by default.",
"params": [
{
"name": "time",
"description": "The amount of time in ms to advance by. Only applicable if framerate is set on the Sprite\nor its SpriteSheet.",
"type": "Number",
"optional": true
}
],
"itemtype": "method",
"name": "advance",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 308,
"description": "Returns a {{#crossLink \"Rectangle\"}}{{/crossLink}} instance defining the bounds of the current frame relative to\nthe origin. For example, a 90 x 70 frame with regX=50 and regY=40 would return a\nrectangle with [x=-50, y=-40, width=90, height=70]. This ignores transformations on the display object.\n\nAlso see the SpriteSheet {{#crossLink \"SpriteSheet/getFrameBounds\"}}{{/crossLink}} method.",
"itemtype": "method",
"name": "getBounds",
"return": {
"description": "A Rectangle instance. Returns null if the frame does not exist, or the image is not fully\nloaded.",
"type": "Rectangle"
},
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 323,
"description": "Returns a clone of the Sprite instance. Note that the same SpriteSheet is shared between cloned\ninstances.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "a clone of the Sprite instance.",
"type": "Sprite"
},
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 333,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 343,
"itemtype": "method",
"name": "_cloneProps",
"params": [
{
"name": "o",
"description": "",
"type": "Sprite"
}
],
"return": {
"description": "o",
"type": "Sprite"
},
"access": "protected",
"tagname": "",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 363,
"description": "Advances the currentFrame if paused is not true. This is called automatically when the {{#crossLink \"Stage\"}}{{/crossLink}}\nticks.",
"params": [
{
"name": "evtObj",
"description": "An event object that will be dispatched to all tick listeners. This object is reused between dispatchers to reduce construction & GC costs.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"itemtype": "method",
"name": "_tick",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 379,
"description": "Normalizes the current frame, advancing animations and dispatching callbacks as appropriate.",
"access": "protected",
"tagname": "",
"itemtype": "method",
"name": "_normalizeFrame",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 430,
"description": "Dispatches the \"animationend\" event. Returns true if a handler changed the animation (ex. calling {{#crossLink \"Sprite/stop\"}}{{/crossLink}},\n{{#crossLink \"Sprite/gotoAndPlay\"}}{{/crossLink}}, etc.)",
"itemtype": "property",
"name": "_dispatchAnimationEnd",
"access": "private",
"tagname": "",
"type": "{Function}",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/Sprite.js",
"line": 452,
"description": "Moves the playhead to the specified frame number or animation.",
"itemtype": "method",
"name": "_goto",
"params": [
{
"name": "frameOrAnimation",
"description": "The frame number or animation that the playhead should move to.",
"type": "String|Number"
},
{
"name": "frame",
"description": "The frame of the animation to go to. Defaults to 0.",
"type": "Boolean",
"optional": true
}
],
"access": "protected",
"tagname": "",
"class": "Sprite",
"module": "EaselJS"
},
{
"file": "easeljs/display/SpriteContainer.js",
"line": 69,
"description": "The SpriteSheet that this container enforces use of.",
"itemtype": "property",
"name": "spriteSheet",
"type": "{SpriteSheet}",
"readonly": "",
"class": "SpriteContainer",
"module": "EaselJS"
},
{
"file": "easeljs/display/SpriteContainer.js",
"line": 79,
"description": "REMOVED. Removed in favor of using `MySuperClass_constructor`.\nSee {{#crossLink \"Utility Methods/extend\"}}{{/crossLink}} and {{#crossLink \"Utility Methods/promote\"}}{{/crossLink}}\nfor details.\n\nThere is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.",
"itemtype": "method",
"name": "initialize",
"access": "protected",
"tagname": "",
"deprecated": true,
"class": "SpriteContainer",
"module": "EaselJS"
},
{
"file": "easeljs/display/SpriteContainer.js",
"line": 94,
"description": "Adds a child to the top of the display list.\nOnly children of type SpriteContainer, Sprite, Bitmap, BitmapText, or DOMElement are allowed.\nThe child must have the same spritesheet as this container (unless it's a DOMElement).\nIf a spritesheet hasn't been defined, this container uses this child's spritesheet.\n\nfalse\nto manually control clearing (for generative art, or when pointing multiple stages at the same canvas for\nexample).\n\ndelta and paused parameters.",
"itemtype": "property",
"name": "handleEvent",
"type": "Function",
"class": "Stage",
"module": "EaselJS"
},
{
"file": "easeljs/display/Stage.js",
"line": 452,
"description": "Clears the target canvas. Useful if {{#crossLink \"Stage/autoClear:property\"}}{{/crossLink}} is set to `false`.",
"itemtype": "method",
"name": "clear",
"class": "Stage",
"module": "EaselJS"
},
{
"file": "easeljs/display/Stage.js",
"line": 463,
"description": "Returns a data url that contains a Base64-encoded image of the contents of the stage. The returned data url can\nbe specified as the src value of an image element.",
"itemtype": "method",
"name": "toDataURL",
"params": [
{
"name": "backgroundColor",
"description": "The background color to be used for the generated image. Any valid CSS color\nvalue is allowed. The default value is a transparent background.",
"type": "String",
"optional": true
},
{
"name": "mimeType",
"description": "The MIME type of the image format to be create. The default is \"image/png\". If an unknown MIME type\nis passed in, or if the browser does not support the specified MIME type, the default value will be used.",
"type": "String",
"optional": true,
"optdefault": "\"image/png\""
}
],
"return": {
"description": "a Base64 encoded image.",
"type": "String"
},
"class": "Stage",
"module": "EaselJS"
},
{
"file": "easeljs/display/Stage.js",
"line": 495,
"description": "Enables or disables (by passing a frequency of 0) mouse over ({{#crossLink \"DisplayObject/mouseover:event\"}}{{/crossLink}}\nand {{#crossLink \"DisplayObject/mouseout:event\"}}{{/crossLink}}) and roll over events ({{#crossLink \"DisplayObject/rollover:event\"}}{{/crossLink}}\nand {{#crossLink \"DisplayObject/rollout:event\"}}{{/crossLink}}) for this stage's display list. These events can\nbe expensive to generate, so they are disabled by default. The frequency of the events can be controlled\nindependently of mouse move events via the optional `frequency` parameter.\n\nlineHeight (if specified) or {{#crossLink \"Text/getMeasuredLineHeight\"}}{{/crossLink}}. Note that\nthis operation requires the text flowing logic to run, which has an associated CPU cost.",
"itemtype": "method",
"name": "getMeasuredHeight",
"return": {
"description": "The approximate height of the untransformed multi-line text.",
"type": "Number"
},
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 250,
"description": "Docced in superclass.",
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 265,
"description": "Returns an object with width, height, and lines properties. The width and height are the visual width and height\nof the drawn text. The lines property contains an array of strings, one for\neach line of text that will be drawn, accounting for line breaks and wrapping. These strings have trailing\nwhitespace removed.",
"itemtype": "method",
"name": "getMetrics",
"return": {
"description": "An object with width, height, and lines properties.",
"type": "Object"
},
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 280,
"description": "Returns a clone of the Text instance.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "a clone of the Text instance.",
"type": "Text"
},
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 289,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 300,
"itemtype": "method",
"name": "_cloneProps",
"params": [
{
"name": "o",
"description": "",
"type": "Text"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "o",
"type": "Text"
},
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 317,
"itemtype": "method",
"name": "_getWorkingContext",
"params": [
{
"name": "ctx",
"description": "",
"type": "CanvasRenderingContext2D"
}
],
"return": {
"description": "",
"type": "CanvasRenderingContext2D"
},
"access": "protected",
"tagname": "",
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 330,
"description": "Draws multiline text.",
"itemtype": "method",
"name": "_drawText",
"params": [
{
"name": "ctx",
"description": "",
"type": "CanvasRenderingContext2D"
},
{
"name": "o",
"description": "",
"type": "Object"
},
{
"name": "lines",
"description": "",
"type": "Array"
}
],
"return": {
"description": "",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 392,
"itemtype": "method",
"name": "_drawTextLine",
"params": [
{
"name": "ctx",
"description": "",
"type": "CanvasRenderingContext2D"
},
{
"name": "text",
"description": "",
"type": "String"
},
{
"name": "y",
"description": "",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/display/Text.js",
"line": 406,
"itemtype": "method",
"name": "_getMeasuredWidth",
"params": [
{
"name": "text",
"description": "",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "Text",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 64,
"description": "The normalized x position on the stage. This will always be within the range 0 to stage width.",
"itemtype": "property",
"name": "stageX",
"type": "Number",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 71,
"description": "The normalized y position on the stage. This will always be within the range 0 to stage height.",
"itemtype": "property",
"name": "stageY",
"type": "Number",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 78,
"description": "The raw x position relative to the stage. Normally this will be the same as the stageX value, unless\nstage.mouseMoveOutside is true and the pointer is outside of the stage bounds.",
"itemtype": "property",
"name": "rawX",
"type": "Number",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 86,
"description": "The raw y position relative to the stage. Normally this will be the same as the stageY value, unless\nstage.mouseMoveOutside is true and the pointer is outside of the stage bounds.",
"itemtype": "property",
"name": "rawY",
"type": "Number",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 94,
"description": "The native MouseEvent generated by the browser. The properties and API for this\nevent may differ between browsers. This property will be null if the\nEaselJS property was not directly generated from a native MouseEvent.",
"itemtype": "property",
"name": "nativeEvent",
"type": "HtmlMouseEvent",
"default": "null",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 104,
"description": "The unique id for the pointer (touch point or cursor). This will be either -1 for the mouse, or the system\nsupplied id value.",
"itemtype": "property",
"name": "pointerID",
"type": "{Number}",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 112,
"description": "Indicates whether this is the primary pointer in a multitouch environment. This will always be true for the mouse.\nFor touch pointers, the first pointer in the current stack will be considered the primary pointer.",
"itemtype": "property",
"name": "primary",
"type": "{Boolean}",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 120,
"description": "The secondary target for the event, if applicable. This is used for mouseout/rollout\nevents to indicate the object that the mouse entered from, mouseover/rollover for the object the mouse exited,\nand stagemousedown/stagemouseup events for the object that was the under the cursor, if any.\n\nOnly valid interaction targets will be returned (ie. objects with mouse listeners or a cursor set).",
"itemtype": "property",
"name": "relatedTarget",
"type": "{DisplayObject}",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 138,
"description": "Returns the x position of the mouse in the local coordinate system of the current target (ie. the dispatcher).",
"itemtype": "property",
"name": "localX",
"type": "{Number}",
"readonly": "",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 148,
"description": "Returns the y position of the mouse in the local coordinate system of the current target (ie. the dispatcher).",
"itemtype": "property",
"name": "localY",
"type": "{Number}",
"readonly": "",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 158,
"description": "Indicates whether the event was generated by a touch input (versus a mouse input).",
"itemtype": "property",
"name": "isTouch",
"type": "{Boolean}",
"readonly": "",
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 179,
"description": "Returns a clone of the MouseEvent instance.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "a clone of the MouseEvent instance.",
"type": "MouseEvent"
},
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/events/MouseEvent.js",
"line": 188,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "MouseEvent",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMapFilter.js",
"line": 74,
"description": "The greyscale image (or canvas) to use as the alpha value for the result. This should be exactly the same\ndimensions as the target.",
"itemtype": "property",
"name": "alphaMap",
"type": "HTMLImageElement|HTMLCanvasElement",
"class": "AlphaMapFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMapFilter.js",
"line": 84,
"itemtype": "property",
"name": "_alphaMap",
"access": "protected",
"tagname": "",
"type": "HTMLImageElement|HTMLCanvasElement",
"class": "AlphaMapFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMapFilter.js",
"line": 91,
"itemtype": "property",
"name": "_mapData",
"access": "protected",
"tagname": "",
"type": "Uint8ClampedArray",
"class": "AlphaMapFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMapFilter.js",
"line": 105,
"class": "AlphaMapFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMapFilter.js",
"line": 113,
"class": "AlphaMapFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMapFilter.js",
"line": 120,
"class": "AlphaMapFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMapFilter.js",
"line": 133,
"itemtype": "method",
"name": "_prepAlphaMap",
"access": "protected",
"tagname": "",
"class": "AlphaMapFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMaskFilter.js",
"line": 73,
"description": "The image (or canvas) to use as the mask.",
"itemtype": "property",
"name": "mask",
"type": "HTMLImageElement|HTMLCanvasElement",
"class": "AlphaMaskFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMaskFilter.js",
"line": 87,
"description": "Applies the filter to the specified context.\n\nIMPORTANT NOTE: This filter currently does not support the targetCtx, or targetX/Y parameters\ncorrectly.",
"itemtype": "method",
"name": "applyFilter",
"params": [
{
"name": "ctx",
"description": "The 2D context to use as the source.",
"type": "CanvasRenderingContext2D"
},
{
"name": "x",
"description": "The x position to use for the source rect.",
"type": "Number"
},
{
"name": "y",
"description": "The y position to use for the source rect.",
"type": "Number"
},
{
"name": "width",
"description": "The width to use for the source rect.",
"type": "Number"
},
{
"name": "height",
"description": "The height to use for the source rect.",
"type": "Number"
},
{
"name": "targetCtx",
"description": "NOT SUPPORTED IN THIS FILTER. The 2D context to draw the result to. Defaults to the context passed to ctx.",
"type": "CanvasRenderingContext2D",
"optional": true
},
{
"name": "targetX",
"description": "NOT SUPPORTED IN THIS FILTER. The x position to draw the result to. Defaults to the value passed to x.",
"type": "Number",
"optional": true
},
{
"name": "targetY",
"description": "NOT SUPPORTED IN THIS FILTER. The y position to draw the result to. Defaults to the value passed to y.",
"type": "Number",
"optional": true
}
],
"return": {
"description": "If the filter was applied successfully.",
"type": "Boolean"
},
"class": "AlphaMaskFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMaskFilter.js",
"line": 122,
"class": "AlphaMaskFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/AlphaMaskFilter.js",
"line": 127,
"class": "AlphaMaskFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 75,
"description": "Horizontal blur radius in pixels",
"itemtype": "property",
"name": "blurX",
"default": "0",
"type": "Number",
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 83,
"description": "Vertical blur radius in pixels",
"itemtype": "property",
"name": "blurY",
"default": "0",
"type": "Number",
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 91,
"description": "Number of blur iterations. For example, a value of 1 will produce a rough blur. A value of 2 will produce a\nsmoother blur, but take twice as long to run.",
"itemtype": "property",
"name": "quality",
"default": "1",
"type": "Number",
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 107,
"description": "Array of multiply values for blur calculations.",
"itemtype": "property",
"name": "MUL_TABLE",
"type": "Array",
"access": "protected",
"tagname": "",
"static": 1,
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 116,
"description": "Array of shift values for blur calculations.",
"itemtype": "property",
"name": "SHG_TABLE",
"type": "Array",
"access": "protected",
"tagname": "",
"static": 1,
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 126,
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 134,
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 139,
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/BlurFilter.js",
"line": 147,
"class": "BlurFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 77,
"description": "Red channel multiplier.",
"itemtype": "property",
"name": "redMultiplier",
"type": "Number",
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 84,
"description": "Green channel multiplier.",
"itemtype": "property",
"name": "greenMultiplier",
"type": "Number",
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 91,
"description": "Blue channel multiplier.",
"itemtype": "property",
"name": "blueMultiplier",
"type": "Number",
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 98,
"description": "Alpha channel multiplier.",
"itemtype": "property",
"name": "alphaMultiplier",
"type": "Number",
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 105,
"description": "Red channel offset (added to value).",
"itemtype": "property",
"name": "redOffset",
"type": "Number",
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 112,
"description": "Green channel offset (added to value).",
"itemtype": "property",
"name": "greenOffset",
"type": "Number",
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 119,
"description": "Blue channel offset (added to value).",
"itemtype": "property",
"name": "blueOffset",
"type": "Number",
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 126,
"description": "Alpha channel offset (added to value).",
"itemtype": "property",
"name": "alphaOffset",
"type": "Number",
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 140,
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 145,
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorFilter.js",
"line": 152,
"class": "ColorFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 63,
"description": "REMOVED. Removed in favor of using `MySuperClass_constructor`.\nSee {{#crossLink \"Utility Methods/extend\"}}{{/crossLink}} and {{#crossLink \"Utility Methods/promote\"}}{{/crossLink}}\nfor details.\n\nThere is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.",
"itemtype": "method",
"name": "initialize",
"access": "protected",
"tagname": "",
"deprecated": true,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 78,
"description": "Array of delta values for contrast calculations.",
"itemtype": "property",
"name": "DELTA_INDEX",
"type": "Array",
"access": "protected",
"tagname": "",
"static": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 99,
"description": "Identity matrix values.",
"itemtype": "property",
"name": "IDENTITY_MATRIX",
"type": "Array",
"access": "protected",
"tagname": "",
"static": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 114,
"description": "The constant length of a color matrix.",
"itemtype": "property",
"name": "LENGTH",
"type": "Number",
"access": "protected",
"tagname": "",
"static": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 125,
"description": "Resets the instance with the specified values.",
"itemtype": "method",
"name": "setColor",
"params": [
{
"name": "brightness",
"description": "",
"type": "Number"
},
{
"name": "contrast",
"description": "",
"type": "Number"
},
{
"name": "saturation",
"description": "",
"type": "Number"
},
{
"name": "hue",
"description": "",
"type": "Number"
}
],
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 139,
"description": "Resets the matrix to identity values.",
"itemtype": "method",
"name": "reset",
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 149,
"description": "Shortcut method to adjust brightness, contrast, saturation and hue.\nEquivalent to calling adjustHue(hue), adjustContrast(contrast),\nadjustBrightness(brightness), adjustSaturation(saturation), in that order.",
"itemtype": "method",
"name": "adjustColor",
"params": [
{
"name": "brightness",
"description": "",
"type": "Number"
},
{
"name": "contrast",
"description": "",
"type": "Number"
},
{
"name": "saturation",
"description": "",
"type": "Number"
},
{
"name": "hue",
"description": "",
"type": "Number"
}
],
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 168,
"description": "Adjusts the brightness of pixel color by adding the specified value to the red, green and blue channels.\nPositive values will make the image brighter, negative values will make it darker.",
"itemtype": "method",
"name": "adjustBrightness",
"params": [
{
"name": "value",
"description": "A value between -255 & 255 that will be added to the RGB channels.",
"type": "Number"
}
],
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 189,
"description": "Adjusts the contrast of pixel color.\nPositive values will increase contrast, negative values will decrease contrast.",
"itemtype": "method",
"name": "adjustContrast",
"params": [
{
"name": "value",
"description": "A value between -100 & 100.",
"type": "Number"
}
],
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 222,
"description": "Adjusts the color saturation of the pixel.\nPositive values will increase saturation, negative values will decrease saturation (trend towards greyscale).",
"itemtype": "method",
"name": "adjustSaturation",
"params": [
{
"name": "value",
"description": "A value between -100 & 100.",
"type": "Number"
}
],
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 248,
"description": "Adjusts the hue of the pixel color.",
"itemtype": "method",
"name": "adjustHue",
"params": [
{
"name": "value",
"description": "A value between -180 & 180.",
"type": "Number"
}
],
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 273,
"description": "Concatenates (multiplies) the specified matrix with this one.",
"itemtype": "method",
"name": "concat",
"params": [
{
"name": "matrix",
"description": "An array or ColorMatrix instance.",
"type": "Array"
}
],
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 287,
"description": "Returns a clone of this ColorMatrix.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "A clone of this ColorMatrix.",
"type": "ColorMatrix"
},
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 296,
"description": "Return a length 25 (5x5) array instance containing this matrix's values.",
"itemtype": "method",
"name": "toArray",
"return": {
"description": "An array holding this matrix's values.",
"type": "Array"
},
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 309,
"description": "Copy the specified matrix's values to this matrix.",
"itemtype": "method",
"name": "copy",
"params": [
{
"name": "matrix",
"description": "An array or ColorMatrix instance.",
"type": "Array"
}
],
"return": {
"description": "The ColorMatrix instance the method is called on (useful for chaining calls.)",
"type": "ColorMatrix"
},
"chainable": 1,
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 324,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 335,
"itemtype": "method",
"name": "_multiplyMatrix",
"params": [
{
"name": "matrix",
"description": "",
"type": "Array"
}
],
"access": "protected",
"tagname": "",
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 357,
"description": "Make sure values are within the specified range, hue has a limit of 180, brightness is 255, others are 100.",
"itemtype": "method",
"name": "_cleanValue",
"params": [
{
"name": "value",
"description": "The raw number",
"type": "Number"
},
{
"name": "limit",
"description": "The maximum that the number can be. The minimum is the limit * -1.",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrix.js",
"line": 368,
"description": "Makes sure matrixes are 5x5 (25 long).",
"itemtype": "method",
"name": "_fixMatrix",
"params": [
{
"name": "matrix",
"description": "",
"type": "Array"
}
],
"access": "protected",
"tagname": "",
"class": "ColorMatrix",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrixFilter.js",
"line": 70,
"description": "A 4x5 matrix describing the color operation to perform. See also the {{#crossLink \"ColorMatrix\"}}{{/crossLink}}",
"itemtype": "property",
"name": "matrix",
"type": "Array | ColorMatrix",
"class": "ColorMatrixFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrixFilter.js",
"line": 84,
"class": "ColorMatrixFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrixFilter.js",
"line": 89,
"class": "ColorMatrixFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/ColorMatrixFilter.js",
"line": 95,
"class": "ColorMatrixFilter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/Filter.js",
"line": 74,
"description": "REMOVED. Removed in favor of using `MySuperClass_constructor`.\nSee {{#crossLink \"Utility Methods/extend\"}}{{/crossLink}} and {{#crossLink \"Utility Methods/promote\"}}{{/crossLink}}\nfor details.\n\nThere is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.",
"itemtype": "method",
"name": "initialize",
"access": "protected",
"tagname": "",
"deprecated": true,
"class": "Filter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/Filter.js",
"line": 89,
"description": "Provides padding values for this filter. That is, how much the filter will extend the visual bounds of an object it is applied to.",
"itemtype": "method",
"name": "getBounds",
"params": [
{
"name": "rect",
"description": "If specified, the provided Rectangle instance will be expanded by the padding amounts and returned.",
"type": "Rectangle",
"optional": true
}
],
"return": {
"description": "If a `rect` param was provided, it is returned. If not, either a new rectangle with the padding values, or null if no padding is required for this filter.",
"type": "Rectangle"
},
"class": "Filter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/Filter.js",
"line": 99,
"description": "Applies the filter to the specified context.",
"itemtype": "method",
"name": "applyFilter",
"params": [
{
"name": "ctx",
"description": "The 2D context to use as the source.",
"type": "CanvasRenderingContext2D"
},
{
"name": "x",
"description": "The x position to use for the source rect.",
"type": "Number"
},
{
"name": "y",
"description": "The y position to use for the source rect.",
"type": "Number"
},
{
"name": "width",
"description": "The width to use for the source rect.",
"type": "Number"
},
{
"name": "height",
"description": "The height to use for the source rect.",
"type": "Number"
},
{
"name": "targetCtx",
"description": "The 2D context to draw the result to. Defaults to the context passed to ctx.",
"type": "CanvasRenderingContext2D",
"optional": true
},
{
"name": "targetX",
"description": "The x position to draw the result to. Defaults to the value passed to x.",
"type": "Number",
"optional": true
},
{
"name": "targetY",
"description": "The y position to draw the result to. Defaults to the value passed to y.",
"type": "Number",
"optional": true
}
],
"return": {
"description": "If the filter was applied successfully.",
"type": "Boolean"
},
"class": "Filter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/Filter.js",
"line": 129,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "Filter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/Filter.js",
"line": 138,
"description": "Returns a clone of this Filter instance.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "A clone of the current Filter instance.",
"type": "Filter"
},
"class": "Filter",
"module": "EaselJS"
},
{
"file": "easeljs/filters/Filter.js",
"line": 148,
"itemtype": "method",
"name": "_applyFilter",
"params": [
{
"name": "imageData",
"description": "Target ImageData instance.",
"type": "ImageData"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "Filter",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 54,
"description": "Property representing the alpha that will be applied to a display object.",
"itemtype": "property",
"name": "alpha",
"type": "Number",
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 60,
"description": "Property representing the shadow that will be applied to a display object.",
"itemtype": "property",
"name": "shadow",
"type": "Shadow",
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 66,
"description": "Property representing the compositeOperation that will be applied to a display object.\nYou can find a list of valid composite operations at:\nhttps://developer.mozilla.org/en/Canvas_tutorial/Compositing",
"itemtype": "property",
"name": "compositeOperation",
"type": "String",
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 74,
"description": "Property representing the value for visible that will be applied to a display object.",
"itemtype": "property",
"name": "visible",
"type": "Boolean",
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 80,
"description": "The transformation matrix that will be applied to a display object.",
"itemtype": "property",
"name": "matrix",
"type": "Matrix2D",
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 89,
"description": "Reinitializes the instance with the specified values.",
"itemtype": "method",
"name": "setValues",
"params": [
{
"name": "visible",
"description": "Visible value.",
"type": "Number",
"optional": true,
"optdefault": "true"
},
{
"name": "alpha",
"description": "Alpha value.",
"type": "Number",
"optional": true,
"optdefault": "1"
},
{
"name": "shadow",
"description": "A Shadow instance or null.",
"type": "Number",
"optional": true,
"optdefault": "null"
},
{
"name": "compositeOperation",
"description": "A compositeOperation value or null.",
"type": "Number",
"optional": true,
"optdefault": "null"
},
{
"name": "matrix",
"description": "A transformation matrix. Defaults to an identity matrix.",
"type": "Number",
"optional": true
}
],
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "DisplayProps"
},
"chainable": 1,
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 110,
"description": "Appends the specified display properties. This is generally used to apply a child's properties its parent's.",
"itemtype": "method",
"name": "append",
"params": [
{
"name": "visible",
"description": "desired visible value",
"type": "Boolean"
},
{
"name": "alpha",
"description": "desired alpha value",
"type": "Number"
},
{
"name": "shadow",
"description": "desired shadow value",
"type": "Shadow"
},
{
"name": "compositeOperation",
"description": "desired composite operation value",
"type": "String"
},
{
"name": "matrix",
"description": "a Matrix2D instance",
"type": "Matrix2D",
"optional": true
}
],
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "DisplayProps"
},
"chainable": 1,
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 130,
"description": "Prepends the specified display properties. This is generally used to apply a parent's properties to a child's.\nFor example, to get the combined display properties that would be applied to a child, you could use:\n\n\tvar o = myDisplayObject;\n\tvar props = new createjs.DisplayProps();\n\tdo {\n\t\t// prepend each parent's props in turn:\n\t\tprops.prepend(o.visible, o.alpha, o.shadow, o.compositeOperation, o.getMatrix());\n\t} while (o = o.parent);",
"itemtype": "method",
"name": "prepend",
"params": [
{
"name": "visible",
"description": "desired visible value",
"type": "Boolean"
},
{
"name": "alpha",
"description": "desired alpha value",
"type": "Number"
},
{
"name": "shadow",
"description": "desired shadow value",
"type": "Shadow"
},
{
"name": "compositeOperation",
"description": "desired composite operation value",
"type": "String"
},
{
"name": "matrix",
"description": "a Matrix2D instance",
"type": "Matrix2D",
"optional": true
}
],
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "DisplayProps"
},
"chainable": 1,
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 159,
"description": "Resets this instance and its matrix to default values.",
"itemtype": "method",
"name": "identity",
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "DisplayProps"
},
"chainable": 1,
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/DisplayProps.js",
"line": 173,
"description": "Returns a clone of the DisplayProps instance. Clones the associated matrix.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "a clone of the DisplayProps instance.",
"type": "DisplayProps"
},
"class": "DisplayProps",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 66,
"description": "Position (0, 0) in a 3x3 affine transformation matrix.",
"itemtype": "property",
"name": "a",
"type": "Number",
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 72,
"description": "Position (0, 1) in a 3x3 affine transformation matrix.",
"itemtype": "property",
"name": "b",
"type": "Number",
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 78,
"description": "Position (1, 0) in a 3x3 affine transformation matrix.",
"itemtype": "property",
"name": "c",
"type": "Number",
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 84,
"description": "Position (1, 1) in a 3x3 affine transformation matrix.",
"itemtype": "property",
"name": "d",
"type": "Number",
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 90,
"description": "Position (2, 0) in a 3x3 affine transformation matrix.",
"itemtype": "property",
"name": "tx",
"type": "Number",
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 96,
"description": "Position (2, 1) in a 3x3 affine transformation matrix.",
"itemtype": "property",
"name": "ty",
"type": "Number",
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 104,
"description": "REMOVED. Removed in favor of using `MySuperClass_constructor`.\nSee {{#crossLink \"Utility Methods/extend\"}}{{/crossLink}} and {{#crossLink \"Utility Methods/promote\"}}{{/crossLink}}\nfor details.\n\nThere is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.",
"itemtype": "method",
"name": "initialize",
"access": "protected",
"tagname": "",
"deprecated": true,
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 119,
"description": "Multiplier for converting degrees to radians. Used internally by Matrix2D.",
"itemtype": "property",
"name": "DEG_TO_RAD",
"static": 1,
"final": 1,
"type": "Number",
"readonly": "",
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 131,
"description": "An identity matrix, representing a null transformation.",
"itemtype": "property",
"name": "identity",
"static": 1,
"type": "Matrix2D",
"readonly": "",
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 142,
"description": "Sets the specified values on this instance.",
"itemtype": "method",
"name": "setValues",
"params": [
{
"name": "a",
"description": "Specifies the a property for the new matrix.",
"type": "Number",
"optional": true,
"optdefault": "1"
},
{
"name": "b",
"description": "Specifies the b property for the new matrix.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "c",
"description": "Specifies the c property for the new matrix.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "d",
"description": "Specifies the d property for the new matrix.",
"type": "Number",
"optional": true,
"optdefault": "1"
},
{
"name": "tx",
"description": "Specifies the tx property for the new matrix.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "ty",
"description": "Specifies the ty property for the new matrix.",
"type": "Number",
"optional": true,
"optdefault": "0"
}
],
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 164,
"description": "Appends the specified matrix properties to this matrix. All parameters are required.\nThis is the equivalent of multiplying `(this matrix) * (specified matrix)`.",
"itemtype": "method",
"name": "append",
"params": [
{
"name": "a",
"description": "",
"type": "Number"
},
{
"name": "b",
"description": "",
"type": "Number"
},
{
"name": "c",
"description": "",
"type": "Number"
},
{
"name": "d",
"description": "",
"type": "Number"
},
{
"name": "tx",
"description": "",
"type": "Number"
},
{
"name": "ty",
"description": "",
"type": "Number"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 192,
"description": "Prepends the specified matrix properties to this matrix.\nThis is the equivalent of multiplying `(specified matrix) * (this matrix)`.\nAll parameters are required.",
"itemtype": "method",
"name": "prepend",
"params": [
{
"name": "a",
"description": "",
"type": "Number"
},
{
"name": "b",
"description": "",
"type": "Number"
},
{
"name": "c",
"description": "",
"type": "Number"
},
{
"name": "d",
"description": "",
"type": "Number"
},
{
"name": "tx",
"description": "",
"type": "Number"
},
{
"name": "ty",
"description": "",
"type": "Number"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 219,
"description": "Appends the specified matrix to this matrix.\nThis is the equivalent of multiplying `(this matrix) * (specified matrix)`.",
"itemtype": "method",
"name": "appendMatrix",
"params": [
{
"name": "matrix",
"description": "",
"type": "Matrix2D"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 230,
"description": "Prepends the specified matrix to this matrix.\nThis is the equivalent of multiplying `(specified matrix) * (this matrix)`.\nFor example, you could calculate the combined transformation for a child object using:\n\n\tvar o = myDisplayObject;\n\tvar mtx = o.getMatrix();\n\twhile (o = o.parent) {\n\t\t// prepend each parent's transformation in turn:\n\t\to.prependMatrix(o.getMatrix());\n\t}",
"itemtype": "method",
"name": "prependMatrix",
"params": [
{
"name": "matrix",
"description": "",
"type": "Matrix2D"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 249,
"description": "Generates matrix properties from the specified display object transform properties, and appends them to this matrix.\nFor example, you can use this to generate a matrix representing the transformations of a display object:\n\n\tvar mtx = new Matrix2D();\n\tmtx.appendTransform(o.x, o.y, o.scaleX, o.scaleY, o.rotation);",
"itemtype": "method",
"name": "appendTransform",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "scaleX",
"description": "",
"type": "Number"
},
{
"name": "scaleY",
"description": "",
"type": "Number"
},
{
"name": "rotation",
"description": "",
"type": "Number"
},
{
"name": "skewX",
"description": "",
"type": "Number"
},
{
"name": "skewY",
"description": "",
"type": "Number"
},
{
"name": "regX",
"description": "Optional.",
"type": "Number"
},
{
"name": "regY",
"description": "Optional.",
"type": "Number"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 295,
"description": "Generates matrix properties from the specified display object transform properties, and prepends them to this matrix.\nFor example, you could calculate the combined transformation for a child object using:\n\n\tvar o = myDisplayObject;\n\tvar mtx = new createjs.Matrix2D();\n\tdo {\n\t\t// prepend each parent's transformation in turn:\n\t\tmtx.prependTransform(o.x, o.y, o.scaleX, o.scaleY, o.rotation, o.skewX, o.skewY, o.regX, o.regY);\n\t} while (o = o.parent);\n\t\n\tNote that the above example would not account for {{#crossLink \"DisplayObject/transformMatrix:property\"}}{{/crossLink}}\n\tvalues. See {{#crossLink \"Matrix2D/prependMatrix\"}}{{/crossLink}} for an example that does.",
"itemtype": "method",
"name": "prependTransform",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "scaleX",
"description": "",
"type": "Number"
},
{
"name": "scaleY",
"description": "",
"type": "Number"
},
{
"name": "rotation",
"description": "",
"type": "Number"
},
{
"name": "skewX",
"description": "",
"type": "Number"
},
{
"name": "skewY",
"description": "",
"type": "Number"
},
{
"name": "regX",
"description": "Optional.",
"type": "Number"
},
{
"name": "regY",
"description": "Optional.",
"type": "Number"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 346,
"description": "Applies a clockwise rotation transformation to the matrix.",
"itemtype": "method",
"name": "rotate",
"params": [
{
"name": "angle",
"description": "The angle to rotate by, in degrees. To use a value in radians, multiply it by `180/Math.PI`.",
"type": "Number"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 367,
"description": "Applies a skew transformation to the matrix.",
"itemtype": "method",
"name": "skew",
"params": [
{
"name": "skewX",
"description": "The amount to skew horizontally in degrees. To use a value in radians, multiply it by `180/Math.PI`.",
"type": "Number"
},
{
"name": "skewY",
"description": "The amount to skew vertically in degrees.",
"type": "Number"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 381,
"description": "Applies a scale transformation to the matrix.",
"itemtype": "method",
"name": "scale",
"params": [
{
"name": "x",
"description": "The amount to scale horizontally. E.G. a value of 2 will double the size in the X direction, and 0.5 will halve it.",
"type": "Number"
},
{
"name": "y",
"description": "The amount to scale vertically.",
"type": "Number"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 398,
"description": "Translates the matrix on the x and y axes.",
"itemtype": "method",
"name": "translate",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 411,
"description": "Sets the properties of the matrix to those of an identity matrix (one that applies a null transformation).",
"itemtype": "method",
"name": "identity",
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 422,
"description": "Inverts the matrix, causing it to perform the opposite transformation.",
"itemtype": "method",
"name": "invert",
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 444,
"description": "Returns true if the matrix is an identity matrix.",
"itemtype": "method",
"name": "isIdentity",
"return": {
"description": "",
"type": "Boolean"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 453,
"description": "Returns true if this matrix is equal to the specified matrix (all property values are equal).",
"itemtype": "method",
"name": "equals",
"params": [
{
"name": "matrix",
"description": "The matrix to compare.",
"type": "Matrix2D"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 463,
"description": "Transforms a point according to this matrix.",
"itemtype": "method",
"name": "transformPoint",
"params": [
{
"name": "x",
"description": "The x component of the point to transform.",
"type": "Number"
},
{
"name": "y",
"description": "The y component of the point to transform.",
"type": "Number"
},
{
"name": "pt",
"description": "An object to copy the result into. If omitted a generic object with x/y properties will be returned.",
"type": "Point | Object",
"optional": true
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Point"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 478,
"description": "Decomposes the matrix into transform properties (x, y, scaleX, scaleY, and rotation). Note that these values\nmay not match the transform properties you used to generate the matrix, though they will produce the same visual\nresults.",
"itemtype": "method",
"name": "decompose",
"params": [
{
"name": "target",
"description": "The object to apply the transform properties to. If null, then a new object will be returned.",
"type": "Object"
}
],
"return": {
"description": "The target, or a new generic object with the transform properties applied.",
"type": "Object"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 511,
"description": "Copies all properties from the specified matrix to this matrix.",
"itemtype": "method",
"name": "copy",
"params": [
{
"name": "matrix",
"description": "The matrix to copy properties from.",
"type": "Matrix2D"
}
],
"return": {
"description": "This matrix. Useful for chaining method calls.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 521,
"description": "Returns a clone of the Matrix2D instance.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "a clone of the Matrix2D instance.",
"type": "Matrix2D"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Matrix2D.js",
"line": 530,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "Matrix2D",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Point.js",
"line": 59,
"description": "X position.",
"itemtype": "property",
"name": "x",
"type": "Number",
"class": "Point",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Point.js",
"line": 65,
"description": "Y position.",
"itemtype": "property",
"name": "y",
"type": "Number",
"class": "Point",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Point.js",
"line": 73,
"description": "REMOVED. Removed in favor of using `MySuperClass_constructor`.\nSee {{#crossLink \"Utility Methods/extend\"}}{{/crossLink}} and {{#crossLink \"Utility Methods/promote\"}}{{/crossLink}}\nfor details.\n\nThere is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.",
"itemtype": "method",
"name": "initialize",
"access": "protected",
"tagname": "",
"deprecated": true,
"class": "Point",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Point.js",
"line": 88,
"description": "Sets the specified values on this instance.",
"itemtype": "method",
"name": "setValues",
"params": [
{
"name": "x",
"description": "X position.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "y",
"description": "Y position.",
"type": "Number",
"optional": true,
"optdefault": "0"
}
],
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "Point"
},
"chainable": 1,
"class": "Point",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Point.js",
"line": 102,
"description": "Copies all properties from the specified point to this point.",
"itemtype": "method",
"name": "copy",
"params": [
{
"name": "point",
"description": "The point to copy properties from.",
"type": "Point"
}
],
"return": {
"description": "This point. Useful for chaining method calls.",
"type": "Point"
},
"chainable": 1,
"class": "Point",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Point.js",
"line": 115,
"description": "Returns a clone of the Point instance.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "a clone of the Point instance.",
"type": "Point"
},
"class": "Point",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Point.js",
"line": 124,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "Point",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 61,
"description": "X position.",
"itemtype": "property",
"name": "x",
"type": "Number",
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 67,
"description": "Y position.",
"itemtype": "property",
"name": "y",
"type": "Number",
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 73,
"description": "Width.",
"itemtype": "property",
"name": "width",
"type": "Number",
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 79,
"description": "Height.",
"itemtype": "property",
"name": "height",
"type": "Number",
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 87,
"description": "REMOVED. Removed in favor of using `MySuperClass_constructor`.\nSee {{#crossLink \"Utility Methods/extend\"}}{{/crossLink}} and {{#crossLink \"Utility Methods/promote\"}}{{/crossLink}}\nfor details.\n\nThere is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.",
"itemtype": "method",
"name": "initialize",
"access": "protected",
"tagname": "",
"deprecated": true,
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 102,
"description": "Sets the specified values on this instance.",
"itemtype": "method",
"name": "setValues",
"params": [
{
"name": "x",
"description": "X position.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "y",
"description": "Y position.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "width",
"description": "The width of the Rectangle.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "height",
"description": "The height of the Rectangle.",
"type": "Number",
"optional": true,
"optdefault": "0"
}
],
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "Rectangle"
},
"chainable": 1,
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 121,
"description": "Extends the rectangle's bounds to include the described point or rectangle.",
"itemtype": "method",
"name": "extend",
"params": [
{
"name": "x",
"description": "X position of the point or rectangle.",
"type": "Number"
},
{
"name": "y",
"description": "Y position of the point or rectangle.",
"type": "Number"
},
{
"name": "width",
"description": "The width of the rectangle.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "height",
"description": "The height of the rectangle.",
"type": "Number",
"optional": true,
"optdefault": "0"
}
],
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "Rectangle"
},
"chainable": 1,
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 141,
"description": "Adds the specified padding to the rectangle's bounds.",
"itemtype": "method",
"name": "pad",
"params": [
{
"name": "top",
"description": "",
"type": "Number"
},
{
"name": "left",
"description": "",
"type": "Number"
},
{
"name": "right",
"description": "",
"type": "Number"
},
{
"name": "bottom",
"description": "",
"type": "Number"
}
],
"return": {
"description": "This instance. Useful for chaining method calls.",
"type": "Rectangle"
},
"chainable": 1,
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 159,
"description": "Copies all properties from the specified rectangle to this rectangle.",
"itemtype": "method",
"name": "copy",
"params": [
{
"name": "rectangle",
"description": "The rectangle to copy properties from.",
"type": "Rectangle"
}
],
"return": {
"description": "This rectangle. Useful for chaining method calls.",
"type": "Rectangle"
},
"chainable": 1,
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 170,
"description": "Returns true if this rectangle fully encloses the described point or rectangle.",
"itemtype": "method",
"name": "contains",
"params": [
{
"name": "x",
"description": "X position of the point or rectangle.",
"type": "Number"
},
{
"name": "y",
"description": "Y position of the point or rectangle.",
"type": "Number"
},
{
"name": "width",
"description": "The width of the rectangle.",
"type": "Number",
"optional": true,
"optdefault": "0"
},
{
"name": "height",
"description": "The height of the rectangle.",
"type": "Number",
"optional": true,
"optdefault": "0"
}
],
"return": {
"description": "True if the described point or rectangle is contained within this rectangle.",
"type": "Boolean"
},
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 185,
"description": "Returns a new rectangle which contains this rectangle and the specified rectangle.",
"itemtype": "method",
"name": "union",
"params": [
{
"name": "rect",
"description": "The rectangle to calculate a union with.",
"type": "Rectangle"
}
],
"return": {
"description": "A new rectangle describing the union.",
"type": "Rectangle"
},
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 195,
"description": "Returns a new rectangle which describes the intersection (overlap) of this rectangle and the specified rectangle,\nor null if they do not intersect.",
"itemtype": "method",
"name": "intersection",
"params": [
{
"name": "rect",
"description": "The rectangle to calculate an intersection with.",
"type": "Rectangle"
}
],
"return": {
"description": "A new rectangle describing the intersection or null.",
"type": "Rectangle"
},
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 211,
"description": "Returns true if the specified rectangle intersects (has any overlap) with this rectangle.",
"itemtype": "method",
"name": "intersects",
"params": [
{
"name": "rect",
"description": "The rectangle to compare.",
"type": "Rectangle"
}
],
"return": {
"description": "True if the rectangles intersect.",
"type": "Boolean"
},
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 221,
"description": "Returns true if the width or height are equal or less than 0.",
"itemtype": "method",
"name": "isEmpty",
"return": {
"description": "True if the rectangle is empty.",
"type": "Boolean"
},
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 230,
"description": "Returns a clone of the Rectangle instance.",
"itemtype": "method",
"name": "clone",
"return": {
"description": "a clone of the Rectangle instance.",
"type": "Rectangle"
},
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/geom/Rectangle.js",
"line": 239,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "Rectangle",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 79,
"description": "The target for this button helper.",
"itemtype": "property",
"name": "target",
"type": "MovieClip | Sprite",
"readonly": "",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 87,
"description": "The label name or frame number to display when the user mouses out of the target. Defaults to \"over\".",
"itemtype": "property",
"name": "overLabel",
"type": "String | Number",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 94,
"description": "The label name or frame number to display when the user mouses over the target. Defaults to \"out\".",
"itemtype": "property",
"name": "outLabel",
"type": "String | Number",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 101,
"description": "The label name or frame number to display when the user presses on the target. Defaults to \"down\".",
"itemtype": "property",
"name": "downLabel",
"type": "String | Number",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 108,
"description": "If true, then ButtonHelper will call gotoAndPlay, if false, it will use gotoAndStop. Default is false.",
"itemtype": "property",
"name": "play",
"default": "false",
"type": "Boolean",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 118,
"itemtype": "property",
"name": "_isPressed",
"type": "Boolean",
"access": "protected",
"tagname": "",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 125,
"itemtype": "property",
"name": "_isOver",
"type": "Boolean",
"access": "protected",
"tagname": "",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 132,
"itemtype": "property",
"name": "_enabled",
"type": "Boolean",
"access": "protected",
"tagname": "",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 153,
"description": "REMOVED. Removed in favor of using `MySuperClass_constructor`.\nSee {{#crossLink \"Utility Methods/extend\"}}{{/crossLink}} and {{#crossLink \"Utility Methods/promote\"}}{{/crossLink}}\nfor details.\n\nThere is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.",
"itemtype": "method",
"name": "initialize",
"access": "protected",
"tagname": "",
"deprecated": true,
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 168,
"description": "Use the {{#crossLink \"ButtonHelper/enabled:property\"}}{{/crossLink}} property instead.",
"itemtype": "method",
"name": "setEnabled",
"params": [
{
"name": "value",
"description": "",
"type": "Boolean"
}
],
"deprecated": true,
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 194,
"description": "Use the {{#crossLink \"ButtonHelper/enabled:property\"}}{{/crossLink}} property instead.",
"itemtype": "method",
"name": "getEnabled",
"return": {
"description": "",
"type": "Boolean"
},
"deprecated": true,
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 204,
"description": "Enables or disables the button functionality on the target.",
"itemtype": "property",
"name": "enabled",
"type": "{Boolean}",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 217,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 228,
"itemtype": "method",
"name": "handleEvent",
"params": [
{
"name": "evt",
"description": "The mouse event to handle.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/ButtonHelper.js",
"line": 255,
"description": "Injected into target. Preserves the paused state through a reset.",
"itemtype": "method",
"name": "_reset",
"access": "protected",
"tagname": "",
"class": "ButtonHelper",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 66,
"description": "Returns `true` if touch is supported in the current browser.",
"itemtype": "method",
"name": "isSupported",
"return": {
"description": "Indicates whether touch is supported in the current browser.",
"type": "Boolean"
},
"static": 1,
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 82,
"description": "Enables touch interaction for the specified EaselJS {{#crossLink \"Stage\"}}{{/crossLink}}. Currently supports iOS\n(and compatible browsers, such as modern Android browsers), and IE10/11. Supports both single touch and\nmulti-touch modes. Extends the EaselJS {{#crossLink \"MouseEvent\"}}{{/crossLink}} model, but without support for\ndouble click or over/out events. See the MouseEvent {{#crossLink \"MouseEvent/pointerId:property\"}}{{/crossLink}}\nfor more information.",
"itemtype": "method",
"name": "enable",
"params": [
{
"name": "stage",
"description": "The {{#crossLink \"Stage\"}}{{/crossLink}} to enable touch on.",
"type": "Stage"
},
{
"name": "singleTouch",
"description": "If `true`, only a single touch will be active at a time.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
},
{
"name": "allowDefault",
"description": "If `true`, then default gesture actions (ex. scrolling, zooming) will be\nallowed when the user is interacting with the target canvas.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
],
"return": {
"description": "Returns `true` if touch was successfully enabled on the target stage.",
"type": "Boolean"
},
"static": 1,
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 109,
"description": "Removes all listeners that were set up when calling `Touch.enable()` on a stage.",
"itemtype": "method",
"name": "disable",
"params": [
{
"name": "stage",
"description": "The {{#crossLink \"Stage\"}}{{/crossLink}} to disable touch on.",
"type": "Stage"
}
],
"static": 1,
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 124,
"itemtype": "method",
"name": "_IOS_enable",
"access": "protected",
"tagname": "",
"params": [
{
"name": "stage",
"description": "",
"type": "Stage"
}
],
"static": 1,
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 139,
"itemtype": "method",
"name": "_IOS_disable",
"access": "protected",
"tagname": "",
"params": [
{
"name": "stage",
"description": "",
"type": "Stage"
}
],
"static": 1,
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 155,
"itemtype": "method",
"name": "_IOS_handleEvent",
"params": [
{
"name": "stage",
"description": "",
"type": "Stage"
},
{
"name": "e",
"description": "The event to handle",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 184,
"itemtype": "method",
"name": "_handleStart",
"params": [
{
"name": "stage",
"description": "",
"type": "Stage"
},
{
"name": "id",
"description": "",
"type": "String|Number"
},
{
"name": "e",
"description": "",
"type": "Object"
},
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 199,
"itemtype": "method",
"name": "_handleMove",
"params": [
{
"name": "stage",
"description": "",
"type": "Stage"
},
{
"name": "id",
"description": "",
"type": "String|Number"
},
{
"name": "e",
"description": "",
"type": "Object"
},
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/ui/Touch.js",
"line": 212,
"itemtype": "method",
"name": "_handleEnd",
"params": [
{
"name": "stage",
"description": "",
"type": "Stage"
},
{
"name": "id",
"description": "",
"type": "String|Number"
},
{
"name": "e",
"description": "",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "Touch",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 62,
"description": "The maximum width for the images (not individual frames) in the generated SpriteSheet. It is recommended to\nuse a power of 2 for this value (ex. 1024, 2048, 4096). If the frames cannot all fit within the max\ndimensions, then additional images will be created as needed.",
"itemtype": "property",
"name": "maxWidth",
"type": "Number",
"default": "2048",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 72,
"description": "The maximum height for the images (not individual frames) in the generated SpriteSheet. It is recommended to\nuse a power of 2 for this value (ex. 1024, 2048, 4096). If the frames cannot all fit within the max\ndimensions, then additional images will be created as needed.",
"itemtype": "property",
"name": "maxHeight",
"type": "Number",
"default": "2048",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 82,
"description": "The SpriteSheet that was generated. This will be null before a build is completed successfully.",
"itemtype": "property",
"name": "spriteSheet",
"type": "SpriteSheet",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 89,
"description": "The scale to apply when drawing all frames to the SpriteSheet. This is multiplied against any scale specified\nin the addFrame call. This can be used, for example, to generate a SpriteSheet at run time that is tailored\nto the a specific device resolution (ex. tablet vs mobile).",
"itemtype": "property",
"name": "scale",
"type": "Number",
"default": "1",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 99,
"description": "The padding to use between frames. This is helpful to preserve antialiasing on drawn vector content.",
"itemtype": "property",
"name": "padding",
"type": "Number",
"default": "1",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 107,
"description": "A number from 0.01 to 0.99 that indicates what percentage of time the builder can use. This can be\nthought of as the number of seconds per second the builder will use. For example, with a timeSlice value of 0.3,\nthe builder will run 20 times per second, using approximately 15ms per build (30% of available time, or 0.3s per second).\nDefaults to 0.3.",
"itemtype": "property",
"name": "timeSlice",
"type": "Number",
"default": "0.3",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 118,
"description": "A value between 0 and 1 that indicates the progress of a build, or -1 if a build has not\nbeen initiated.",
"itemtype": "property",
"name": "progress",
"type": "Number",
"default": "-1",
"readonly": "",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 128,
"description": "A {{#crossLink \"SpriteSheet/framerate:property\"}}{{/crossLink}} value that will be passed to new {{#crossLink \"SpriteSheet\"}}{{/crossLink}} instances that are\ncreated. If no framerate is specified (or it is 0), then SpriteSheets will use the {{#crossLink \"Ticker\"}}{{/crossLink}}\nframerate.",
"itemtype": "property",
"name": "framerate",
"type": "Number",
"default": "0",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 140,
"itemtype": "property",
"name": "_frames",
"access": "protected",
"tagname": "",
"type": "Array",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 147,
"itemtype": "property",
"name": "_animations",
"access": "protected",
"tagname": "",
"type": "Array",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 154,
"itemtype": "property",
"name": "_data",
"access": "protected",
"tagname": "",
"type": "Array",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 161,
"itemtype": "property",
"name": "_nextFrameIndex",
"access": "protected",
"tagname": "",
"type": "Number",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 168,
"itemtype": "property",
"name": "_index",
"access": "protected",
"tagname": "",
"type": "Number",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 175,
"itemtype": "property",
"name": "_timerID",
"access": "protected",
"tagname": "",
"type": "Number",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 182,
"itemtype": "property",
"name": "_scale",
"access": "protected",
"tagname": "",
"type": "Number",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 191,
"description": "REMOVED. Removed in favor of using `MySuperClass_constructor`.\nSee {{#crossLink \"Utility Methods/extend\"}}{{/crossLink}} and {{#crossLink \"Utility Methods/promote\"}}{{/crossLink}}\nfor details.\n\nThere is an inheritance tutorial distributed with EaselJS in /tutorials/Inheritance.",
"itemtype": "method",
"name": "initialize",
"access": "protected",
"tagname": "",
"deprecated": true,
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 210,
"description": "Dispatched when a build completes.",
"itemtype": "event",
"name": "complete",
"params": [
{
"name": "target",
"description": "The object that dispatched the event.",
"type": "Object"
},
{
"name": "type",
"description": "The event type.",
"type": "String"
}
],
"since": "0.6.0",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 218,
"description": "Dispatched when an asynchronous build has progress.",
"itemtype": "event",
"name": "progress",
"params": [
{
"name": "target",
"description": "The object that dispatched the event.",
"type": "Object"
},
{
"name": "type",
"description": "The event type.",
"type": "String"
},
{
"name": "progress",
"description": "The current progress value (0-1).",
"type": "Number"
}
],
"since": "0.6.0",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 229,
"description": "Adds a frame to the {{#crossLink \"SpriteSheet\"}}{{/crossLink}}. Note that the frame will not be drawn until you\ncall {{#crossLink \"SpriteSheetBuilder/build\"}}{{/crossLink}} method. The optional setup params allow you to have\na function run immediately before the draw occurs. For example, this allows you to add a single source multiple\ntimes, but manipulate it or its children to change it to generate different frames.\n\nNote that the source's transformations (x, y, scale, rotate, alpha) will be ignored, except for regX/Y. To apply\ntransforms to a source object and have them captured in the SpriteSheet, simply place it into a {{#crossLink \"Container\"}}{{/crossLink}}\nand pass in the Container as the source.",
"itemtype": "method",
"name": "addFrame",
"params": [
{
"name": "source",
"description": "The source {{#crossLink \"DisplayObject\"}}{{/crossLink}} to draw as the frame.",
"type": "DisplayObject"
},
{
"name": "sourceRect",
"description": "A {{#crossLink \"Rectangle\"}}{{/crossLink}} defining the portion of the\nsource to draw to the frame. If not specified, it will look for a `getBounds` method, bounds property, or\n`nominalBounds` property on the source to use. If one is not found, the frame will be skipped.",
"type": "Rectangle",
"optional": true
},
{
"name": "scale",
"description": "Optional. The scale to draw this frame at. Default is 1.",
"type": "Number",
"optional": true,
"optdefault": "1"
},
{
"name": "setupFunction",
"description": "A function to call immediately before drawing this frame. It will be called with two parameters: the source, and setupData.",
"type": "Function",
"optional": true
},
{
"name": "setupData",
"description": "Arbitrary setup data to pass to setupFunction as the second parameter.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "The index of the frame that was just added, or null if a sourceRect could not be determined.",
"type": "Number"
},
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 257,
"description": "Adds an animation that will be included in the created {{#crossLink \"SpriteSheet\"}}{{/crossLink}}.",
"itemtype": "method",
"name": "addAnimation",
"params": [
{
"name": "name",
"description": "The name for the animation.",
"type": "String"
},
{
"name": "frames",
"description": "An array of frame indexes that comprise the animation. Ex. [3,6,5] would describe an animation\nthat played frame indexes 3, 6, and 5 in that order.",
"type": "Array"
},
{
"name": "next",
"description": "Specifies the name of the animation to continue to after this animation ends. You can\nalso pass false to have the animation stop when it ends. By default it will loop to the start of the same animation.",
"type": "String",
"optional": true
},
{
"name": "speed",
"description": "Specifies a frame advance speed for this animation. For example, a value of 0.5 would\ncause the animation to advance every second tick. Note that earlier versions used `frequency` instead, which had\nthe opposite effect.",
"type": "Number",
"optional": true
}
],
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 274,
"description": "This will take a {{#crossLink \"MovieClip\"}}{{/crossLink}} instance, and add its frames and labels to this\nbuilder. Labels will be added as an animation running from the label index to the next label. For example, if\nthere is a label named \"foo\" at frame 0 and a label named \"bar\" at frame 10, in a MovieClip with 15 frames, it\nwill add an animation named \"foo\" that runs from frame index 0 to 9, and an animation named \"bar\" that runs from\nframe index 10 to 14.\n\nNote that this will iterate through the full MovieClip with {{#crossLink \"MovieClip/actionsEnabled:property\"}}{{/crossLink}}\nset to `false`, ending on the last frame.",
"itemtype": "method",
"name": "addMovieClip",
"params": [
{
"name": "source",
"description": "The source MovieClip instance to add to the SpriteSheet.",
"type": "MovieClip"
},
{
"name": "sourceRect",
"description": "A {{#crossLink \"Rectangle\"}}{{/crossLink}} defining the portion of the source to\ndraw to the frame. If not specified, it will look for a {{#crossLink \"DisplayObject/getBounds\"}}{{/crossLink}}\nmethod, `frameBounds` Array, `bounds` property, or `nominalBounds` property on the source to use. If one is not\nfound, the MovieClip will be skipped.",
"type": "Rectangle",
"optional": true
},
{
"name": "scale",
"description": "The scale to draw the movie clip at.",
"type": "Number",
"optional": true,
"optdefault": "1"
},
{
"name": "setupFunction",
"description": "A function to call immediately before drawing each frame. It will be called\nwith three parameters: the source, setupData, and the frame index.",
"type": "Function",
"optional": true
},
{
"name": "setupData",
"description": "Arbitrary setup data to pass to setupFunction as the second parameter.",
"type": "Object",
"optional": true
},
{
"name": "labelFunction",
"description": "This method will be called for each MovieClip label that is added with four\nparameters: the label name, the source MovieClip instance, the starting frame index (in the movieclip timeline)\nand the end index. It must return a new name for the label/animation, or `false` to exclude the label.",
"type": "Function",
"optional": true
}
],
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 332,
"description": "Builds a {{#crossLink \"SpriteSheet\"}}{{/crossLink}} instance based on the current frames.",
"itemtype": "method",
"name": "build",
"return": {
"description": "The created SpriteSheet instance, or null if a build is already running or an error\noccurred.",
"type": "SpriteSheet"
},
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 346,
"description": "Asynchronously builds a {{#crossLink \"SpriteSheet\"}}{{/crossLink}} instance based on the current frames. It will\nrun 20 times per second, using an amount of time defined by `timeSlice`. When it is complete it will call the\nspecified callback.",
"itemtype": "method",
"name": "buildAsync",
"params": [
{
"name": "timeSlice",
"description": "Sets the timeSlice property on this instance.",
"type": "Number",
"optional": true
}
],
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 361,
"description": "Stops the current asynchronous build.",
"itemtype": "method",
"name": "stopAsync",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 370,
"description": "SpriteSheetBuilder instances cannot be cloned.",
"itemtype": "method",
"name": "clone",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 378,
"description": "Returns a string representation of this object.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "a string representation of the instance.",
"type": "String"
},
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 389,
"itemtype": "method",
"name": "_startBuild",
"access": "protected",
"tagname": "",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 430,
"itemtype": "method",
"name": "_setupMovieClipFrame",
"access": "protected",
"tagname": "",
"return": {
"description": "The width & height of the row.",
"type": "Number"
},
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 443,
"itemtype": "method",
"name": "_getSize",
"access": "protected",
"tagname": "",
"return": {
"description": "The width & height of the row.",
"type": "Number"
},
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 454,
"itemtype": "method",
"name": "_fillRow",
"params": [
{
"name": "frames",
"description": "",
"type": "Array"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "img",
"description": "",
"type": "HTMLImageElement"
},
{
"name": "dataFrames",
"description": "",
"type": "Object"
},
{
"name": "pad",
"description": "",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "The width & height of the row.",
"type": "Number"
},
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 492,
"itemtype": "method",
"name": "_endBuild",
"access": "protected",
"tagname": "",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 503,
"itemtype": "method",
"name": "_run",
"access": "protected",
"tagname": "",
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetBuilder.js",
"line": 528,
"itemtype": "method",
"name": "_drawNext",
"access": "protected",
"tagname": "",
"return": {
"description": "Boolean Returns false if this is the last draw."
},
"class": "SpriteSheetBuilder",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetUtils.js",
"line": 55,
"itemtype": "property",
"name": "_workingCanvas",
"static": 1,
"type": "HTMLCanvasElement | Object",
"access": "protected",
"tagname": "",
"class": "SpriteSheetUtils",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetUtils.js",
"line": 61,
"itemtype": "property",
"name": "_workingContext",
"static": 1,
"type": "CanvasRenderingContext2D",
"access": "protected",
"tagname": "",
"class": "SpriteSheetUtils",
"module": "EaselJS"
},
{
"file": "easeljs/utils/SpriteSheetUtils.js",
"line": 76,
"description": "This is an experimental method, and may be buggy. Please report issues.