An object that encapsulates util methods for HTML5 shiving.
\nTo the world, a shiv is a slang term for a sharp object used as a\nknife-like weapon. To Internet Explorer, a shiv is a script that, when\nexecuted, forces the browser to recognize HTML5 elements.
"
},
"OverlayBase": {
"name": "OverlayBase",
"shortname": "OverlayBase",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "aui-overlay",
"submodule": "aui-overlay-base",
"namespace": "",
"file": "src/aui-overlay/js/aui-overlay-base.js",
"line": 10,
"description": "A basic Overlay Widget, which can be positioned based on Page XY co-ordinates and is stackable (z-index support).\nIt also provides alignment and centering support and uses a standard module format for it's content, with header,\nbody and footer section support.",
"is_constructor": 1,
"extends": "Component",
"uses": [
"WidgetStdMod",
"WidgetPosition",
"WidgetStack",
"WidgetPositionAlign",
"WidgetPositionConstrain"
],
"params": [
{
"name": "object",
"description": "The user configuration for the instance.",
"type": "Object"
}
]
},
"OverlayContextPanel": {
"name": "OverlayContextPanel",
"shortname": "OverlayContextPanel",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "aui-overlay",
"submodule": "aui-overlay-context-panel",
"namespace": "",
"file": "src/aui-overlay/js/aui-overlay-context-panel.js",
"line": 57,
"description": "`, but you can override this in a\nsubclass, or by passing in a custom `container` config value at\ninstantiation time.\n\nWhen `container` is overridden by a subclass or passed as a config option at\ninstantiation time, it may be provided as an HTML string, a DOM element, or\na `Y.Node` instance. During initialization, this view's `create()` method\nwill be called to convert the container into a `Y.Node` instance if it isn't\none already.\n\nThe container is not added to the page automatically. This allows you to\nhave full control over how and when your view is actually rendered to the\npage.",
"itemtype": "property",
"name": "container",
"type": "HTMLElement|Node|String",
"default": "\"
\"",
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/app/js/view.js",
"line": 60,
"description": "Hash of CSS selectors mapped to events to delegate to elements matching\nthose selectors.\n\nCSS selectors are relative to the `container` element. Events are attached\nto the container, and delegation is used so that subscribers are only\nnotified of events that occur on elements inside the container that match\nthe specified selectors. This allows the container's contents to be\nre-rendered as needed without losing event subscriptions.\n\nEvent handlers can be specified either as functions or as strings that map\nto function names on this view instance or its prototype.\n\nThe `this` object in event handlers will refer to this view instance. If\nyou'd prefer `this` to be something else, use `Y.bind()` to bind a custom\n`this` object.",
"example": [
"\n\n var view = new Y.View({\n events: {\n // Call `this.toggle()` whenever the element with the id\n // \"toggle-button\" is clicked.\n '#toggle-button': {click: 'toggle'},\n\n // Call `this.hoverOn()` when the mouse moves over any element\n // with the \"hoverable\" class, and `this.hoverOff()` when the\n // mouse moves out of any element with the \"hoverable\" class.\n '.hoverable': {\n mouseover: 'hoverOn',\n mouseout : 'hoverOff'\n }\n }\n });"
],
"itemtype": "property",
"name": "events",
"type": "Object",
"default": "{}",
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/app/js/view.js",
"line": 101,
"description": "Model instance associated with this view instance.\n\nThis is entirely optional. There's no requirement that views be associated\nwith models, but if you do intend to associate your view with a model, then\nspecifying that model instance at instantiation time will cause a reference\nto be stored here for convenience.",
"itemtype": "property",
"name": "model",
"type": "Model",
"default": "undefined",
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/app/js/view.js",
"line": 114,
"description": "ModelList instance associated with this view instance.\n\nThis is entirely optional. There's no requirement that views be associated\nwith model lists, but if you do intend to associate your view with a model\nlist, then specifying that list instance at instantiation time will cause a\nreference to be stored here for convenience.",
"itemtype": "property",
"name": "modelList",
"type": "ModelList",
"default": "undefined",
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/app/js/view.js",
"line": 127,
"description": "Template for this view.\n\nThis is a convenience property that has no default behavior of its own. It's\nonly provided as a convention to allow you to store whatever you consider to\nbe a template, whether that's an HTML string, a `Y.Node` instance, a\nMustache template, or anything else your little heart desires.\n\nHow this template gets used is entirely up to you and your custom `render()`\nmethod.",
"itemtype": "property",
"name": "template",
"type": "any",
"default": "''",
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/app/js/view.js",
"line": 171,
"description": "Attaches delegated event handlers to this view's `container` element. This\nmethod is called internally to subscribe to events configured in the\n`events` property or config attribute when the view is initialized.\n\nYou may override this method to customize the event attaching logic.",
"itemtype": "method",
"name": "attachEvents",
"params": [
{
"name": "events",
"description": "Hash of events to attach. See the docs for the\n `events` property for details on the format.",
"type": "Object"
}
],
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/app/js/view.js",
"line": 206,
"description": "Creates and returns this view's `container` node from the specified HTML\nstring, DOM element, or existing `Y.Node` instance. This method is called\ninternally when the view is initialized.\n\nBy default, the created node is _not_ added to the DOM automatically.\n\nYou may override this method to customize how the container node is created\n(such as by rendering it from a template). Your method should return a\n`Y.Node` instance.",
"itemtype": "method",
"name": "create",
"params": [
{
"name": "container",
"description": "HTML string, DOM element, or\n `Y.Node` instance to use as the container node.",
"type": "HTMLElement|Node|String"
}
],
"return": {
"description": "Node instance of the created container node.",
"type": "Node"
},
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/app/js/view.js",
"line": 227,
"description": "Removes this view's `container` element from the DOM (if it's in the DOM),\nbut doesn't destroy it or any event listeners attached to it.",
"itemtype": "method",
"name": "remove",
"chainable": 1,
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/app/js/view.js",
"line": 239,
"description": "Renders the view.\n\nThis method is a noop by default. Override it in your subclass to provide a\ncustom implementation that renders this view's content and appends it to the\n`container` element. Ideally your `render` method should also return `this`\nas the end to allow chaining, but that's up to you.\n\nSince there's no default renderer, you're free to render your view however\nyou see fit, whether that means manipulating the DOM directly, dumping\nstrings into `innerHTML`, or using a template language of some kind.\n\nFor basic templating needs, `Y.Node.create()` and `Y.Lang.sub()` may\nsuffice, but there are no restrictions on what tools or techniques you can\nuse to render your view. All you need to do is append something to the\n`container` element at some point, and optionally append the `container`\nto the DOM if it's not there already.",
"itemtype": "method",
"name": "render",
"chainable": 1,
"class": "View",
"module": "app",
"submodule": "view"
},
{
"file": "lib/yui3/src/arraysort/js/arraysort.js",
"line": 18,
"description": "Comparator function for simple case-insensitive string sorting.",
"itemtype": "method",
"name": "compare",
"params": [
{
"name": "a",
"description": "First sort argument.",
"type": "Object"
},
{
"name": "b",
"description": "Second sort argument.",
"type": "Object"
},
{
"name": "desc",
"description": "True if sort direction is descending, false if\nsort direction is ascending.",
"type": "Boolean"
}
],
"return": {
"description": "Return -1 when a < b. Return 0 when a = b.\nReturn 1 when a > b.",
"type": "Boolean"
},
"class": "ArraySort",
"module": "arraysort"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 53,
"description": "
Static default values used to populate callback configuration properties.\nPreconfigured defaults include:
\n\n
\n autoContinue: trueiterations: 1timeout: 10 (10ms between callbacks)until: (function to run until iterations <= 0)
",
"itemtype": "property",
"name": "defaults",
"type": "{Object}",
"static": 1,
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 79,
"description": "Used to indicate the queue is currently executing a callback.",
"itemtype": "property",
"name": "_running",
"type": "{Boolean|Object} true for synchronous callback execution, the\n return handle from Y.later for async callbacks.\n Otherwise false.",
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 90,
"description": "Initializes the AsyncQueue instance properties and events.",
"itemtype": "method",
"name": "_init",
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 101,
"description": "Callback defaults for this instance. Static defaults that are not\noverridden are also included.",
"itemtype": "property",
"name": "defaults",
"type": "{Object}",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 113,
"description": "Initializes the instance events.",
"itemtype": "method",
"name": "_initEvents",
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 129,
"description": "Returns the next callback needing execution. If a callback is\nconfigured to repeat via iterations or until, it will be returned until\nthe completion criteria is met.\n\nWhen the queue is empty, null is returned.",
"itemtype": "method",
"name": "next",
"return": {
"description": "the callback to execute",
"type": "Function"
},
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 155,
"description": "Default functionality for the "shift" event. Shifts the\ncallback stored in the event object's
callback property from\nthe queue if it is the first item.",
"itemtype": "method",
"name": "_defShiftFn",
"params": [
{
"name": "e",
"description": "The event object",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 170,
"description": "Creates a wrapper function to execute the callback using the aggregated \nconfiguration generated by combining the static AsyncQueue.defaults, the\ninstance defaults, and the specified callback settings.\n\nThe wrapper function is decorated with the callback configuration as\nproperties for runtime modification.",
"itemtype": "method",
"name": "_prepare",
"params": [
{
"name": "callback",
"description": "the raw callback",
"type": "Object|Function"
}
],
"return": {
"description": "a decorated function wrapper to execute the callback",
"type": "Function"
},
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 207,
"description": "Sets the queue in motion. All queued callbacks will be executed in\norder unless pause() or stop() is called or if one of the callbacks is\nconfigured with autoContinue: false.",
"itemtype": "method",
"name": "run",
"return": {
"description": "the AsyncQueue instance",
"type": "AsyncQueue"
},
"chainable": 1,
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 230,
"description": "Event fired after the last queued callback is executed.",
"itemtype": "event",
"name": "complete",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 240,
"description": "Handles the execution of callbacks. Returns a boolean indicating\nwhether it is appropriate to continue running.",
"itemtype": "method",
"name": "_execute",
"params": [
{
"name": "callback",
"description": "the callback object to execute",
"type": "Object"
}
],
"return": {
"description": "whether the run loop should continue",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 262,
"description": "Schedules the execution of asynchronous callbacks.",
"itemtype": "method",
"name": "_schedule",
"params": [
{
"name": "callback",
"description": "the callback object to execute",
"type": "Object"
}
],
"return": {
"description": "whether the run loop should continue",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 280,
"description": "Determines if the queue is waiting for a callback to complete execution.",
"itemtype": "method",
"name": "isRunning",
"return": {
"description": "true if queue is waiting for a \n from any initiated transactions",
"type": "Boolean"
},
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 291,
"description": "Default functionality for the "execute" event. Executes the\ncallback function",
"itemtype": "method",
"name": "_defExecFn",
"params": [
{
"name": "e",
"description": "the event object",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 303,
"description": "Add any number of callbacks to the end of the queue. Callbacks may be\nprovided as functions or objects.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "callback",
"description": "0..n callbacks",
"type": "Function|Object",
"multiple": true
}
],
"return": {
"description": "the AsyncQueue instance",
"type": "AsyncQueue"
},
"chainable": 1,
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 318,
"description": "Default functionality for the "add" event. Adds the callbacks\nin the event facade to the queue. Callbacks successfully added to the\nqueue are present in the event's
added property in the\nafter phase.",
"itemtype": "method",
"name": "_defAddFn",
"params": [
{
"name": "e",
"description": "the event object",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 342,
"description": "Pause the execution of the queue after the execution of the current\ncallback completes. If called from code outside of a queued callback,\nclears the timeout for the pending callback. Paused queue can be\nrestarted with q.run()",
"itemtype": "method",
"name": "pause",
"return": {
"description": "the AsyncQueue instance",
"type": "AsyncQueue"
},
"chainable": 1,
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 362,
"description": "Stop and clear the queue after the current execution of the\ncurrent callback completes.",
"itemtype": "method",
"name": "stop",
"return": {
"description": "the AsyncQueue instance",
"type": "AsyncQueue"
},
"chainable": 1,
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 376,
"description": "Returns the current index of a callback. Pass in either the id or\ncallback function from getCallback.",
"itemtype": "method",
"name": "indexOf",
"params": [
{
"name": "callback",
"description": "the callback or its specified id",
"type": "String|Function"
}
],
"return": {
"description": "index of the callback or -1 if not found",
"type": "Number"
},
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 397,
"description": "Retrieve a callback by its id. Useful to modify the configuration\nwhile the queue is running.",
"itemtype": "method",
"name": "getCallback",
"params": [
{
"name": "id",
"description": "the id assigned to the callback",
"type": "String"
}
],
"return": {
"description": "the callback object",
"type": "Object"
},
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 411,
"description": "Promotes the named callback to the top of the queue. If a callback is\ncurrently executing or looping (via until or iterations), the promotion\nis scheduled to occur after the current callback has completed.",
"itemtype": "method",
"name": "promote",
"params": [
{
"name": "callback",
"description": "the callback object or a callback's id",
"type": "String|Object"
}
],
"return": {
"description": "the AsyncQueue instance",
"type": "AsyncQueue"
},
"chainable": 1,
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 436,
"description": "
Default functionality for the "promote" event. Promotes the\nnamed callback to the head of the queue.
\n\n
The event object will contain a property "callback", which\nholds the id of a callback or the callback object itself.
",
"itemtype": "method",
"name": "_defPromoteFn",
"params": [
{
"name": "e",
"description": "the custom event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 458,
"description": "Removes the callback from the queue. If the queue is active, the\nremoval is scheduled to occur after the current callback has completed.",
"itemtype": "method",
"name": "remove",
"params": [
{
"name": "callback",
"description": "the callback object or a callback's id",
"type": "String|Object"
}
],
"return": {
"description": "the AsyncQueue instance",
"type": "AsyncQueue"
},
"chainable": 1,
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 484,
"description": "
Default functionality for the "remove" event. Removes the\ncallback from the queue.
\n\n
The event object will contain a property "callback", which\nholds the id of a callback or the callback object itself.
",
"itemtype": "method",
"name": "_defRemoveFn",
"params": [
{
"name": "e",
"description": "the custom event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/async-queue/js/async-queue.js",
"line": 501,
"description": "Returns the number of callbacks in the queue.",
"itemtype": "method",
"name": "size",
"return": {
"description": "",
"type": "Number"
},
"class": "AsyncQueue",
"module": "async-queue"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 105,
"description": "
The value to return from an attribute setter in order to prevent the set from going through.
\n\n
You can return this value from your setter if you wish to combine validator and setter \nfunctionality into a single setter function, which either returns the massaged value to be stored or \nAttribute.INVALID_VALUE to prevent invalid values from being stored.
",
"itemtype": "property",
"name": "INVALID_VALUE",
"type": "Object",
"static": 1,
"final": 1,
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 120,
"description": "The list of properties which can be configured for \neach attribute (e.g. setter, getter, writeOnce etc.).\n\nThis property is used internally as a whitelist for faster\nY.mix operations.",
"itemtype": "property",
"name": "_ATTR_CFG",
"type": "Array",
"static": 1,
"access": "protected",
"tagname": "",
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 135,
"description": "
\nAdds an attribute with the provided configuration to the host object.\n
\n
\nThe config argument object supports the following properties:\n
\n\n
\n - value <Any>
\n - The initial value to set on the attribute
\n\n - valueFn <Function | String>
\n - \n
A function, which will return the initial value to set on the attribute. This is useful\n for cases where the attribute configuration is defined statically, but needs to \n reference the host instance (\"this\") to obtain an initial value. If both the value and valueFn properties are defined, \n the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which \n case the value property is used.
\n\n valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
\n \n\n - readOnly <boolean>
\n - Whether or not the attribute is read only. Attributes having readOnly set to true\n cannot be modified by invoking the set method.
\n\n - writeOnce <boolean> or <string>
\n - \n Whether or not the attribute is \"write once\". Attributes having writeOnce set to true, \n can only have their values set once, be it through the default configuration, \n constructor configuration arguments, or by invoking set.\n
The writeOnce attribute can also be set to the string \"initOnly\", in which case the attribute can only be set during initialization\n (when used with Base, this means it can only be set during construction)
\n \n\n - setter <Function | String>
\n - \n
The setter function used to massage or normalize the value passed to the set method for the attribute. \n The value returned by the setter will be the final stored value. Returning\n Attribute.INVALID_VALUE, from the setter will prevent\n the value from being stored.\n
\n \n setter can also be set to a string, representing the name of the instance method to be used as the setter function.
\n \n \n - getter <Function | String>
\n - \n
\n The getter function used to massage or normalize the value returned by the get method for the attribute.\n The value returned by the getter function is the value which will be returned to the user when they \n invoke get.\n
\n\n getter can also be set to a string, representing the name of the instance method to be used as the getter function.
\n \n\n - validator <Function | String>
\n - \n
\n The validator function invoked prior to setting the stored value. Returning\n false from the validator function will prevent the value from being stored.\n
\n \n validator can also be set to a string, representing the name of the instance method to be used as the validator function.
\n \n \n - broadcast <int>
\n - If and how attribute change events for this attribute should be broadcast. See CustomEvent's broadcast property for \n valid values. By default attribute change events are not broadcast.
\n\n - lazyAdd <boolean>
\n - Whether or not to delay initialization of the attribute until the first call to get/set it. \n This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through \n the addAttrs method.
\n\n
\n\n
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with\nthe context (\"this\") set to the host object.
\n\n
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
",
"itemtype": "method",
"name": "addAttr",
"params": [
{
"name": "name",
"description": "The name of the attribute.",
"type": "String"
},
{
"name": "config",
"description": "An object with attribute configuration property/value pairs, specifying the configuration for the attribute.\n\n
\nNOTE: The configuration object is modified when adding an attribute, so if you need \nto protect the original values, you will need to merge the object.\n
",
"type": "Object"
},
{
"name": "lazy",
"description": "(optional) Whether or not to add this attribute lazily (on the first call to get/set).",
"type": "Boolean"
}
],
"return": {
"description": "A reference to the host object.",
"type": "Object"
},
"chainable": 1,
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 284,
"description": "Checks if the given attribute has been added to the host",
"itemtype": "method",
"name": "attrAdded",
"params": [
{
"name": "name",
"description": "The name of the attribute to check.",
"type": "String"
}
],
"return": {
"description": "true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.",
"type": "Boolean"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 295,
"description": "Updates the configuration of an attribute which has already been added.\n
\nThe properties which can be modified through this interface are limited\nto the following subset of attributes, which can be safely modified\nafter a value has already been set on the attribute: readOnly, writeOnce, \nbroadcast and getter.\n
",
"itemtype": "method",
"name": "modifyAttr",
"params": [
{
"name": "name",
"description": "The name of the attribute whose configuration is to be updated.",
"type": "String"
},
{
"name": "config",
"description": "An object with configuration property/value pairs, specifying the configuration properties to modify.",
"type": "Object"
}
],
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 333,
"description": "Removes an attribute from the host object",
"itemtype": "method",
"name": "removeAttr",
"params": [
{
"name": "name",
"description": "The name of the attribute to be removed.",
"type": "String"
}
],
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 343,
"description": "Returns the current value of the attribute. If the attribute\nhas been configured with a 'getter' function, this method will delegate\nto the 'getter' to obtain the value of the attribute.",
"itemtype": "method",
"name": "get",
"params": [
{
"name": "name",
"description": "The name of the attribute. If the value of the attribute is an Object, \ndot notation can be used to obtain the value of a property of the object (e.g.
get(\"x.y.z\"))",
"type": "String"
}
],
"return": {
"description": "The value of the attribute",
"type": "Any"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 359,
"description": "Checks whether or not the attribute is one which has been\nadded lazily and still requires initialization.",
"itemtype": "method",
"name": "_isLazyAttr",
"access": "private",
"tagname": "",
"params": [
{
"name": "name",
"description": "The name of the attribute",
"type": "String"
}
],
"return": {
"description": "true if it's a lazily added attribute, false otherwise.",
"type": "Boolean"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 372,
"description": "Finishes initializing an attribute which has been lazily added.",
"itemtype": "method",
"name": "_addLazyAttr",
"access": "private",
"tagname": "",
"params": [
{
"name": "name",
"description": "The name of the attribute",
"type": "Object"
}
],
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 388,
"description": "Sets the value of an attribute.",
"itemtype": "method",
"name": "set",
"chainable": 1,
"params": [
{
"name": "name",
"description": "The name of the attribute. If the \ncurrent value of the attribute is an Object, dot notation can be used\nto set the value of a property within the object (e.g.
set(\"x.y.z\", 5)).",
"type": "String"
},
{
"name": "value",
"description": "The value to set the attribute to.",
"type": "Any"
},
{
"name": "opts",
"description": "(Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event. This \ncan be used as a flexible way to identify the source of a call to set, allowing \nthe developer to distinguish between set called internally by the host, vs. \nset called externally by the application developer.",
"type": "Object"
}
],
"return": {
"description": "A reference to the host object.",
"type": "Object"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 412,
"description": "Resets the attribute (or all attributes) to its initial value, as long as\nthe attribute is not readOnly, or writeOnce.",
"itemtype": "method",
"name": "reset",
"params": [
{
"name": "name",
"description": "Optional. The name of the attribute to reset. If omitted, all attributes are reset.",
"type": "String"
}
],
"return": {
"description": "A reference to the host object.",
"type": "Object"
},
"chainable": 1,
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 439,
"description": "Allows setting of readOnly/writeOnce attributes. See
set for argument details.",
"itemtype": "method",
"name": "_set",
"access": "protected",
"tagname": "",
"chainable": 1,
"params": [
{
"name": "name",
"description": "The name of the attribute.",
"type": "String"
},
{
"name": "val",
"description": "The value to set the attribute to.",
"type": "Any"
},
{
"name": "opts",
"description": "(Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event.",
"type": "Object"
}
],
"return": {
"description": "A reference to the host object.",
"type": "Object"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 456,
"description": "Provides the common implementation for the public get method,\nallowing Attribute hosts to over-ride either method.\n\nSee
get for argument details.",
"itemtype": "method",
"name": "_getAttr",
"access": "protected",
"tagname": "",
"chainable": 1,
"params": [
{
"name": "name",
"description": "The name of the attribute.",
"type": "String"
}
],
"return": {
"description": "The value of the attribute.",
"type": "Any"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 509,
"description": "Provides the common implementation for the public set and protected _set methods.\n\nSee
set for argument details.",
"itemtype": "method",
"name": "_setAttr",
"access": "protected",
"tagname": "",
"chainable": 1,
"params": [
{
"name": "name",
"description": "The name of the attribute.",
"type": "String"
},
{
"name": "value",
"description": "The value to set the attribute to.",
"type": "Any"
},
{
"name": "opts",
"description": "(Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event.",
"type": "Object"
},
{
"name": "force",
"description": "If true, allows the caller to set values for \nreadOnly or writeOnce attributes which have already been set.",
"type": "Boolean"
}
],
"return": {
"description": "A reference to the host object.",
"type": "Object"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 609,
"description": "Utility method to help setup the event payload and fire the attribute change event.",
"itemtype": "method",
"name": "_fireAttrChange",
"access": "private",
"tagname": "",
"params": [
{
"name": "attrName",
"description": "The name of the attribute",
"type": "String"
},
{
"name": "subAttrName",
"description": "The full path of the property being changed, \nif this is a sub-attribute value being change. Otherwise null.",
"type": "String"
},
{
"name": "currVal",
"description": "The current value of the attribute",
"type": "Any"
},
{
"name": "newVal",
"description": "The new value of the attribute",
"type": "Any"
},
{
"name": "opts",
"description": "Any additional event data to mix into the attribute change event's event facade.",
"type": "Object"
}
],
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 653,
"description": "Default function for attribute change events.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_defAttrChangeFn",
"params": [
{
"name": "e",
"description": "The event object for attribute change events.",
"type": "EventFacade"
}
],
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 670,
"description": "Gets the stored value for the attribute, from either the \ninternal state object, or the state proxy if it exits",
"itemtype": "method",
"name": "_getStateVal",
"access": "private",
"tagname": "",
"params": [
{
"name": "name",
"description": "The name of the attribute",
"type": "String"
}
],
"return": {
"description": "The stored value of the attribute",
"type": "Any"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 684,
"description": "Sets the stored value for the attribute, in either the \ninternal state object, or the state proxy if it exits",
"itemtype": "method",
"name": "_setStateVal",
"access": "private",
"tagname": "",
"params": [
{
"name": "name",
"description": "The name of the attribute",
"type": "String"
},
{
"name": "value",
"description": "The value of the attribute",
"type": "Any"
}
],
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 702,
"description": "Updates the stored value of the attribute in the privately held State object,\nif validation and setter passes.",
"itemtype": "method",
"name": "_setAttrVal",
"access": "private",
"tagname": "",
"params": [
{
"name": "attrName",
"description": "The attribute name.",
"type": "String"
},
{
"name": "subAttrName",
"description": "The sub-attribute name, if setting a sub-attribute property (\"x.y.z\").",
"type": "String"
},
{
"name": "prevVal",
"description": "The currently stored value of the attribute.",
"type": "Any"
},
{
"name": "newVal",
"description": "The value which is going to be stored.",
"type": "Any"
}
],
"return": {
"description": "true if the new attribute value was stored, false if not.",
"type": "Booolean"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 785,
"description": "Sets multiple attribute values.",
"itemtype": "method",
"name": "setAttrs",
"params": [
{
"name": "attrs",
"description": "An object with attributes name/value pairs.",
"type": "Object"
}
],
"return": {
"description": "A reference to the host object.",
"type": "Object"
},
"chainable": 1,
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 797,
"description": "Implementation behind the public setAttrs method, to set multiple attribute values.",
"itemtype": "method",
"name": "_setAttrs",
"access": "protected",
"tagname": "",
"params": [
{
"name": "attrs",
"description": "An object with attributes name/value pairs.",
"type": "Object"
}
],
"return": {
"description": "A reference to the host object.",
"type": "Object"
},
"chainable": 1,
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 815,
"description": "Gets multiple attribute values.",
"itemtype": "method",
"name": "getAttrs",
"params": [
{
"name": "attrs",
"description": "Optional. An array of attribute names. If omitted, all attribute values are\nreturned. If set to true, all attributes modified from their initial values are returned.",
"type": "Array | boolean"
}
],
"return": {
"description": "An object with attribute name/value pairs.",
"type": "Object"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 827,
"description": "Implementation behind the public getAttrs method, to get multiple attribute values.",
"itemtype": "method",
"name": "_getAttrs",
"access": "protected",
"tagname": "",
"params": [
{
"name": "attrs",
"description": "Optional. An array of attribute names. If omitted, all attribute values are\nreturned. If set to true, all attributes modified from their initial values are returned.",
"type": "Array | boolean"
}
],
"return": {
"description": "An object with attribute name/value pairs.",
"type": "Object"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 857,
"description": "Configures a group of attributes, and sets initial values.\n\n
\nNOTE: This method does not isolate the configuration object by merging/cloning. \nThe caller is responsible for merging/cloning the configuration object if required.\n
",
"itemtype": "method",
"name": "addAttrs",
"chainable": 1,
"params": [
{
"name": "cfgs",
"description": "An object with attribute name/configuration pairs.",
"type": "Object"
},
{
"name": "values",
"description": "An object with attribute name/value pairs, defining the initial values to apply.\nValues defined in the cfgs argument will be over-written by values in this argument unless defined as read only.",
"type": "Object"
},
{
"name": "lazy",
"description": "Whether or not to delay the intialization of these attributes until the first call to get/set.\nIndividual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.\nSee
addAttr.",
"type": "Boolean"
}
],
"return": {
"description": "A reference to the host object.",
"type": "Object"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 889,
"description": "Implementation behind the public addAttrs method. \n\nThis method is invoked directly by get if it encounters a scenario \nin which an attribute's valueFn attempts to obtain the \nvalue an attribute in the same group of attributes, which has not yet \nbeen added (on demand initialization).",
"itemtype": "method",
"name": "_addAttrs",
"access": "private",
"tagname": "",
"params": [
{
"name": "cfgs",
"description": "An object with attribute name/configuration pairs.",
"type": "Object"
},
{
"name": "values",
"description": "An object with attribute name/value pairs, defining the initial values to apply.\nValues defined in the cfgs argument will be over-written by values in this argument unless defined as read only.",
"type": "Object"
},
{
"name": "lazy",
"description": "Whether or not to delay the intialization of these attributes until the first call to get/set.\nIndividual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.\nSee
addAttr.",
"type": "Boolean"
}
],
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 935,
"description": "Utility method to protect an attribute configuration\nhash, by merging the entire object and the individual \nattr config objects.",
"itemtype": "method",
"name": "_protectAttrs",
"access": "protected",
"tagname": "",
"params": [
{
"name": "attrs",
"description": "A hash of attribute to configuration object pairs.",
"type": "Object"
}
],
"return": {
"description": "A protected version of the attrs argument.",
"type": "Object"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 957,
"description": "Utility method to normalize attribute values. The base implementation \nsimply merges the hash to protect the original.",
"itemtype": "method",
"name": "_normAttrVals",
"params": [
{
"name": "valueHash",
"description": "An object with attribute name/value pairs",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 972,
"description": "Returns the initial value of the given attribute from\neither the default configuration provided, or the \nover-ridden value if it exists in the set of initValues \nprovided and the attribute is not read-only.",
"params": [
{
"name": "attr",
"description": "The name of the attribute",
"type": "String"
},
{
"name": "cfg",
"description": "The attribute configuration object",
"type": "Object"
},
{
"name": "initValues",
"description": "The object with simple and complex attribute name/value pairs returned from _normAttrVals",
"type": "Object"
}
],
"return": {
"description": "The initial value of the attribute.",
"type": "Any"
},
"itemtype": "method",
"name": "_getAttrInitVal",
"access": "private",
"tagname": "",
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 1011,
"description": "Returns an object with the configuration properties (and value)\nfor the given attrubute. If attrName is not provided, returns the\nconfiguration properties for all attributes.",
"itemtype": "method",
"name": "_getAttrCfg",
"access": "protected",
"tagname": "",
"params": [
{
"name": "name",
"description": "Optional. The attribute name. If not provided, the method will return the configuration for all attributes.",
"type": "String"
}
],
"return": {
"description": "The configuration properties for the given attribute, or all attributes.",
"type": "Object"
},
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/Attribute.js",
"line": 1045,
"description": "Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.",
"itemtype": "method",
"name": "_initAttrs",
"access": "protected",
"tagname": "",
"params": [
{
"name": "attrs",
"description": "The attributes to add during construction (passed through to
addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.",
"type": "Object"
},
{
"name": "values",
"description": "The initial attribute values to apply (passed through to
addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.",
"type": "Object"
},
{
"name": "lazy",
"description": "Whether or not to add attributes lazily (passed through to
addAttrs).",
"type": "Boolean"
}
],
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-base"
},
{
"file": "lib/yui3/src/attribute/js/ComplexAttribute.js",
"line": 15,
"description": "Utility method to split out simple attribute name/value pairs (\"x\") \nfrom complex attribute name/value pairs (\"x.y.z\"), so that complex\nattributes can be keyed by the top level attribute name.",
"itemtype": "method",
"name": "_normAttrVals",
"params": [
{
"name": "valueHash",
"description": "An object with attribute name/value pairs",
"type": "Object"
}
],
"return": {
"description": "An object literal with 2 properties - \"simple\" and \"complex\",\ncontaining simple and complex attribute values respectively keyed \nby the top level attribute name, or null, if valueHash is falsey.",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-complex"
},
{
"file": "lib/yui3/src/attribute/js/ComplexAttribute.js",
"line": 58,
"description": "Returns the initial value of the given attribute from\neither the default configuration provided, or the \nover-ridden value if it exists in the set of initValues \nprovided and the attribute is not read-only.",
"params": [
{
"name": "attr",
"description": "The name of the attribute",
"type": "String"
},
{
"name": "cfg",
"description": "The attribute configuration object",
"type": "Object"
},
{
"name": "initValues",
"description": "The object with simple and complex attribute name/value pairs returned from _normAttrVals",
"type": "Object"
}
],
"return": {
"description": "The initial value of the attribute.",
"type": "Any"
},
"itemtype": "method",
"name": "_getAttrInitVal",
"access": "private",
"tagname": "",
"class": "Attribute",
"module": "attribute",
"submodule": "attribute-complex"
},
{
"file": "lib/yui3/src/attribute/js/State.js",
"line": 13,
"description": "Hash of attributes",
"itemtype": "property",
"name": "data",
"class": "State",
"module": "attribute"
},
{
"file": "lib/yui3/src/attribute/js/State.js",
"line": 22,
"description": "Adds a property to an item.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "name",
"description": "The name of the item.",
"type": "String"
},
{
"name": "key",
"description": "The name of the property.",
"type": "String"
},
{
"name": "val",
"description": "The value of the property.",
"type": "Any"
}
],
"class": "State",
"module": "attribute"
},
{
"file": "lib/yui3/src/attribute/js/State.js",
"line": 36,
"description": "Adds multiple properties to an item.",
"itemtype": "method",
"name": "addAll",
"params": [
{
"name": "name",
"description": "The name of the item.",
"type": "String"
},
{
"name": "o",
"description": "A hash of property/value pairs.",
"type": "Object"
}
],
"class": "State",
"module": "attribute"
},
{
"file": "lib/yui3/src/attribute/js/State.js",
"line": 52,
"description": "Removes a property from an item.",
"itemtype": "method",
"name": "remove",
"params": [
{
"name": "name",
"description": "The name of the item.",
"type": "String"
},
{
"name": "key",
"description": "The property to remove.",
"type": "String"
}
],
"class": "State",
"module": "attribute"
},
{
"file": "lib/yui3/src/attribute/js/State.js",
"line": 66,
"description": "Removes multiple properties from an item, or remove the item completely.",
"itemtype": "method",
"name": "removeAll",
"params": [
{
"name": "name",
"description": "The name of the item.",
"type": "String"
},
{
"name": "o",
"description": "Collection of properties to delete. If not provided, the entire item is removed.",
"type": "Object|Array"
}
],
"class": "State",
"module": "attribute"
},
{
"file": "lib/yui3/src/attribute/js/State.js",
"line": 85,
"description": "For a given item, returns the value of the property requested, or undefined if not found.",
"itemtype": "method",
"name": "get",
"params": [
{
"name": "name",
"description": "The name of the item",
"type": "String"
},
{
"name": "key",
"description": "Optional. The property value to retrieve.",
"type": "String"
}
],
"return": {
"description": "The value of the supplied property.",
"type": "Any"
},
"class": "State",
"module": "attribute"
},
{
"file": "lib/yui3/src/attribute/js/State.js",
"line": 98,
"description": "For the given item, returns a disposable object with all of the\nitem's property/value pairs.",
"itemtype": "method",
"name": "getAll",
"params": [
{
"name": "name",
"description": "The name of the item",
"type": "String"
}
],
"return": {
"description": "An object with property/value pairs for the item.",
"type": "Object"
},
"class": "State",
"module": "attribute"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 113,
"description": "Fires after the query has been completely cleared or no longer meets the\nminimum query length requirement.",
"itemtype": "event",
"name": "clear",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n
\n - prevVal (String)
\n - \n Value of the query before it was cleared.\n
\n
",
"type": "EventFacade"
}
],
"preventable": "_defClearFn",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 134,
"description": "Fires when the contents of the input field have changed and the input\nvalue meets the criteria necessary to generate an autocomplete query.",
"itemtype": "event",
"name": "query",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n
\n - inputValue (String)
\n - \n Full contents of the text input field or textarea that generated\n the query.\n
\n\n - query (String)
\n - \n Autocomplete query. This is the string that will be used to\n request completion results. It may or may not be the same as\n
inputValue.\n \n
",
"type": "EventFacade"
}
],
"preventable": "_defQueryFn",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 163,
"description": "Fires after query results are received from the
source. If\nno source has been set, this event will not fire.",
"itemtype": "event",
"name": "results",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n
\n - data (Array|Object)
\n - \n Raw, unfiltered result data (if available).\n
\n\n - query (String)
\n - \n Query that generated these results.\n
\n\n - results (Array)
\n - \n Array of filtered, formatted, and highlighted results. Each item in\n the array is an object with the following properties:\n\n
\n - display (Node|HTMLElement|String)
\n - \n Formatted result HTML suitable for display to the user. If no\n custom formatter is set, this will be an HTML-escaped version of\n the string in the
text property.\n \n\n - highlighted (String)
\n - \n Highlighted (but not formatted) result text. This property will\n only be set if a highlighter is in use.\n
\n\n - raw (mixed)
\n - \n Raw, unformatted result in whatever form it was provided by the\n
source.\n \n\n - text (String)
\n - \n Plain text version of the result, suitable for being inserted\n into the value of a text input field or textarea when the result\n is selected by a user. This value is not HTML-escaped and should\n not be inserted into the page using innerHTML.\n
\n
\n \n
",
"type": "EventFacade"
}
],
"preventable": "_defResultsFn",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 227,
"description": "Whether or not to enable the browser's built-in autocomplete\nfunctionality for input fields.",
"itemtype": "attribute",
"name": "allowBrowserAutocomplete",
"type": "Boolean",
"default": "false",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 239,
"description": "When a
queryDelimiter is set, trailing delimiters will\nautomatically be stripped from the input value by default when the\ninput node loses focus. Set this to
true to allow trailing\ndelimiters.",
"itemtype": "attribute",
"name": "allowTrailingDelimiter",
"type": "Boolean",
"default": "false",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 253,
"description": "Node to monitor for changes, which will generate
query\nevents when appropriate. May be either an input field or a textarea.",
"itemtype": "attribute",
"name": "inputNode",
"type": "Node|HTMLElement|String",
"writeonce": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 266,
"description": "Maximum number of results to return. A value of
0 or less\nwill allow an unlimited number of results.",
"itemtype": "attribute",
"name": "maxResults",
"type": "Number",
"default": "0",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 278,
"description": "Minimum number of characters that must be entered before a\n
query event will be fired. A value of
0\nallows empty queries; a negative value will effectively disable all\n
query events.",
"itemtype": "attribute",
"name": "minQueryLength",
"type": "Number",
"default": "1",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 292,
"description": "
\nCurrent query, or null if there is no current query.\n
\n\n
\nThe query might not be the same as the current value of the input\nnode, both for timing reasons (due to queryDelay) and\nbecause when one or more queryDelimiter separators are\nin use, only the last portion of the delimited input string will be\nused as the query value.\n
",
"itemtype": "attribute",
"name": "query",
"type": "String|null",
"default": "null",
"readonly": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 315,
"description": "
\nNumber of milliseconds to delay after input before triggering a\nquery event. If new input occurs before this delay is\nover, the previous input event will be ignored and a new delay will\nbegin.\n
\n\n
\nThis can be useful both to throttle queries to a remote data source\nand to avoid distracting the user by showing them less relevant\nresults before they've paused their typing.\n
",
"itemtype": "attribute",
"name": "queryDelay",
"type": "Number",
"default": "100",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 337,
"description": "Query delimiter string. When a delimiter is configured, the input value\nwill be split on the delimiter, and only the last portion will be used in\nautocomplete queries and updated when the
query attribute is\nmodified.",
"itemtype": "attribute",
"name": "queryDelimiter",
"type": "String|null",
"default": "null",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 351,
"description": "
\nSource request template. This can be a function that accepts a query as a\nparameter and returns a request string, or it can be a string containing\nthe placeholder \"{query}\", which will be replaced with the actual\nURI-encoded query. In either case, the resulting string will be appended\nto the request URL when the source attribute is set to a\nremote DataSource, JSONP URL, or XHR URL (it will not be appended to YQL\nURLs).\n
\n\n
\nWhile requestTemplate may be set to either a function or\na string, it will always be returned as a function that accepts a\nquery argument and returns a string.\n
",
"itemtype": "attribute",
"name": "requestTemplate",
"type": "Function|String|null",
"default": "null",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 377,
"description": "
\nArray of local result filter functions. If provided, each filter\nwill be called with two arguments when results are received: the query\nand an array of result objects. See the documentation for the\nresults event for a list of the properties available on each\nresult object.\n
\n\n
\nEach filter is expected to return a filtered or modified version of the\nresults array, which will then be passed on to subsequent filters, then\nthe resultHighlighter function (if set), then the\nresultFormatter function (if set), and finally to\nsubscribers to the results event.\n
\n\n
\nIf no source is set, result filters will not be called.\n
\n\n
\nPrepackaged result filters provided by the autocomplete-filters and\nautocomplete-filters-accentfold modules can be used by specifying the\nfilter name as a string, such as 'phraseMatch' (assuming\nthe necessary filters module is loaded).\n
",
"itemtype": "attribute",
"name": "resultFilters",
"type": "Array",
"default": "[]",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 414,
"description": "
\nFunction which will be used to format results. If provided, this function\nwill be called with two arguments after results have been received and\nfiltered: the query and an array of result objects. The formatter is\nexpected to return an array of HTML strings or Node instances containing\nthe desired HTML for each result.\n
\n\n
\nSee the documentation for the results event for a list of\nthe properties available on each result object.\n
\n\n
\nIf no source is set, the formatter will not be called.\n
",
"itemtype": "attribute",
"name": "resultFormatter",
"type": "Function|null",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 439,
"description": "
\nFunction which will be used to highlight results. If provided, this\nfunction will be called with two arguments after results have been\nreceived and filtered: the query and an array of filtered result objects.\nThe highlighter is expected to return an array of highlighted result\ntext in the form of HTML strings.\n
\n\n
\nSee the documentation for the results event for a list of\nthe properties available on each result object.\n
\n\n
\nIf no source is set, the highlighter will not be called.\n
",
"itemtype": "attribute",
"name": "resultHighlighter",
"type": "Function|null",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 464,
"description": "
\nLocator that should be used to extract an array of results from a\nnon-array response.\n
\n\n
\nBy default, no locator is applied, and all responses are assumed to be\narrays by default. If all responses are already arrays, you don't need to\ndefine a locator.\n
\n\n
\nThe locator may be either a function (which will receive the raw response\nas an argument and must return an array) or a string representing an\nobject path, such as \"foo.bar.baz\" (which would return the value of\nresult.foo.bar.baz if the response is an object).\n
\n\n
\nWhile resultListLocator may be set to either a function or a\nstring, it will always be returned as a function that accepts a response\nargument and returns an array.\n
",
"itemtype": "attribute",
"name": "resultListLocator",
"type": "Function|String|null",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 496,
"description": "Current results, or an empty array if there are no results.",
"itemtype": "attribute",
"name": "results",
"type": "Array",
"default": "[]",
"readonly": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 509,
"description": "
\nLocator that should be used to extract a plain text string from a\nnon-string result item. The resulting text value will typically be the\nvalue that ends up being inserted into an input field or textarea when\nthe user of an autocomplete implementation selects a result.\n
\n\n
\nBy default, no locator is applied, and all results are assumed to be\nplain text strings. If all results are already plain text strings, you\ndon't need to define a locator.\n
\n\n
\nThe locator may be either a function (which will receive the raw result\nas an argument and must return a string) or a string representing an\nobject path, such as \"foo.bar.baz\" (which would return the value of\nresult.foo.bar.baz if the result is an object).\n
\n\n
\nWhile resultTextLocator may be set to either a function or a\nstring, it will always be returned as a function that accepts a result\nargument and returns a string.\n
",
"itemtype": "attribute",
"name": "resultTextLocator",
"type": "Function|String|null",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 543,
"description": "
\nSource for autocomplete results. The following source types are\nsupported:\n
\n\n
\n - Array
\n - \n
\n Example: ['first result', 'second result', 'etc']\n
\n\n \n The full array will be provided to any configured filters for each\n query. This is an easy way to create a fully client-side autocomplete\n implementation.\n
\n \n\n - DataSource
\n - \n
\n A DataSource instance or other object that provides a\n DataSource-like sendRequest method. See the\n DataSource documentation for details.\n
\n \n\n - Function
\n - \n
\n Example (synchronous): function (query) { return ['foo', 'bar']; }
\n Example (async): function (query, callback) { callback(['foo', 'bar']); }\n
\n\n \n A function source will be called with the current query and a\n callback function as parameters, and should either return an array of\n results (for synchronous operation) or return nothing and pass an\n array of results to the provided callback (for asynchronous\n operation).\n
\n \n\n - Object
\n - \n
\n Example: {foo: ['foo result 1', 'foo result 2'], bar: ['bar result']}\n
\n\n \n An object will be treated as a query hashmap. If a property on the\n object matches the current query, the value of that property will be\n used as the response.\n
\n\n \n The response is assumed to be an array of results by default. If the\n response is not an array, provide a resultListLocator to\n process the response and return an array.\n
\n \n
\n\n
\nIf the optional autocomplete-sources module is loaded, then\nthe following additional source types will be supported as well:\n
\n\n
\n - <select> Node
\n - \n
\n You may provide a YUI Node instance wrapping a <select>\n element, and the options in the list will be used as results. You\n will also need to specify a resultTextLocator of 'text'\n or 'value', depending on what you want to use as the text of the\n result.\n
\n\n \n Each result will be an object with the following properties:\n
\n\n \n - html (String)
\n - \n
HTML content of the <option> element.
\n \n\n - index (Number)
\n - \n
Index of the <option> element in the list.
\n \n\n - node (Y.Node)
\n - \n
Node instance referring to the original <option> element.
\n \n\n - selected (Boolean)
\n - \n
Whether or not this item is currently selected in the\n <select> list.
\n \n\n - text (String)
\n - \n
Text content of the <option> element.
\n \n\n - value (String)
\n - \n
Value of the <option> element.
\n \n
\n \n\n - String (JSONP URL)
\n - \n
\n Example: 'http://example.com/search?q={query}&callback={callback}'\n
\n\n \n If a URL with a {callback} placeholder is provided, it\n will be used to make a JSONP request. The {query}\n placeholder will be replaced with the current query, and the\n {callback} placeholder will be replaced with an\n internally-generated JSONP callback name. Both placeholders must\n appear in the URL, or the request will fail. An optional\n {maxResults} placeholder may also be provided, and will\n be replaced with the value of the maxResults attribute (or 1000 if\n the maxResults attribute is 0 or less).\n
\n\n \n The response is assumed to be an array of results by default. If the\n response is not an array, provide a resultListLocator to\n process the response and return an array.\n
\n\n \n The jsonp module must be loaded in order for\n JSONP URL sources to work. If the jsonp module\n is not already loaded, it will be loaded on demand if possible.\n
\n \n\n - String (XHR URL)
\n - \n
\n Example: 'http://example.com/search?q={query}'\n
\n\n \n If a URL without a {callback} placeholder is provided,\n it will be used to make a same-origin XHR request. The\n {query} placeholder will be replaced with the current\n query. An optional {maxResults} placeholder may also be\n provided, and will be replaced with the value of the maxResults\n attribute (or 1000 if the maxResults attribute is 0 or less).\n
\n\n \n The response is assumed to be a JSON array of results by default. If\n the response is a JSON object and not an array, provide a\n resultListLocator to process the response and return an\n array. If the response is in some form other than JSON, you will\n need to use a custom DataSource instance as the source.\n
\n\n \n The io-base and json-parse modules\n must be loaded in order for XHR URL sources to work. If\n these modules are not already loaded, they will be loaded on demand\n if possible.\n
\n \n\n - String (YQL query)
\n - \n
\n Example: 'select * from search.suggest where query=\"{query}\"'\n
\n\n \n If a YQL query is provided, it will be used to make a YQL request.\n The {query} placeholder will be replaced with the\n current autocomplete query. This placeholder must appear in the YQL\n query, or the request will fail. An optional\n {maxResults} placeholder may also be provided, and will\n be replaced with the value of the maxResults attribute (or 1000 if\n the maxResults attribute is 0 or less).\n
\n\n \n The yql module must be loaded in order for YQL\n sources to work. If the yql module is not\n already loaded, it will be loaded on demand if possible.\n
\n \n
\n\n
\nAs an alternative to providing a source, you could simply listen for\nquery events and handle them any way you see fit. Providing\na source is optional, but will usually be simpler.\n
",
"itemtype": "attribute",
"name": "source",
"type": "Array|DataSource|Function|Node|Object|String|null",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 761,
"description": "
\nMay be used to force a specific source type, overriding the automatic\nsource type detection. It should almost never be necessary to do this,\nbut as they taught us in the Boy Scouts, one should always be prepared,\nso it's here if you need it. Be warned that if you set this attribute and\nsomething breaks, it's your own fault.\n
\n\n
\nSupported sourceType values are: 'array', 'datasource',\n'function', and 'object'.\n
\n\n
\nIf the autocomplete-sources module is loaded, the following\nadditional source types are supported: 'io', 'jsonp', 'select',\n'string', 'yql'\n
",
"itemtype": "attribute",
"name": "sourceType",
"type": "String",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 788,
"description": "If the
inputNode specified at instantiation time has a\n
node-tokeninput plugin attached to it, this attribute will\nbe a reference to the
Y.Plugin.TokenInput instance.",
"itemtype": "attribute",
"name": "tokenInput",
"type": "Plugin.TokenInput",
"readonly": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 801,
"description": "Current value of the input node.",
"itemtype": "attribute",
"name": "value",
"type": "String",
"default": "''",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 820,
"description": "Mapping of built-in source types to their setter functions. DataSource\ninstances and DataSource-like objects are handled natively, so are not\nmapped here.",
"itemtype": "property",
"name": "SOURCE_TYPES",
"type": "{Object}",
"static": 1,
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 838,
"description": "
\nSends a request to the configured source. If no source is configured,\nthis method won't do anything.\n
\n\n
\nUsually there's no reason to call this method manually; it will be\ncalled automatically when user input causes a query event to\nbe fired. The only time you'll need to call this method manually is if\nyou want to force a request to be sent when no user input has occurred.\n
",
"itemtype": "method",
"name": "sendRequest",
"params": [
{
"name": "query",
"description": "(optional) Query to send. If specified, the\n
query attribute will be set to this query. If not\n specified, the current value of the
query attribute will\n be used.",
"type": "String"
},
{
"name": "requestTemplate",
"description": "(optional) Request template function.\n If not specified, the current value of the
requestTemplate\n attribute will be used.",
"type": "Function"
}
],
"chainable": 1,
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 896,
"description": "Attaches event listeners and behaviors.",
"itemtype": "method",
"name": "_bindUIACBase",
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 932,
"description": "Detaches AutoCompleteBase event listeners.",
"itemtype": "method",
"name": "_destructorACBase",
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 942,
"description": "Synchronizes the UI state of the
inputNode.",
"itemtype": "method",
"name": "_syncUIACBase",
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 955,
"description": "Creates a DataSource-like object that simply returns the specified array\nas a response. See the
source attribute for more details.",
"itemtype": "method",
"name": "_createArraySource",
"params": [
{
"name": "source",
"description": "",
"type": "Array"
}
],
"return": {
"description": "DataSource-like object.",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 975,
"description": "Creates a DataSource-like object that passes the query to a\ncustom-defined function, which is expected to call the provided callback\nwith an array of results. See the
source attribute for more\ndetails.",
"itemtype": "method",
"name": "_createFunctionSource",
"params": [
{
"name": "source",
"description": "Function that accepts a query and a callback as\n parameters, and calls the callback with an array of results.",
"type": "Function"
}
],
"return": {
"description": "DataSource-like object.",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1008,
"description": "Creates a DataSource-like object that looks up queries as properties on\nthe specified object, and returns the found value (if any) as a response.\nSee the
source attribute for more details.",
"itemtype": "method",
"name": "_createObjectSource",
"params": [
{
"name": "source",
"description": "",
"type": "Object"
}
],
"return": {
"description": "DataSource-like object.",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1034,
"description": "Returns
true if
value is either a function or\n
null.",
"itemtype": "method",
"name": "_functionValidator",
"params": [
{
"name": "value",
"description": "Value to validate.",
"type": "Function|null"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1046,
"description": "Faster and safer alternative to Y.Object.getValue(). Doesn't bother\ncasting the path to an array (since we already know it's an array) and\ndoesn't throw an error if a value in the middle of the object hierarchy\nis neither
undefined nor an object.",
"itemtype": "method",
"name": "_getObjectValue",
"params": [
{
"name": "obj",
"description": "",
"type": "Object"
},
{
"name": "path",
"description": "",
"type": "Array"
}
],
"return": {
"description": "Located value, or
undefined if the value was\n not found at the specified path.",
"type": "Mixed"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1071,
"description": "Parses result responses, performs filtering and highlighting, and fires\nthe
results event.",
"itemtype": "method",
"name": "_parseResponse",
"params": [
{
"name": "query",
"description": "Query that generated these results.",
"type": "String"
},
{
"name": "response",
"description": "Response containing results.",
"type": "Object"
},
{
"name": "data",
"description": "Raw response data.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1202,
"description": "
\nReturns the query portion of the specified input value, or\nnull if there is no suitable query within the input value.\n
\n\n
\nIf a query delimiter is defined, the query will be the last delimited\npart of of the string.\n
",
"itemtype": "method",
"name": "_parseValue",
"params": [
{
"name": "value",
"description": "Input value from which to extract the query.",
"type": "String"
}
],
"return": {
"description": "query",
"type": "String|null"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1229,
"description": "Setter for locator attributes.",
"itemtype": "method",
"name": "_setLocator",
"params": [
{
"name": "locator",
"description": "",
"type": "Function|String|null"
}
],
"return": {
"description": "",
"type": "Function|null"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1251,
"description": "Setter for the
requestTemplate attribute.",
"itemtype": "method",
"name": "_setRequestTemplate",
"params": [
{
"name": "template",
"description": "",
"type": "Function|String|null"
}
],
"return": {
"description": "",
"type": "Function|null"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1271,
"description": "Setter for the
resultFilters attribute.",
"itemtype": "method",
"name": "_setResultFilters",
"params": [
{
"name": "filters",
"description": "
null, a filter\n function, an array of filter functions, or a string or array of strings\n representing the names of methods on\n
Y.AutoCompleteFilters.",
"type": "Array|Function|String|null"
}
],
"return": {
"description": "Array of filter functions (empty if
filters is\n
null).",
"type": "Array"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1315,
"description": "Setter for the
resultHighlighter attribute.",
"itemtype": "method",
"name": "_setResultHighlighter",
"params": [
{
"name": "highlighter",
"description": "
null, a\n highlighter function, or a string representing the name of a method on\n
Y.AutoCompleteHighlighters.",
"type": "Function|String|null"
}
],
"return": {
"description": "",
"type": "Function|null"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1342,
"description": "Setter for the
source attribute. Returns a DataSource or\na DataSource-like object depending on the type of
source and/or\nthe value of the
sourceType attribute.",
"itemtype": "method",
"name": "_setSource",
"params": [
{
"name": "source",
"description": "AutoComplete source. See the
source\n attribute for details.",
"type": "Mixed"
}
],
"return": {
"description": "",
"type": "DataSource|Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1377,
"description": "Shared success callback for non-DataSource sources.",
"itemtype": "method",
"name": "_sourceSuccess",
"params": [
{
"name": "data",
"description": "Response data.",
"type": "Mixed"
},
{
"name": "request",
"description": "Request object.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1392,
"description": "Synchronizes the UI state of the
allowBrowserAutocomplete\nattribute.",
"itemtype": "method",
"name": "_syncBrowserAutocomplete",
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1408,
"description": "
\nUpdates the query portion of the value attribute.\n
\n\n
\nIf a query delimiter is defined, the last delimited portion of the input\nvalue will be replaced with the specified value.\n
",
"itemtype": "method",
"name": "_updateValue",
"params": [
{
"name": "newVal",
"description": "New value.",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1448,
"description": "Updates the current
source based on the new\n
sourceType to ensure that the two attributes don't get out\nof sync when they're changed separately.",
"itemtype": "method",
"name": "_afterSourceTypeChange",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1463,
"description": "Handles change events for the
value attribute.",
"itemtype": "method",
"name": "_afterValueChange",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1515,
"description": "Handles
blur events on the input node.",
"itemtype": "method",
"name": "_onInputBlur",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1553,
"description": "Handles
valueChange events on the input node and fires a\n
query event when the input value meets the configured\ncriteria.",
"itemtype": "method",
"name": "_onInputValueChange",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1574,
"description": "Handles source responses and fires the
results event.",
"itemtype": "method",
"name": "_onResponse",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1590,
"description": "Default
clear event handler. Sets the
results\nproperty to an empty array and
query to null.",
"itemtype": "method",
"name": "_defClearFn",
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1602,
"description": "Default
query event handler. Sets the
query\nproperty and sends a request to the source if one is configured.",
"itemtype": "method",
"name": "_defQueryFn",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-base.js",
"line": 1617,
"description": "Default
results event handler. Sets the
results\nproperty to the latest results.",
"itemtype": "method",
"name": "_defResultsFn",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-base"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters-accentfold.js",
"line": 28,
"description": "Accent folding version of
charMatch().",
"itemtype": "method",
"name": "charMatchFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters-accentfold.js",
"line": 51,
"description": "Accent folding version of
phraseMatch().",
"itemtype": "method",
"name": "phraseMatchFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters-accentfold.js",
"line": 70,
"description": "Accent folding version of
startsWith().",
"itemtype": "method",
"name": "startsWithFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters-accentfold.js",
"line": 89,
"description": "Accent folding version of
subWordMatch().",
"itemtype": "method",
"name": "subWordMatchFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters-accentfold.js",
"line": 112,
"description": "Accent folding version of
wordMatch().",
"itemtype": "method",
"name": "wordMatchFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 17,
"description": "Returns an array of results that contain all of the characters in the\nquery, in any order (not necessarily consecutive). Case-insensitive.",
"itemtype": "method",
"name": "charMatch",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 49,
"description": "Case-sensitive version of
charMatch().",
"itemtype": "method",
"name": "charMatchCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 62,
"description": "Returns an array of results that contain the complete query as a phrase.\nCase-insensitive.",
"itemtype": "method",
"name": "phraseMatch",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 87,
"description": "Case-sensitive version of
phraseMatch().",
"itemtype": "method",
"name": "phraseMatchCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 100,
"description": "Returns an array of results that start with the complete query as a\nphrase. Case-insensitive.",
"itemtype": "method",
"name": "startsWith",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 125,
"description": "Case-sensitive version of
startsWith().",
"itemtype": "method",
"name": "startsWithCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 138,
"description": "Returns an array of results in which all the words of the query match\neither whole words or parts of words in the result. Non-word characters\nlike whitespace and certain punctuation are ignored. Case-insensitive.\n\nThis is basically a combination of
wordMatch() (by ignoring\nwhitespace and word order) and
phraseMatch() (by allowing\npartial matching instead of requiring the entire word to match).\n\nExample use case: Trying to find personal names independently of name\norder (Western or Eastern order) and supporting immediate feedback by\nallowing partial occurences. So queries like \"J. Doe\", \"Doe, John\", and\n\"J. D.\" would all match \"John Doe\".",
"itemtype": "method",
"name": "subWordMatch",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 178,
"description": "Case-sensitive version of
subWordMatch().",
"itemtype": "method",
"name": "subWordMatchCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 191,
"description": "Returns an array of results that contain all of the words in the query,\nin any order. Non-word characters like whitespace and certain punctuation\nare ignored. Case-insensitive.",
"itemtype": "method",
"name": "wordMatch",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-filters.js",
"line": 222,
"description": "Case-sensitive version of
wordMatch().",
"itemtype": "method",
"name": "wordMatchCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to filter",
"type": "Array"
}
],
"return": {
"description": "Filtered results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteFilters",
"module": "autocomplete",
"submodule": "autocomplete-filters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters-accentfold.js",
"line": 26,
"description": "Accent-folding version of
charMatch().",
"itemtype": "method",
"name": "charMatchFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters-accentfold.js",
"line": 43,
"description": "Accent-folding version of
phraseMatch().",
"itemtype": "method",
"name": "phraseMatchFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters-accentfold.js",
"line": 58,
"description": "Accent-folding version of
startsWith().",
"itemtype": "method",
"name": "startsWithFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters-accentfold.js",
"line": 75,
"description": "Accent-folding version of
subWordMatch().",
"itemtype": "method",
"name": "subWordMatchFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters-accentfold.js",
"line": 92,
"description": "Accent-folding version of
wordMatch().",
"itemtype": "method",
"name": "wordMatchFold",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters-accentfold"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 16,
"description": "Highlights any individual query character that occurs anywhere in a\nresult. Case-insensitive.",
"itemtype": "method",
"name": "charMatch",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 40,
"description": "Case-sensitive version of
charMatch().",
"itemtype": "method",
"name": "charMatchCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 53,
"description": "Highlights the complete query as a phrase anywhere within a result.\nCase-insensitive.",
"itemtype": "method",
"name": "phraseMatch",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 74,
"description": "Case-sensitive version of
phraseMatch().",
"itemtype": "method",
"name": "phraseMatchCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 87,
"description": "Highlights the complete query as a phrase at the beginning of a result.\nCase-insensitive.",
"itemtype": "method",
"name": "startsWith",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 109,
"description": "Case-sensitive version of
startsWith().",
"itemtype": "method",
"name": "startsWithCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 122,
"description": "Highlights portions of results in which words from the query match either\nwhole words or parts of words in the result. Non-word characters like\nwhitespace and certain punctuation are ignored. Case-insensitive.",
"itemtype": "method",
"name": "subWordMatch",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 148,
"description": "Case-sensitive version of
subWordMatch().",
"itemtype": "method",
"name": "subWordMatchCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 161,
"description": "Highlights individual words in results that are also in the query.\nNon-word characters like punctuation are ignored. Case-insensitive.",
"itemtype": "method",
"name": "wordMatch",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-highlighters.js",
"line": 182,
"description": "Case-sensitive version of
wordMatch().",
"itemtype": "method",
"name": "wordMatchCase",
"params": [
{
"name": "query",
"description": "Query to match",
"type": "String"
},
{
"name": "results",
"description": "Results to highlight",
"type": "Array"
}
],
"return": {
"description": "Highlighted results",
"type": "Array"
},
"static": 1,
"class": "AutoCompleteHighlighters",
"module": "autocomplete",
"submodule": "autocomplete-highlighters"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 26,
"description": "Initializes keyboard command mappings.",
"itemtype": "method",
"name": "_initKeys",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 53,
"description": "Binds keyboard events.",
"itemtype": "method",
"name": "_bindKeys",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 64,
"description": "Unbinds keyboard events.",
"itemtype": "method",
"name": "_unbindKeys",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 78,
"description": "Called when the down arrow key is pressed.",
"itemtype": "method",
"name": "_keyDown",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 92,
"description": "Called when the enter key is pressed.",
"itemtype": "method",
"name": "_keyEnter",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 109,
"description": "Called when the escape key is pressed.",
"itemtype": "method",
"name": "_keyEsc",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 119,
"description": "Called when the tab key is pressed.",
"itemtype": "method",
"name": "_keyTab",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 140,
"description": "Called when the up arrow key is pressed.",
"itemtype": "method",
"name": "_keyUp",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list-keys.js",
"line": 152,
"description": "Handles
inputNode key events.",
"itemtype": "method",
"name": "_onInputKey",
"params": [
{
"name": "e",
"description": "",
"type": "EventTarget"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list-keys"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 82,
"description": "Fires when an autocomplete suggestion is selected from the list,\ntypically via a keyboard action or mouse click.",
"itemtype": "event",
"name": "select",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n
\n - itemNode (Node)
\n - \n List item node that was selected.\n
\n\n - result (Object)
\n - \n AutoComplete result object.\n
\n
",
"type": "EventFacade"
}
],
"preventable": "_defSelectFn",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 169,
"description": "Hides the list, unless the
alwaysShowList attribute is\n
true.",
"itemtype": "method",
"name": "hide",
"see": [
"show"
],
"chainable": 1,
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 181,
"description": "Selects the specified
itemNode, or the current\n
activeItem if
itemNode is not specified.",
"itemtype": "method",
"name": "selectItem",
"params": [
{
"name": "itemNode",
"description": "(optional) Item node to select.",
"type": "Node"
},
{
"name": "originEvent",
"description": "(optional) Event that triggered the\n selection, if any.",
"type": "EventFacade"
}
],
"chainable": 1,
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 215,
"description": "Activates the next item after the currently active item. If there is no\nnext item and the
circular attribute is
true,\nfocus will wrap back to the input node.",
"itemtype": "method",
"name": "_activateNextItem",
"chainable": 1,
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 240,
"description": "Activates the item previous to the currently active item. If there is no\nprevious item and the
circular attribute is\n
true, focus will wrap back to the input node.",
"itemtype": "method",
"name": "_activatePrevItem",
"chainable": 1,
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 259,
"description": "Appends the specified result
items to the list inside a new item\nnode.",
"itemtype": "method",
"name": "_add",
"params": [
{
"name": "items",
"description": "Result item or array of\n result items.",
"type": "Array|Node|HTMLElement|String"
}
],
"return": {
"description": "Added nodes.",
"type": "NodeList"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 282,
"description": "Updates the ARIA live region with the specified message.",
"itemtype": "method",
"name": "_ariaSay",
"params": [
{
"name": "stringId",
"description": "String id (from the
strings\n attribute) of the message to speak.",
"type": "String"
},
{
"name": "subs",
"description": "(optional) Substitutions for placeholders in the\n string.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 297,
"description": "Binds
inputNode events and behavior.",
"itemtype": "method",
"name": "_bindInput",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 336,
"description": "Binds list events.",
"itemtype": "method",
"name": "_bindList",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 364,
"description": "Clears the contents of the tray.",
"itemtype": "method",
"name": "_clear",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 377,
"description": "Creates and returns an ARIA live region node.",
"itemtype": "method",
"name": "_createAriaNode",
"return": {
"description": "ARIA node.",
"type": "Node"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 393,
"description": "Creates and returns an item node with the specified
content.",
"itemtype": "method",
"name": "_createItemNode",
"params": [
{
"name": "result",
"description": "Result object.",
"type": "Object"
}
],
"return": {
"description": "Item node.",
"type": "Node"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 410,
"description": "Creates and returns a list node. If the `listNode` attribute is already\nset to an existing node, that node will be used.",
"itemtype": "method",
"name": "_createListNode",
"return": {
"description": "List node.",
"type": "Node"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 432,
"description": "Gets the first item node in the list, or
null if the list is\nempty.",
"itemtype": "method",
"name": "_getFirstItemNode",
"return": {
"description": "",
"type": "Node|null"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 444,
"description": "Gets the last item node in the list, or
null if the list is\nempty.",
"itemtype": "method",
"name": "_getLastItemNode",
"return": {
"description": "",
"type": "Node|null"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 456,
"description": "Synchronizes the result list's position and alignment.",
"itemtype": "method",
"name": "_syncPosition",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 470,
"description": "Synchronizes the results displayed in the list with those in the\n
results argument, or with the
results attribute if an\nargument is not provided.",
"itemtype": "method",
"name": "_syncResults",
"params": [
{
"name": "results",
"description": "(optional) Results.",
"type": "Array"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 498,
"description": "Synchronizes the size of the iframe shim used for IE6 and lower. In other\nbrowsers, this method is a noop.",
"itemtype": "method",
"name": "_syncShim",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 509,
"description": "Synchronizes the visibility of the tray with the
visible argument,\nor with the
visible attribute if an argument is not\nprovided.",
"itemtype": "method",
"name": "_syncVisibility",
"params": [
{
"name": "visible",
"description": "(optional) Visibility.",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 546,
"description": "Handles
activeItemChange events.",
"itemtype": "method",
"name": "_afterActiveItemChange",
"params": [
{
"name": "e",
"description": "",
"type": "EventTarget"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 583,
"description": "Handles
alwaysShowListChange events.",
"itemtype": "method",
"name": "_afterAlwaysShowListChange",
"params": [
{
"name": "e",
"description": "",
"type": "EventTarget"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 594,
"description": "Handles
hoveredItemChange events.",
"itemtype": "method",
"name": "_afterHoveredItemChange",
"params": [
{
"name": "e",
"description": "",
"type": "EventTarget"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 614,
"description": "Handles list blur events.",
"itemtype": "method",
"name": "_afterListBlur",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 629,
"description": "Handles list focus events.",
"itemtype": "method",
"name": "_afterListFocus",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 639,
"description": "Handles `inputNode` blur events.",
"itemtype": "method",
"name": "_afterListInputBlur",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 659,
"description": "Handles `inputNode` focus events.",
"itemtype": "method",
"name": "_afterListInputFocus",
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 669,
"description": "Handles
mouseover events.",
"itemtype": "method",
"name": "_afterMouseOver",
"params": [
{
"name": "e",
"description": "",
"type": "EventTarget"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 686,
"description": "Handles
mouseout events.",
"itemtype": "method",
"name": "_afterMouseOut",
"params": [
{
"name": "e",
"description": "",
"type": "EventTarget"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 704,
"description": "Handles
resultsChange events.",
"itemtype": "method",
"name": "_afterResultsChange",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 719,
"description": "Handles
visibleChange events.",
"itemtype": "method",
"name": "_afterVisibleChange",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 730,
"description": "Delegated event handler for item
click events.",
"itemtype": "method",
"name": "_onItemClick",
"params": [
{
"name": "e",
"description": "",
"type": "EventTarget"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 746,
"description": "Default
select event handler.",
"itemtype": "method",
"name": "_defSelectFn",
"params": [
{
"name": "e",
"description": "",
"type": "EventTarget"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 764,
"description": "If
true, the first item in the list will be activated by\ndefault when the list is initially displayed and when results change.",
"itemtype": "attribute",
"name": "activateFirstItem",
"type": "Boolean",
"default": "false",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 776,
"description": "Item that's currently active, if any. When the user presses enter,\nthis is the item that will be selected.",
"itemtype": "attribute",
"name": "activeItem",
"type": "Node",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 788,
"description": "If
true, the list will remain visible even when there\nare no results to display.",
"itemtype": "attribute",
"name": "alwaysShowList",
"type": "Boolean",
"default": "false",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 800,
"description": "If
true, keyboard navigation will wrap around to the\nopposite end of the list when navigating past the first or last item.",
"itemtype": "attribute",
"name": "circular",
"type": "Boolean",
"default": "true",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 812,
"description": "Item currently being hovered over by the mouse, if any.",
"itemtype": "attribute",
"name": "hoveredItem",
"type": "Node|null",
"readonly": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 824,
"description": "Node that will contain result items.",
"itemtype": "attribute",
"name": "listNode",
"type": "Node|null",
"initonly": "",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 836,
"description": "If
true, the viewport will be scrolled to ensure that\nthe active list item is visible when necessary.",
"itemtype": "attribute",
"name": "scrollIntoView",
"type": "Boolean",
"default": "false",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 848,
"description": "Translatable strings used by the AutoCompleteList widget.",
"itemtype": "attribute",
"name": "strings",
"type": "Object",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-list.js",
"line": 860,
"description": "If
true, pressing the tab key while the list is visible\nwill select the active item, if any.",
"itemtype": "attribute",
"name": "tabSelect",
"type": "Boolean",
"default": "true",
"class": "AutoCompleteList",
"module": "autocomplete",
"submodule": "autocomplete-list"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 19,
"description": "Regular expression used to determine whether a String source is a YQL\nquery.",
"itemtype": "property",
"name": "_YQL_SOURCE_REGEX",
"type": "RegExp",
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 30,
"description": "Runs before AutoCompleteBase's
_createObjectSource() method\nand augments it to support additional object-based source types.",
"itemtype": "method",
"name": "_beforeCreateObjectSource",
"params": [
{
"name": "source",
"description": "",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 58,
"description": "Creates a DataSource-like object that uses
Y.io as a source.\nSee the
source attribute for more details.",
"itemtype": "method",
"name": "_createIOSource",
"params": [
{
"name": "source",
"description": "URL.",
"type": "String"
}
],
"return": {
"description": "DataSource-like object.",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 133,
"description": "Creates a DataSource-like object that uses the specified JSONPRequest\ninstance as a source. See the
source attribute for more\ndetails.",
"itemtype": "method",
"name": "_createJSONPSource",
"params": [
{
"name": "source",
"description": "URL string or JSONPRequest instance.",
"type": "JSONPRequest|String"
}
],
"return": {
"description": "DataSource-like object.",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 204,
"description": "Creates a DataSource-like object that uses the specified <select>\nnode as a source.",
"itemtype": "method",
"name": "_createSelectSource",
"params": [
{
"name": "source",
"description": "YUI Node instance wrapping a <select> node.",
"type": "Node"
}
],
"return": {
"description": "DataSource-like object.",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 238,
"description": "Creates a DataSource-like object that calls the specified URL or\nexecutes the specified YQL query for results. If the string starts\nwith \"select \", \"use \", or \"set \" (case-insensitive), it's assumed to be\na YQL query; otherwise, it's assumed to be a URL (which may be absolute\nor relative). URLs containing a \"{callback}\" placeholder are assumed to\nbe JSONP URLs; all others will use XHR. See the
source\nattribute for more details.",
"itemtype": "method",
"name": "_createStringSource",
"params": [
{
"name": "source",
"description": "URL or YQL query.",
"type": "String"
}
],
"return": {
"description": "DataSource-like object.",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 267,
"description": "Creates a DataSource-like object that uses the specified YQL query string\nto create a YQL-based source. See the
source attribute for\ndetails. If no
resultListLocator is defined, this method\nwill set a best-guess locator that might work for many typical YQL\nqueries.",
"itemtype": "method",
"name": "_createYQLSource",
"params": [
{
"name": "source",
"description": "YQL query.",
"type": "String"
}
],
"return": {
"description": "DataSource-like object.",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 357,
"description": "Default resultListLocator used when a string-based YQL source is set and\nthe implementer hasn't already specified one.",
"itemtype": "method",
"name": "_defaultYQLLocator",
"params": [
{
"name": "response",
"description": "YQL response object.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Array"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 389,
"description": "Returns a formatted XHR URL based on the specified base
url,\n
query, and the current
requestTemplate if any.",
"itemtype": "method",
"name": "_getXHRUrl",
"params": [
{
"name": "url",
"description": "Base URL.",
"type": "String"
},
{
"name": "request",
"description": "Request object containing `query` and `request`\n properties.",
"type": "Object"
}
],
"return": {
"description": "Formatted URL.",
"type": "String"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 415,
"description": "URL formatter passed to
JSONPRequest instances.",
"itemtype": "method",
"name": "_jsonpFormatter",
"params": [
{
"name": "url",
"description": "",
"type": "String"
},
{
"name": "proxy",
"description": "",
"type": "String"
},
{
"name": "query",
"description": "",
"type": "String"
}
],
"return": {
"description": "Formatted URL",
"type": "String"
},
"access": "protected",
"tagname": "",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 444,
"description": "YQL environment file URL to load when the
source is set to\na YQL query. Set this to
null to use the default Open Data\nTables environment file (http://datatables.org/alltables.env).",
"itemtype": "attribute",
"name": "yqlEnv",
"type": "String",
"default": "null",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/autocomplete/js/autocomplete-sources.js",
"line": 458,
"description": "URL protocol to use when the
source is set to a YQL query.",
"itemtype": "attribute",
"name": "yqlProtocol",
"type": "String",
"default": "'http'",
"class": "AutoCompleteBase",
"module": "autocomplete",
"submodule": "autocomplete-sources"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 99,
"description": "The string used to identify the class of this object.",
"deprecated": true,
"deprecationMessage": "Use this.constructor.NAME",
"itemtype": "property",
"name": "name",
"type": "String",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 112,
"description": "The list of properties which can be configured for \neach attribute (e.g. setter, getter, writeOnce, readOnly etc.)",
"itemtype": "property",
"name": "_ATTR_CFG",
"type": "Array",
"static": 1,
"access": "private",
"tagname": "",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 124,
"description": "
\nThe string to be used to identify instances of \nthis class, for example in prefixing events.\n
\n
\nClasses extending Base, should define their own\nstatic NAME property, which should be camelCase by\nconvention (e.g. MyClass.NAME = \"myClass\";).\n
",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 140,
"description": "The default set of attributes which will be available for instances of this class, and \ntheir configuration. In addition to the configuration properties listed by \nAttribute's
addAttr method, the attribute \ncan also be configured with a \"cloneDefaultValue\" property, which defines how the statically\ndefined value field should be protected (\"shallow\", \"deep\" and false are supported values). \n\nBy default if the value is an object literal or an array it will be \"shallow\" cloned, to \nprotect the default value.",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 155,
"description": "Flag indicating whether or not this object\nhas been through the init lifecycle phase.",
"itemtype": "attribute",
"name": "initialized",
"readonly": "",
"default": "false",
"type": "boolean",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 169,
"description": "Flag indicating whether or not this object\nhas been through the destroy lifecycle phase.",
"itemtype": "attribute",
"name": "destroyed",
"readonly": "",
"default": "false",
"type": "boolean",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 186,
"description": "Init lifecycle method, invoked during construction.\nFires the init event prior to setting up attributes and \ninvoking initializers for the class hierarchy.",
"itemtype": "method",
"name": "init",
"chainable": 1,
"params": [
{
"name": "config",
"description": "Object with configuration property name/value pairs",
"type": "Object"
}
],
"return": {
"description": "A reference to this object",
"type": "Base"
},
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 201,
"description": "
\nLifecycle event for the init phase, fired prior to initialization. \nInvoking the preventDefault() method on the event object provided \nto subscribers will prevent initialization from occuring.\n
\n
\nSubscribers to the \"after\" momemt of this event, will be notified\nafter initialization of the object is complete (and therefore\ncannot prevent initialization).\n
",
"itemtype": "event",
"name": "init",
"preventable": "_defInitFn",
"params": [
{
"name": "e",
"description": "Event object, with a cfg property which \nrefers to the configuration object passed to the constructor.",
"type": "EventFacade"
}
],
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 232,
"description": "Handles the special on, after and target properties which allow the user to\neasily configure on and after listeners as well as bubble targets during \nconstruction, prior to init.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_preInitEventCfg",
"params": [
{
"name": "config",
"description": "The user configuration object",
"type": "Object"
}
],
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 266,
"description": "
\nDestroy lifecycle method. Fires the destroy\nevent, prior to invoking destructors for the\nclass hierarchy.\n
\n
\nSubscribers to the destroy\nevent can invoke preventDefault on the event object, to prevent destruction\nfrom proceeding.\n
",
"itemtype": "method",
"name": "destroy",
"return": {
"description": "A reference to this object",
"type": "Base"
},
"chainable": 1,
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 284,
"description": "
\nLifecycle event for the destroy phase, \nfired prior to destruction. Invoking the preventDefault \nmethod on the event object provided to subscribers will \nprevent destruction from proceeding.\n
\n
\nSubscribers to the \"after\" moment of this event, will be notified\nafter destruction is complete (and as a result cannot prevent\ndestruction).\n
",
"itemtype": "event",
"name": "destroy",
"preventable": "_defDestroyFn",
"params": [
{
"name": "e",
"description": "Event object",
"type": "EventFacade"
}
],
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 312,
"description": "Default init event handler",
"itemtype": "method",
"name": "_defInitFn",
"params": [
{
"name": "e",
"description": "Event object, with a cfg property which \nrefers to the configuration object passed to the constructor.",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 329,
"description": "Default destroy event handler",
"itemtype": "method",
"name": "_defDestroyFn",
"params": [
{
"name": "e",
"description": "Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 344,
"description": "Returns the class hierarchy for this object, with Base being the last class in the array.",
"itemtype": "method",
"name": "_getClasses",
"access": "protected",
"tagname": "",
"return": {
"description": "An array of classes (constructor functions), making up the class hierarchy for this object.\nThis value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the \ncached value.",
"type": "Function[]"
},
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 360,
"description": "Returns an aggregated set of attribute configurations, by traversing the class hierarchy.",
"itemtype": "method",
"name": "_getAttrCfgs",
"access": "protected",
"tagname": "",
"return": {
"description": "The hash of attribute configurations, aggregated across classes in the hierarchy\nThis value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return\nthe cached value.",
"type": "Object"
},
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 376,
"description": "A helper method used when processing ATTRS across the class hierarchy during \ninitialization. Returns a disposable object with the attributes defined for \nthe provided class, extracted from the set of all attributes passed in .",
"itemtype": "method",
"name": "_filterAttrCfs",
"access": "private",
"tagname": "",
"params": [
{
"name": "clazz",
"description": "The class for which the desired attributes are required.",
"type": "Function"
},
{
"name": "allCfgs",
"description": "The set of all attribute configurations for this instance. \nAttributes will be removed from this set, if they belong to the filtered class, so\nthat by the time all classes are processed, allCfgs will be empty.",
"type": "Object"
}
],
"return": {
"description": "The set of attributes belonging to the class passed in, in the form\nof an object with attribute name/configuration pairs.",
"type": "Object"
},
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 408,
"description": "A helper method used by _getClasses and _getAttrCfgs, which determines both\nthe array of classes and aggregate set of attribute configurations\nacross the class hierarchy for the instance.",
"itemtype": "method",
"name": "_initHierarchyData",
"access": "private",
"tagname": "",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 436,
"description": "A helper method, used by _initHierarchyData to aggregate \nattribute configuration across the instances class hierarchy.\n\nThe method will protect the attribute configuration value to protect the statically defined \ndefault value in ATTRS if required (if the value is an object literal, array or the \nattribute configuration has cloneDefaultValue set to shallow or deep).",
"itemtype": "method",
"name": "_aggregateAttrs",
"access": "private",
"tagname": "",
"params": [
{
"name": "allAttrs",
"description": "An array of ATTRS definitions across classes in the hierarchy \n(subclass first, Base last)",
"type": "Array"
}
],
"return": {
"description": "The aggregate set of ATTRS definitions for the instance",
"type": "Object"
},
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 511,
"description": "Initializes the class hierarchy for the instance, which includes \ninitializing attributes for each class defined in the class's \nstatic
ATTRS property and \ninvoking the initializer method on the prototype of each class in the hierarchy.",
"itemtype": "method",
"name": "_initHierarchy",
"params": [
{
"name": "userVals",
"description": "Object with configuration property name/value pairs",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 564,
"description": "Destroys the class hierarchy for this instance by invoking\nthe destructor method on the prototype of each class in the hierarchy.",
"itemtype": "method",
"name": "_destroyHierarchy",
"access": "private",
"tagname": "",
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/Base.js",
"line": 597,
"description": "Default toString implementation. Provides the constructor NAME\nand the instance guid, if set.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "String representation for this object",
"type": "String"
},
"class": "Base",
"module": "base",
"submodule": "base-base"
},
{
"file": "lib/yui3/src/base/js/BaseBuild.js",
"line": 208,
"description": "
\nBuilds a custom constructor function (class) from the\nmain function, and array of extension functions (classes)\nprovided. The NAME field for the constructor function is \ndefined by the first argument passed in.\n
\n
\nThe cfg object supports the following properties\n
\n
\n - dynamic <boolean>
\n - \n
If true (default), a completely new class\n is created which extends the main class, and acts as the \n host on which the extension classes are augmented.
\n If false, the extensions classes are augmented directly to\n the main class, modifying the main class' prototype.
\n \n - aggregates <String[]>
\n - An array of static property names, which will get aggregated\n on to the built class, in addition to the default properties build \n will always aggregate as defined by the main class' static _buildCfg\n property.\n
\n
",
"itemtype": "method",
"name": "build",
"deprecated": true,
"deprecationMessage": "Use the more convenient Base.create and Base.mix methods instead",
"static": 1,
"params": [
{
"name": "name",
"description": "The name of the new class. Used to defined the NAME property for the new class.",
"type": "Function"
},
{
"name": "main",
"description": "The main class on which to base the built class",
"type": "Function"
},
{
"name": "extensions",
"description": "The set of extension classes which will be\naugmented/aggregated to the built class.",
"type": "Function[]"
},
{
"name": "cfg",
"description": "Optional. Build configuration for the class (see description).",
"type": "Object"
}
],
"return": {
"description": "A custom class, created from the provided main and extension classes",
"type": "Function"
},
"class": "Base",
"module": "base",
"submodule": "base-build"
},
{
"file": "lib/yui3/src/base/js/BaseBuild.js",
"line": 249,
"description": "
Creates a new class (constructor function) which extends the base class passed in as the second argument, \nand mixes in the array of extensions provided.
\n
Prototype properties or methods can be added to the new class, using the px argument (similar to Y.extend).
\n
Static properties or methods can be added to the new class, using the sx argument (similar to Y.extend).
\n
\n\n
",
"itemtype": "method",
"name": "create",
"static": 1,
"params": [
{
"name": "name",
"description": "The name of the newly created class. Used to defined the NAME property for the new class.",
"type": "Function"
},
{
"name": "main",
"description": "The base class which the new class should extend. This class needs to be Base or a class derived from base (e.g. Widget).",
"type": "Function"
},
{
"name": "extensions",
"description": "The list of extensions which will be mixed into the built class.",
"type": "Function[]"
},
{
"name": "px",
"description": "The set of prototype properties/methods to add to the built class.",
"type": "Object"
},
{
"name": "sx",
"description": "The set of static properties/methods to add to the built class.",
"type": "Object"
}
],
"return": {
"description": "The newly created class.",
"type": "Function"
},
"class": "Base",
"module": "base",
"submodule": "base-build"
},
{
"file": "lib/yui3/src/base/js/BaseBuild.js",
"line": 270,
"description": "
Mixes in a list of extensions to an existing class.
",
"itemtype": "method",
"name": "mix",
"static": 1,
"params": [
{
"name": "main",
"description": "The existing class into which the extensions should be mixed. The class needs to be Base or a class derived from Base (e.g. Widget)",
"type": "Function"
},
{
"name": "extensions",
"description": "The set of extension classes which will mixed into the existing main class.",
"type": "Function[]"
}
],
"return": {
"description": "The modified main class, with extensions mixed in.",
"type": "Function"
},
"class": "Base",
"module": "base",
"submodule": "base-build"
},
{
"file": "lib/yui3/src/base/js/BaseBuild.js",
"line": 282,
"description": "The build configuration for the Base class.\n\nDefines the static fields which need to be aggregated\nwhen the Base class is used as the main class passed to\nthe
Base.build method.",
"itemtype": "property",
"name": "_buildCfg",
"type": "Object",
"static": 1,
"final": 1,
"access": "private",
"tagname": "",
"class": "Base",
"module": "base",
"submodule": "base-build"
},
{
"file": "lib/yui3/src/base/js/BasePluginHost.js",
"line": 15,
"description": "Alias for
Plugin.Host.plug. See aliased \nmethod for argument and return value details.",
"itemtype": "method",
"name": "plug",
"static": 1,
"class": "Base",
"module": "base",
"submodule": "base-pluginhost"
},
{
"file": "lib/yui3/src/base/js/BasePluginHost.js",
"line": 24,
"description": "Alias for
Plugin.Host.unplug. See the \naliased method for argument and return value details.",
"itemtype": "method",
"name": "unplug",
"static": 1,
"class": "Base",
"module": "base",
"submodule": "base-pluginhost"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 33,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"cache\"",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 52,
"itemtype": "attribute",
"name": "max",
"description": "Maximum number of entries the Cache can hold.\nSet to 0 to turn off caching.",
"type": "Number",
"default": "0",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 64,
"itemtype": "attribute",
"name": "size",
"description": "Number of entries currently cached.",
"type": "Number",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 74,
"itemtype": "attribute",
"name": "uniqueKeys",
"description": "Validate uniqueness of stored keys. Default is false and\nis more performant.",
"type": "Boolean",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 84,
"itemtype": "attribute",
"name": "expires",
"description": "Absolute Date when data expires or\nrelative number of milliseconds. Zero disables expiration.",
"type": "Date | Number",
"default": "0",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 98,
"itemtype": "attribute",
"name": "entries",
"description": "Cached entries.",
"type": "Array",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 117,
"description": "Array of request/response objects indexed chronologically.",
"itemtype": "property",
"name": "_entries",
"type": "Object[]",
"access": "private",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 132,
"itemtype": "method",
"name": "initializer",
"description": "Internal init() handler.",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 140,
"itemtype": "event",
"name": "add",
"description": "Fired when an entry is added.",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- entry (Object)
- The cached entry.
\n
",
"type": "Event.Facade"
}
],
"preventable": "_defAddFn",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 151,
"itemtype": "event",
"name": "flush",
"description": "Fired when the cache is flushed.",
"params": [
{
"name": "e",
"description": "Event Facade object.",
"type": "Event.Facade"
}
],
"preventable": "_defFlushFn",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 159,
"itemtype": "event",
"name": "request",
"description": "Fired when an entry is requested from the cache.",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- request (Object)
- The request object.
\n
",
"type": "Event.Facade"
}
],
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 168,
"itemtype": "event",
"name": "retrieve",
"description": "Fired when an entry is retrieved from the cache.",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- entry (Object)
- The retrieved entry.
\n
",
"type": "Event.Facade"
}
],
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 182,
"itemtype": "method",
"name": "destructor",
"description": "Internal destroy() handler.",
"access": "private",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 198,
"description": "Sets max.",
"itemtype": "method",
"name": "_setMax",
"access": "protected",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 221,
"description": "Gets size.",
"itemtype": "method",
"name": "_getSize",
"access": "protected",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 231,
"description": "Gets all entries.",
"itemtype": "method",
"name": "_getEntries",
"access": "protected",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 242,
"description": "Adds entry to cache.",
"itemtype": "method",
"name": "_defAddFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- entry (Object)
- The cached entry.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 272,
"description": "Flushes cache.",
"itemtype": "method",
"name": "_defFlushFn",
"params": [
{
"name": "e",
"description": "Event Facade object.",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 301,
"description": "Default overridable method compares current request with given cache entry.\nReturns true if current request matches the cached request, otherwise\nfalse. Implementers should override this method to customize the\ncache-matching algorithm.",
"itemtype": "method",
"name": "_isMatch",
"params": [
{
"name": "request",
"description": "Request object.",
"type": "Object"
},
{
"name": "entry",
"description": "Cached entry.",
"type": "Object"
}
],
"return": {
"description": "True if current request matches given cached request, false otherwise.",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 320,
"description": "Returns position of a request in the entries array, otherwise null.",
"itemtype": "method",
"name": "_position",
"params": [
{
"name": "request",
"description": "Request object.",
"type": "Object"
}
],
"return": {
"description": "Array position if found, null otherwise.",
"type": "Number"
},
"access": "protected",
"tagname": "",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 353,
"description": "Adds a new entry to the cache of the format\n{request:request, response:response, cached:cached, expires:expires}.\nIf cache is full, evicts the stalest entry before adding the new one.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "request",
"description": "Request value.",
"type": "Object"
},
{
"name": "response",
"description": "Response value.",
"type": "Object"
}
],
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 379,
"description": "Flushes cache.",
"itemtype": "method",
"name": "flush",
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-base.js",
"line": 388,
"description": "Retrieves cached object for given request, if available, and refreshes\nentry in the cache. Returns null if there is no cache match.",
"itemtype": "method",
"name": "retrieve",
"params": [
{
"name": "request",
"description": "Request object.",
"type": "Object"
}
],
"return": {
"description": "Cached object with the properties request and response, or null.",
"type": "Object"
},
"class": "Cache",
"module": "cache",
"submodule": "cache-base"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 35,
"itemtype": "event",
"name": "error",
"description": "Fired when an entry could not be added, most likely due to\nexceeded browser quota.\n
\n- error (Object)
- The error object.
\n
",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 50,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"cacheOffline\"",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 68,
"itemtype": "attribute",
"name": "sandbox",
"description": "A string that must be passed in via the constructor.\nThis identifier is used to sandbox one cache instance's entries\nfrom another. Calling the cache instance's flush and length methods\nor get(\"entries\") will apply to only these sandboxed entries.",
"type": "String",
"default": "\"default\"",
"initonly": "",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 83,
"itemtype": "attribute",
"name": "expires",
"description": "Absolute Date when data expires or\nrelative number of milliseconds. Zero disables expiration.",
"type": "Date | Number",
"default": "86400000 (one day)",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 94,
"itemtype": "attribute",
"name": "max",
"description": "Disabled.",
"readonly": "",
"default": "null",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 105,
"itemtype": "attribute",
"name": "uniqueKeys",
"description": "Always true for CacheOffline.",
"readonly": "",
"default": "true",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 120,
"description": "Removes all items from all sandboxes. Useful if localStorage has\nexceeded quota. Only supported on browsers that implement HTML 5\nlocalStorage.",
"itemtype": "method",
"name": "flushAll",
"static": 1,
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 163,
"description": "Always return null.",
"itemtype": "method",
"name": "_setMax",
"access": "protected",
"tagname": "",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 173,
"description": "Gets size.",
"itemtype": "method",
"name": "_getSize",
"access": "protected",
"tagname": "",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 192,
"description": "Gets all entries.",
"itemtype": "method",
"name": "_getEntries",
"access": "protected",
"tagname": "",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 212,
"description": "Adds entry to cache.",
"itemtype": "method",
"name": "_defAddFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- entry (Object)
- The cached entry.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 243,
"description": "Flushes cache.",
"itemtype": "method",
"name": "_defFlushFn",
"params": [
{
"name": "e",
"description": "Event Facade object.",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 267,
"description": "Adds a new entry to the cache of the format\n{request:request, response:response, cached:cached, expires: expires}.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "request",
"description": "Request value must be a String or JSON.",
"type": "Object"
},
{
"name": "response",
"description": "Response value must be a String or JSON.",
"type": "Object"
}
],
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 276,
"description": "Retrieves cached object for given request, if available.\nReturns null if there is no cache match.",
"itemtype": "method",
"name": "retrieve",
"params": [
{
"name": "request",
"description": "Request object.",
"type": "Object"
}
],
"return": {
"description": "Cached object with the properties request, response,\nand expires, or null.",
"type": "Object"
},
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-offline.js",
"line": 324,
"description": "Always return null.",
"itemtype": "method",
"name": "_setMax",
"access": "protected",
"tagname": "",
"class": "CacheOffline",
"module": "cache",
"submodule": "cache-offline"
},
{
"file": "lib/yui3/src/cache/js/cache-plugin.js",
"line": 23,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"cache\"",
"class": "Plugin.Cache",
"module": "cache",
"submodule": "cache-plugin"
},
{
"file": "lib/yui3/src/cache/js/cache-plugin.js",
"line": 35,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceCache\"",
"class": "Plugin.Cache",
"module": "cache",
"submodule": "cache-plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 60,
"description": "A storage for various properties of individual month\npanes.",
"itemtype": "property",
"name": "_paneProperties",
"type": "Object",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 70,
"description": "The number of month panes in the calendar, deduced\nfrom the CONTENT_TEMPLATE's number of {calendar_grid}\ntokens.",
"itemtype": "property",
"name": "_paneNumber",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 81,
"description": "The unique id used to prefix various elements of this\ncalendar instance.",
"itemtype": "property",
"name": "_calendarId",
"type": "String",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 91,
"description": "The hash map of selected dates, populated with\nselectDates() and deselectDates() methods",
"itemtype": "property",
"name": "_selectedDates",
"type": "Object",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 101,
"description": "A private copy of the rules object, populated\nby setting the customRenderer attribute.",
"itemtype": "property",
"name": "_rules",
"type": "Object",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 111,
"description": "A private copy of the filterFunction, populated\nby setting the customRenderer attribute.",
"itemtype": "property",
"name": "_filterFunction",
"type": "Function",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 121,
"description": "Storage for calendar cells modified by any custom\nformatting. The storage is cleared, used to restore\ncells to the original state, and repopulated accordingly\nwhen the calendar is rerendered.",
"itemtype": "property",
"name": "_storedDateCells",
"type": "Object",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 133,
"description": "Designated initializer\nInitializes instance-level properties of\ncalendar.",
"itemtype": "method",
"name": "initializer",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 148,
"description": "renderUI implementation\n\nCreates a visual representation of the calendar based on existing parameters.",
"itemtype": "method",
"name": "renderUI",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 166,
"description": "bindUI implementation\n\nAssigns listeners to relevant events that change the state\nof the calendar.",
"itemtype": "method",
"name": "bindUI",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 182,
"description": "syncUI implementation\n\nUpdate the scroll position, based on the current value of scrollY",
"itemtype": "method",
"name": "syncUI",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 199,
"description": "An internal utility method that generates a list of selected dates \nfrom the hash storage.",
"itemtype": "method",
"name": "_getSelectedDatesList",
"access": "protected",
"tagname": "",
"return": {
"description": "The array of `Date`s that are currently selected.",
"type": "Array"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 219,
"description": "A utility method that returns all dates selected in a specific month.",
"itemtype": "method",
"name": "_getSelectedDatesInMonth",
"params": [
{
"name": "oDate",
"description": "corresponding to the month for which selected dates\nare requested.",
"type": "Date"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "The array of `Date`s in a given month that are currently selected.",
"type": "Array"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 240,
"description": "An internal rendering method that modifies a date cell to have the\nselected CSS class if the date cell is visible.",
"itemtype": "method",
"name": "_renderSelectedDate",
"params": [
{
"name": "oDate",
"description": "The date corresponding to a specific date cell.",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 254,
"description": "An internal rendering method that modifies a date cell to remove the\nselected CSS class if the date cell is visible.",
"itemtype": "method",
"name": "_renderUnelectedDate",
"params": [
{
"name": "oDate",
"description": "The date corresponding to a specific date cell.",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 268,
"description": "An internal utility method that checks whether a particular date\nis in the current view of the calendar.",
"itemtype": "method",
"name": "_isDateVisible",
"params": [
{
"name": "oDate",
"description": "The date corresponding to a specific date cell.",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"return": {
"description": "Returns true if the given date is in the current \nview of the calendar.",
"type": "Boolean"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 291,
"description": "An internal parsing method that receives a String list of numbers\nand number ranges (of the form \"1,2,3,4-6,7-9,10,11\" etc.) and checks\nwhether a specific number is included in this list. Used for looking\nup dates in the customRenderer rule set.",
"itemtype": "method",
"name": "_isNumInList",
"params": [
{
"name": "num",
"description": "The number to look for in a list.",
"type": "Number"
},
{
"name": "strList",
"description": "The list of numbers of the form \"1,2,3,4-6,7-8,9\", etc.",
"type": "String"
}
],
"access": "private",
"tagname": "",
"return": {
"description": "Returns true if the given number is in the given list.",
"type": "Boolean"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 323,
"description": "Given a specific date, returns an array of rules (from the customRenderer rule set)\nthat the given date matches.",
"itemtype": "method",
"name": "_getRulesForDate",
"params": [
{
"name": "oDate",
"description": "The date for which an array of rules is needed",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"return": {
"description": "Returns an array of `String`s, each containg the name of\na rule that the given date matches.",
"type": "Array"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 379,
"description": "A utility method which, given a specific date and a name of the rule,\nchecks whether the date matches the given rule.",
"itemtype": "method",
"name": "_matchesRule",
"params": [
{
"name": "oDate",
"description": "The date to check",
"type": "Date"
},
{
"name": "rule",
"description": "The name of the rule that the date should match.",
"type": "String"
}
],
"access": "private",
"tagname": "",
"return": {
"description": "Returns true if the date matches the given rule.",
"type": "Boolean"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 394,
"description": "A utility method which checks whether a given date matches the `enabledDatesRule`\nor does not match the `disabledDatesRule` and therefore whether it can be selected.",
"itemtype": "method",
"name": "_canBeSelected",
"params": [
{
"name": "oDate",
"description": "The date to check",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"return": {
"description": "Returns true if the date can be selected; false otherwise.",
"type": "Boolean"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 418,
"description": "Selects a given date or array of dates.",
"itemtype": "method",
"name": "selectDates",
"params": [
{
"name": "dates",
"description": "A `Date` or `Array` of `Date`s.",
"type": "Date|Array"
}
],
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 432,
"description": "Deselects a given date or array of dates, or deselects\nall dates if no argument is specified.",
"itemtype": "method",
"name": "deselectDates",
"params": [
{
"name": "dates",
"description": "A `Date` or `Array` of `Date`s, or no\nargument if all dates should be deselected.",
"type": "Date|Array",
"optional": true
}
],
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 451,
"description": "A utility method that adds a given date to selection..",
"itemtype": "method",
"name": "_addDateToSelection",
"params": [
{
"name": "oDate",
"description": "The date to add to selection.",
"type": "Date"
},
{
"name": "index",
"description": "An optional parameter that is used\nto differentiate between individual date selections and multiple\ndate selections.",
"type": "Number",
"optional": true
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 492,
"description": "A utility method that adds a given list of dates to selection.",
"itemtype": "method",
"name": "_addDatesToSelection",
"params": [
{
"name": "datesArray",
"description": "The list of dates to add to selection.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 503,
"description": "A utility method that adds a given range of dates to selection.",
"itemtype": "method",
"name": "_addDateRangeToSelection",
"params": [
{
"name": "startDate",
"description": "The first date of the given range.",
"type": "Date"
},
{
"name": "endDate",
"description": "The last date of the given range.",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 533,
"description": "A utility method that removes a given date from selection..",
"itemtype": "method",
"name": "_removeDateFromSelection",
"params": [
{
"name": "oDate",
"description": "The date to remove from selection.",
"type": "Date"
},
{
"name": "index",
"description": "An optional parameter that is used\nto differentiate between individual date selections and multiple\ndate selections.",
"type": "Number",
"optional": true
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 557,
"description": "A utility method that removes a given list of dates from selection.",
"itemtype": "method",
"name": "_removeDatesFromSelection",
"params": [
{
"name": "datesArray",
"description": "The list of dates to remove from selection.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 568,
"description": "A utility method that removes a given range of dates from selection.",
"itemtype": "method",
"name": "_removeDateRangeFromSelection",
"params": [
{
"name": "startDate",
"description": "The first date of the given range.",
"type": "Date"
},
{
"name": "endDate",
"description": "The last date of the given range.",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 586,
"description": "A utility method that removes all dates from selection.",
"itemtype": "method",
"name": "_clearSelection",
"params": [
{
"name": "noevent",
"description": "A Boolean specifying whether a selectionChange\nevent should be fired.",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 601,
"description": "A utility method that fires a selectionChange event.",
"itemtype": "method",
"name": "_fireSelectionChange",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 608,
"description": "Fired when the set of selected dates changes. Contains a payload with\na `newSelection` property with an array of selected dates.",
"itemtype": "event",
"name": "selectionChange",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 617,
"description": "A utility method that restores cells modified by custom formatting.",
"itemtype": "method",
"name": "_restoreModifiedCells",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 631,
"description": "A rendering assist method that renders all cells modified by the customRenderer\nrules, as well as the enabledDatesRule and disabledDatesRule.",
"itemtype": "method",
"name": "_renderCustomRules",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 668,
"description": "A rendering assist method that renders all cells that are currently selected.",
"itemtype": "method",
"name": "_renderSelectedDates",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 686,
"description": "A utility method that converts a date to the node wrapping the calendar cell\nthe date corresponds to..",
"itemtype": "method",
"name": "_dateToNode",
"params": [
{
"name": "oDate",
"description": "The date to convert to Node",
"type": "Date"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "The node wrapping the DOM element of the cell the date \ncorresponds to.",
"type": "Node"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 760,
"description": "A utility method that converts a node corresponding to the DOM element of\nthe cell for a particular date to that date.",
"itemtype": "method",
"name": "_nodeToDate",
"params": [
{
"name": "oNode",
"description": "The Node wrapping the DOM element of a particular date cell.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "The date corresponding to the DOM element that the given node wraps.",
"type": "Date"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 781,
"description": "A placeholder method, called from bindUI, to bind the Calendar events.",
"itemtype": "method",
"name": "_bindCalendarEvents",
"access": "protected",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 790,
"description": "A utility method that normalizes a given date by converting it to the 1st\nday of the month the date is in, with the time set to noon.",
"itemtype": "method",
"name": "_normalizeDate",
"params": [
{
"name": "oDate",
"description": "The date to normalize",
"type": "Date"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "The normalized date, set to the first of the month, with time\nset to noon.",
"type": "Date"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 804,
"description": "A render assist utility method that computes the cutoff column for the calendar \nrendering mask.",
"itemtype": "method",
"name": "_getCutoffColumn",
"params": [
{
"name": "date",
"description": "The date of the month grid to compute the cutoff column for.",
"type": "Date"
},
{
"name": "firstday",
"description": "The first day of the week (modified by internationalized calendars)",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"return": {
"description": "The number of the cutoff column.",
"type": "Number"
},
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 821,
"description": "A render assist method that turns on the view of the previous month's dates \nin a given calendar pane.",
"itemtype": "method",
"name": "_turnPrevMonthOn",
"params": [
{
"name": "pane",
"description": "The calendar pane that needs its previous month's dates view\nmodified.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 853,
"description": "A render assist method that turns off the view of the previous month's dates \nin a given calendar pane.",
"itemtype": "method",
"name": "_turnPrevMonthOff",
"params": [
{
"name": "pane",
"description": "The calendar pane that needs its previous month's dates view\nmodified.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 871,
"description": "A render assist method that cleans up the last few cells in the month grid\nwhen the number of days in the month changes.",
"itemtype": "method",
"name": "_cleanUpNextMonthCells",
"params": [
{
"name": "pane",
"description": "The calendar pane that needs the last date cells cleaned up.",
"type": "Node"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 887,
"description": "A render assist method that turns on the view of the next month's dates \nin a given calendar pane.",
"itemtype": "method",
"name": "_turnNextMonthOn",
"params": [
{
"name": "pane",
"description": "The calendar pane that needs its next month's dates view\nmodified.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 919,
"description": "A render assist method that turns off the view of the next month's dates \nin a given calendar pane.",
"itemtype": "method",
"name": "_turnNextMonthOff",
"params": [
{
"name": "pane",
"description": "The calendar pane that needs its next month's dates view\nmodified.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 950,
"description": "The handler for the change in the showNextMonth attribute.",
"itemtype": "method",
"name": "_afterShowNextMonthChange",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 972,
"description": "The handler for the change in the showPrevMonth attribute.",
"itemtype": "method",
"name": "_afterShowPrevMonthChange",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 991,
"description": "The handler for the change in the headerRenderer attribute.",
"itemtype": "method",
"name": "_afterHeaderRendererChange",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1001,
"description": "The handler for the change in the customRenderer attribute.",
"itemtype": "method",
"name": "_afterCustomRendererChange",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1010,
"description": "The handler for the change in the date attribute. Modifies the calendar\nview by shifting the calendar grid mask and running custom rendering and\nselection rendering as necessary.",
"itemtype": "method",
"name": "_afterDateChange",
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1045,
"description": "A rendering assist method that initializes the HTML for a single\ncalendar pane.",
"itemtype": "method",
"name": "_initCalendarPane",
"params": [
{
"name": "baseDate",
"description": "The date corresponding to the month of the given\ncalendar pane.",
"type": "Date"
},
{
"name": "pane_id",
"description": "The id of the pane, to be used as a prefix for\nelement ids in the given pane.",
"type": "String"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1146,
"description": "A rendering assist method that rerenders a specified calendar pane, based\non a new Date.",
"itemtype": "method",
"name": "_rerenderCalendarPane",
"params": [
{
"name": "newDate",
"description": "The date corresponding to the month of the given\ncalendar pane.",
"type": "Date"
},
{
"name": "pane",
"description": "The node corresponding to the calendar pane to be rerenders.",
"type": "Node"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1249,
"description": "A rendering assist method that updates the calendar header based\non a given date and potentially the provided headerRenderer.",
"itemtype": "method",
"name": "_updateCalendarHeader",
"params": [
{
"name": "baseDate",
"description": "The date with which to update the calendar header.",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1270,
"description": "A rendering assist method that initializes the calendar header HTML \nbased on a given date and potentially the provided headerRenderer.",
"itemtype": "method",
"name": "_updateCalendarHeader",
"params": [
{
"name": "baseDate",
"description": "The date with which to initialize the calendar header.",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1283,
"description": "A rendering assist method that initializes the calendar HTML \nbased on a given date.",
"itemtype": "method",
"name": "_initCalendarHTML",
"params": [
{
"name": "baseDate",
"description": "The date with which to initialize the calendar.",
"type": "Date"
}
],
"access": "private",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1319,
"description": "The CSS classnames for the calendar templates.",
"itemtype": "property",
"name": "CALENDAR_STRINGS",
"type": "Object",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1342,
"description": "The main content template for calendar.",
"itemtype": "property",
"name": "CONTENT_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1356,
"description": "A single pane template for calendar (same as default CONTENT_TEMPLATE)",
"itemtype": "property",
"name": "ONE_PANE_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"readonly": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1371,
"description": "A two pane template for calendar.",
"itemtype": "property",
"name": "TWO_PANE_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"readonly": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1392,
"description": "A three pane template for calendar.",
"itemtype": "property",
"name": "THREE_PANE_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"readonly": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1416,
"description": "A template for the calendar grid.",
"itemtype": "property",
"name": "CALENDAR_GRID_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1432,
"description": "A template for the calendar header.",
"itemtype": "property",
"name": "HEADER_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1447,
"description": "A template for the row of weekday names.",
"itemtype": "property",
"name": "WEEKDAY_ROW_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1458,
"description": "A template for a single row of calendar days.",
"itemtype": "property",
"name": "CALDAY_ROW_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1469,
"description": "A template for a single cell with a weekday name.",
"itemtype": "property",
"name": "CALDAY_ROW_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1478,
"description": "A template for a single cell with a calendar day.",
"itemtype": "property",
"name": "CALDAY_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1489,
"description": "The identity of the widget.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"default": "'calendarBase'",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1501,
"description": "Static property used to define the default attribute configuration of\nthe Widget.",
"itemtype": "property",
"name": "ATTRS",
"type": "{Object}",
"access": "protected",
"tagname": "",
"static": 1,
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1511,
"description": "The date corresponding to the current calendar view. Always\nnormalized to the first of the month that contains the date\nat assignment time. Used as the first date visible in the\ncalendar.",
"itemtype": "attribute",
"name": "date",
"type": "Date",
"default": "The first of the month containing today's date, as\nset on the end user's system.",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1532,
"description": "A setting specifying whether to shows days from the previous\nmonth in the visible month's grid, if there are empty preceding\ncells available.",
"itemtype": "attribute",
"name": "showPrevMonth",
"type": "boolean",
"default": "false",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1545,
"description": "A setting specifying whether to shows days from the next\nmonth in the visible month's grid, if there are empty\ncells available at the end.",
"itemtype": "attribute",
"name": "showNextMonth",
"type": "boolean",
"default": "false",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1558,
"description": "Strings and properties derived from the internationalization packages\nfor the calendar.",
"itemtype": "attribute",
"name": "strings",
"type": "Object",
"access": "protected",
"tagname": "",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1570,
"description": "Custom header renderer for the calendar.",
"itemtype": "attribute",
"name": "headerRenderer",
"type": "String | Function",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1580,
"description": "The name of the rule which all enabled dates should match.\nEither disabledDatesRule or enabledDatesRule should be specified,\nor neither, but not both.",
"itemtype": "attribute",
"name": "enabledDatesRule",
"type": "String",
"default": "null",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1593,
"description": "The name of the rule which all disabled dates should match.\nEither disabledDatesRule or enabledDatesRule should be specified,\nor neither, but not both.",
"itemtype": "attribute",
"name": "disabledDatesRule",
"type": "String",
"default": "null",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1606,
"description": "A read-only attribute providing a list of currently selected dates.",
"itemtype": "attribute",
"name": "selectedDates",
"readonly": "",
"type": "Array",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar-base.js",
"line": 1620,
"description": "An object of the form {rules:Object, filterFunction:Function},\nproviding set of rules and a custom rendering function for \ncustomizing specific calendar cells.",
"itemtype": "attribute",
"name": "customRenderer",
"readonly": "",
"type": "Object",
"default": "{}",
"class": "CalendarBase",
"module": "calendar",
"submodule": "calendar-base"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 39,
"description": "A property tracking the last selected date on the calendar, for the\npurposes of multiple selection.",
"itemtype": "property",
"name": "_lastSelectedDate",
"type": "Date",
"default": "null",
"access": "private",
"tagname": "",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 50,
"description": "Designated initializer. Activates the navigation plugin for the calendar.",
"itemtype": "method",
"name": "initializer",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 59,
"description": "syncUI implementation\n\nUpdate the scroll position, based on the current value of scrollY",
"itemtype": "method",
"name": "syncUI",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 69,
"description": "Overrides the _bindCalendarEvents placeholder in CalendarBase\nand binds calendar events during bindUI stage.",
"itemtype": "method",
"name": "_bindCalendarEvents",
"access": "protected",
"tagname": "",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 82,
"description": "Handles the calendar clicks based on selection mode.",
"itemtype": "method",
"name": "_clickCalendar",
"params": [
{
"name": "ev",
"description": "A click event",
"type": "Event"
}
],
"access": "private",
"tagname": "",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 158,
"description": "Fired when a specific date cell in the calendar is clicked. The event carries a \npayload which includes a `cell` property corresponding to the node of the actual\ndate cell, and a `date` property, with the `Date` that was clicked.",
"itemtype": "event",
"name": "dateClick",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 168,
"description": "Fired when any of the previous month's days displayed before the calendar grid\nare clicked.",
"itemtype": "event",
"name": "prevMonthClick",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 177,
"description": "Fired when any of the next month's days displayed after the calendar grid\nare clicked.",
"itemtype": "event",
"name": "nextMonthClick",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 187,
"description": "Subtracts one month from the current calendar view.",
"itemtype": "method",
"name": "subtractMonth",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 196,
"description": "Subtracts one year from the current calendar view.",
"itemtype": "method",
"name": "subtractYear",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 205,
"description": "Adds one month to the current calendar view.",
"itemtype": "method",
"name": "addMonth",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 214,
"description": "Adds one year to the current calendar view.",
"itemtype": "method",
"name": "addYear",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 225,
"description": "The identity of the widget.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"default": "'Calendar'",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 237,
"description": "Static property used to define the default attribute configuration of\nthe Widget.",
"itemtype": "property",
"name": "ATTRS",
"type": "{Object}",
"access": "protected",
"tagname": "",
"static": 1,
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 248,
"description": "A setting specifying the type of selection the calendar allows.\nPossible values include:\n
\n - `single`
- One date at a time\n - `multiple-sticky
- Multiple dates, selected one at a time (the dates \"stick\")\n - `multiple`
- Multiple dates, selected with Ctrl/Meta keys for additional single\n dates, and Shift key for date ranges.",
"itemtype": "attribute",
"name": "selectionMode",
"type": "String",
"default": "single",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 265,
"description": "The date corresponding to the current calendar view. Always\nnormalized to the first of the month that contains the date\nat assignment time. Used as the first date visible in the\ncalendar.",
"itemtype": "attribute",
"name": "date",
"type": "Date",
"default": "Today's date as set on the user's computer.",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 300,
"description": "The minimum date that can be displayed by the calendar. The calendar will not\nallow dates earlier than this one to be set, and will reset any earlier date to\nthis date. Should be `null` if no minimum date is needed.",
"itemtype": "attribute",
"name": "minimumDate",
"type": "Date",
"default": "null",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendar.js",
"line": 326,
"description": "The maximum date that can be displayed by the calendar. The calendar will not\nallow dates later than this one to be set, and will reset any later date to\nthis date. Should be `null` if no maximum date is needed.",
"itemtype": "attribute",
"name": "maximumDate",
"type": "Date",
"default": "null",
"class": "Calendar",
"module": "calendar"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 30,
"description": "The namespace for the plugin. This will be the property on the widget, which will \nreference the plugin instance, when it's plugged in.",
"itemtype": "property",
"name": "NS",
"static": 1,
"type": "String",
"default": "\"navigator\"",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 41,
"description": "The NAME of the CalendarNavigator class. Used to prefix events generated\nby the plugin class.",
"itemtype": "property",
"name": "NAME",
"static": 1,
"type": "String",
"default": "\"pluginCalendarNavigator\"",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 53,
"description": "Static property used to define the default attribute \nconfiguration for the plugin.",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 63,
"description": "The number of months to shift by when the control arrows are clicked.",
"itemtype": "attribute",
"name": "shiftByMonths",
"type": "Number",
"default": "1 (months)",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 75,
"description": "The CSS classnames for the calendar navigator controls.",
"itemtype": "property",
"name": "CALENDARNAV_STRINGS",
"type": "Object",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 88,
"description": "The template for the calendar navigator previous month control.",
"itemtype": "property",
"name": "PREV_MONTH_CONTROL_TEMPLATE",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 98,
"description": "The template for the calendar navigator next month control.",
"itemtype": "property",
"name": "NEXT_MONTH_CONTROL_TEMPLATE",
"type": "String",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 113,
"description": "The initializer lifecycle implementation. Modifies the host widget's \nrender to add navigation controls.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "The user configuration for the plugin",
"type": "Object"
}
],
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 126,
"description": "The initializer destructor implementation. Responsible for destroying the initialized\ncontrol mechanisms.",
"itemtype": "method",
"name": "destructor",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 136,
"description": "Private utility method that subtracts months from the host calendar date\nbased on the control click and the shiftByMonths property.",
"itemtype": "method",
"name": "_subtractMonths",
"params": [
{
"name": "ev",
"description": "Click event from the controls",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 151,
"description": "Private utility method that adds months to the host calendar date\nbased on the control click and the shiftByMonths property.",
"itemtype": "method",
"name": "_addMonths",
"params": [
{
"name": "ev",
"description": "Click event from the controls",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 166,
"description": "Private render assist method that renders the previous month control",
"itemtype": "method",
"name": "_renderPrevControls",
"access": "private",
"tagname": "",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 181,
"description": "Private render assist method that renders the next month control",
"itemtype": "method",
"name": "_renderNextControls",
"access": "private",
"tagname": "",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/calendar/js/calendarnavigator.js",
"line": 196,
"description": "Protected render assist method that initialized and renders the navigation controls.",
"itemtype": "method",
"name": "_initNavigationControls",
"access": "protected",
"tagname": "",
"class": "Plugin.CalendarNavigator",
"module": "calendarnavigator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/charts/js/AreaSeries.js",
"line": 12,
"access": "protected",
"tagname": "Renders the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "AreaSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AreaSeries.js",
"line": 24,
"access": "protected",
"tagname": "Method used by `styles` setter. Overrides base implementation.",
"itemtype": "method",
"name": "_setStyles",
"params": [
{
"name": "newStyles",
"description": "Hash of properties to update.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"class": "AreaSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AreaSeries.js",
"line": 42,
"access": "protected",
"tagname": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"class": "AreaSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AreaSeries.js",
"line": 59,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "area",
"class": "AreaSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AreaSeries.js",
"line": 70,
"description": "Style properties used for drawing area fills. This attribute is inherited from `Renderer`. Below are the default values:\n\n \n - color
- The color of the fill. The default value is determined by the order of the series on the graph. The color will be \n retrieved from the following array:\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n
\n - alpha
- Number between 0 and 1 that indicates the opacity of the fill. The default value is 1
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "AreaSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AreaSplineSeries.js",
"line": 12,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "AreaSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AreaSplineSeries.js",
"line": 25,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "areaSpline",
"class": "AreaSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AreaSplineSeries.js",
"line": 36,
"description": "Style properties used for drawing area fills. This attribute is inherited from `Renderer`. Below are the default values:\n\n \n - color
- The color of the fill. The default value is determined by the order of the series on the graph. The color will be \n retrieved from the following array:\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n
\n - alpha
- Number between 0 and 1 that indicates the opacity of the fill. The default value is 1
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "AreaSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 12,
"description": "Handles change to the dataProvider",
"itemtype": "method",
"name": "_dataChangeHandler",
"params": [
{
"name": "e",
"description": "Event object",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 27,
"description": "Handles changes to axis.",
"itemtype": "method",
"name": "_updateHandler",
"params": [
{
"name": "e",
"description": "Event object",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 42,
"itemtype": "method",
"name": "renderUI",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 60,
"itemtype": "method",
"name": "syncUI",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 91,
"description": "Creates a graphic instance to be used for the axis line and ticks.",
"itemtype": "method",
"name": "_setCanvas",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 124,
"description": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 192,
"description": "Updates the axis when the size changes.",
"itemtype": "method",
"name": "_handleSizeChange",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 214,
"description": "Maps key values to classes containing layout algorithms",
"itemtype": "property",
"name": "_layoutClasses",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 229,
"description": "Draws a line segment between 2 points",
"itemtype": "method",
"name": "drawLine",
"params": [
{
"name": "startPoint",
"description": "x and y coordinates for the start point of the line segment",
"type": "Object"
},
{
"name": "endPoint",
"description": "x and y coordinates for the for the end point of the line segment",
"type": "Object"
},
{
"name": "line",
"description": "styles (weight, color and alpha to be applied to the line segment)",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 244,
"description": "Generates the properties necessary for rotating and positioning a text field.",
"itemtype": "method",
"name": "_getTextRotationProps",
"params": [
{
"name": "styles",
"description": "properties for the text field",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 292,
"description": "Draws an axis.",
"itemtype": "method",
"name": "_drawAxis",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 402,
"description": "Updates path.",
"itemtype": "method",
"name": "_updatePathElement",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 430,
"description": "Updates the content and style properties for a title field.",
"itemtype": "method",
"name": "_updateTitle",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 483,
"description": "Creates or updates an axis label.",
"itemtype": "method",
"name": "getLabel",
"params": [
{
"name": "pt",
"description": "x and y coordinates for the label",
"type": "Object"
},
{
"name": "styles",
"description": "styles applied to label",
"type": "Object"
}
],
"return": {
"description": "HTMLElement"
},
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 528,
"description": "Creates a cache of labels that can be re-used when the axis redraws.",
"itemtype": "method",
"name": "_createLabelCache",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 554,
"description": "Removes axis labels from the dom and clears the label cache.",
"itemtype": "method",
"name": "_clearLabelCache",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 577,
"description": "Gets the end point of an axis.",
"itemtype": "method",
"name": "getLineEnd",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 599,
"description": "Calcuates the width or height of an axis depending on its direction.",
"itemtype": "method",
"name": "getLength",
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 625,
"description": "Gets the position of the first point on an axis.",
"itemtype": "method",
"name": "getFirstPoint",
"params": [
{
"name": "pt",
"description": "Object containing x and y coordinates.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 650,
"description": "Gets the position of the next point on an axis.",
"itemtype": "method",
"name": "getNextPoint",
"params": [
{
"name": "point",
"description": "Object containing x and y coordinates.",
"type": "Object"
},
{
"name": "majorUnitDistance",
"description": "Distance in pixels between ticks.",
"type": "Number"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 673,
"description": "Calculates the placement of last tick on an axis.",
"itemtype": "method",
"name": "getLastPoint",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 696,
"description": "Calculates position on the axis.",
"itemtype": "method",
"name": "getPosition",
"params": [
{
"name": "point",
"description": "contains x and y values",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 731,
"description": "Rotates and positions a text field.",
"itemtype": "method",
"name": "_rotate",
"params": [
{
"name": "label",
"description": "text field to rotate and position",
"type": "HTMLElement"
},
{
"name": "props",
"description": "properties to be applied to the text field.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 801,
"description": "Difference betweend the first/last tick and edge of axis.",
"itemtype": "attribute",
"name": "edgeOffset",
"type": "Number",
"access": "protected",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 813,
"description": "The graphic in which the axis line and ticks will be rendered.",
"itemtype": "attribute",
"name": "graphic",
"type": "Graphic",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 821,
"itemtype": "attribute",
"name": "path",
"type": "Shape",
"readonly": "",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 844,
"itemtype": "attribute",
"name": "tickPath",
"type": "Shape",
"readonly": "",
"access": "private",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 867,
"description": "Contains the contents of the axis.",
"itemtype": "attribute",
"name": "node",
"type": "HTMLElement",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 875,
"description": "Direction of the axis.",
"itemtype": "attribute",
"name": "position",
"type": "String",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 894,
"description": "Distance determined by the tick styles used to calculate the distance between the axis\nline in relation to the top of the axis.",
"itemtype": "attribute",
"name": "topTickOffset",
"type": "Number",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 905,
"description": "Distance determined by the tick styles used to calculate the distance between the axis\nline in relation to the bottom of the axis.",
"itemtype": "attribute",
"name": "bottomTickOffset",
"type": "Number",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 916,
"description": "Distance determined by the tick styles used to calculate the distance between the axis\nline in relation to the left of the axis.",
"itemtype": "attribute",
"name": "leftTickOffset",
"type": "Number",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 927,
"description": "Distance determined by the tick styles used to calculate the distance between the axis\nline in relation to the right side of the axis.",
"itemtype": "attribute",
"name": "rightTickOffset",
"type": "Number",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 938,
"description": "Collection of labels used to render the axis.",
"itemtype": "attribute",
"name": "labels",
"type": "Array",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 952,
"description": "Collection of points used for placement of labels and ticks along the axis.",
"itemtype": "attribute",
"name": "tickPoints",
"type": "Array",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 971,
"description": "Indicates whether the axis overlaps the graph. If an axis is the inner most axis on a given\nposition and the tick position is inside or cross, the axis will need to overlap the graph.",
"itemtype": "attribute",
"name": "overlapGraph",
"type": "Boolean",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 987,
"description": "Object which should have by the labelFunction",
"itemtype": "attribute",
"name": "labelFunctionScope",
"type": "Object",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 995,
"description": "Length in pixels of largest text bounding box. Used to calculate the height of the axis.",
"itemtype": "attribute",
"name": "maxLabelSize",
"type": "Number",
"access": "protected",
"tagname": "",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 1006,
"description": "Title for the axis. When specified, the title will display. The position of the title is determined by the axis position. \n\n - top
- Appears above the axis and it labels. The default rotation is 0.
\n - right
- Appears to the right of the axis and its labels. The default rotation is 90.
\n - bottom
- Appears below the axis and its labels. The default rotation is 0.
\n - left
- Appears to the left of the axis and its labels. The default rotation is -90.
\n
",
"itemtype": "attribute",
"name": "title",
"type": "String",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Axis.js",
"line": 1020,
"description": "Style properties used for drawing an axis. This attribute is inherited from `Renderer`. Below are the default values:\n \n - majorTicks
- Properties used for drawing ticks.\n
\n - display
- Position of the tick. Possible values are `inside`, `outside`, `cross` and `none`. The\n default value is `inside`.
\n - length
- The length (in pixels) of the tick. The default value is 4.
\n - color
- The color of the tick. The default value is `#dad8c9`
\n - weight
- Number indicating the width of the tick. The default value is 1.
\n - alpha
- Number from 0 to 1 indicating the opacity of the tick. The default value is 1.
\n
\n \n - line
- Properties used for drawing the axis line. \n
\n - weight
- Number indicating the width of the axis line. The default value is 1.
\n - color
- The color of the axis line. The default value is `#dad8c9`.
\n - alpha
- Number from 0 to 1 indicating the opacity of the tick. The default value is 1.
\n
\n \n - majorUnit
- Properties used to calculate the `majorUnit` for the axis. \n
\n - determinant
- The algorithm used for calculating distance between ticks. The possible options are `count` and `distance`. If\n the `determinant` is `count`, the axis ticks will spaced so that a specified number of ticks appear on the axis. If the `determinant`\n is `distance`, the axis ticks will spaced out according to the specified distance. The default value is `count`.
\n - count
- Number of ticks to appear on the axis when the `determinant` is `count`. The default value is 11.
\n - distance
- The distance (in pixels) between ticks when the `determinant` is `distance`. The default value is 75.
\n
\n \n - label
- Properties and styles applied to the axis labels.\n
\n - color
- The color of the labels. The default value is `#808080`.
\n - alpha
- Number between 0 and 1 indicating the opacity of the labels. The default value is 1.
\n - fontSize
- The font-size of the labels. The default value is 85%
\n - rotation
- The rotation, in degrees (between -90 and 90) of the labels. The default value is 0.
\n - margin
- The distance between the label and the axis/tick. Depending on the position of the `Axis`, only one of the properties used.\n
\n - top
- Pixel value used for an axis with a `position` of `bottom`. The default value is 4.
\n - right
- Pixel value used for an axis with a `position` of `left`. The default value is 4.
\n - bottom
- Pixel value used for an axis with a `position` of `top`. The default value is 4.
\n - left
- Pixel value used for an axis with a `position` of `right`. The default value is 4.
\n
\n \n
\n \n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "Axis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 10,
"itemtype": "method",
"name": "bindUI",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 31,
"description": "Handles changes to `dataProvider`.",
"itemtype": "method",
"name": "_dataProviderChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 59,
"description": "Constant used to generate unique id.",
"itemtype": "property",
"name": "GUID",
"type": "String",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 68,
"description": "Type of data used in `Axis`.",
"itemtype": "property",
"name": "_type",
"type": "String",
"readonly": "",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 78,
"description": "Storage for `setMaximum` attribute.",
"itemtype": "property",
"name": "_setMaximum",
"type": "Object",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 87,
"description": "Storage for `dataMaximum` attribute.",
"itemtype": "property",
"name": "_dataMaximum",
"type": "Object",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 96,
"description": "Storage for `setMinimum` attribute.",
"itemtype": "property",
"name": "_setMinimum",
"type": "Object",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 105,
"description": "Reference to data array.",
"itemtype": "property",
"name": "_data",
"type": "Array",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 114,
"description": "Indicates whether the all data is up to date.",
"itemtype": "property",
"name": "_updateTotalDataFlag",
"type": "Boolean",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 123,
"description": "Storage for `dataReady` attribute.",
"itemtype": "property",
"name": "_dataReady",
"type": "Boolean",
"readonly": "",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 133,
"description": "Adds an array to the key hash.",
"itemtype": "method",
"name": "addKey",
"params": [
{
"name": "value",
"description": "Indicates what key to use in retrieving\nthe array."
}
],
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 145,
"description": "Gets an array of values based on a key.",
"itemtype": "method",
"name": "_getKeyArray",
"params": [
{
"name": "key",
"description": "Value key associated with the data array.",
"type": "String"
},
{
"name": "data",
"description": "Array in which the data resides.",
"type": "Array"
}
],
"return": {
"description": "Array"
},
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 168,
"description": "Sets data by key",
"itemtype": "method",
"name": "_setDataByKey",
"params": [
{
"name": "key",
"description": "Key value to use.",
"type": "String"
},
{
"name": "data",
"description": "Array to use.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 192,
"description": "Updates the total data array.",
"itemtype": "method",
"name": "_updateTotalData",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 213,
"description": "Removes an array from the key hash.",
"itemtype": "method",
"name": "removeKey",
"params": [
{
"name": "value",
"description": "Indicates what key to use in removing from \nthe hash.",
"type": "String"
}
],
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 230,
"description": "Returns a value based of a key value and an index.",
"itemtype": "method",
"name": "getKeyValueAt",
"params": [
{
"name": "key",
"description": "value used to look up the correct array",
"type": "String"
},
{
"name": "index",
"description": "within the array",
"type": "Number"
}
],
"return": {
"description": "Object"
},
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 249,
"description": "Returns an array of values based on an identifier key.",
"itemtype": "method",
"name": "getDataByKey",
"params": [
{
"name": "value",
"description": "value used to identify the array",
"type": "String"
}
],
"return": {
"description": "Object"
},
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 266,
"description": "Calculates the maximum and minimum values for the `Axis`.",
"itemtype": "method",
"name": "_updateMinAndMax",
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 302,
"description": "Returns the total number of majorUnits that will appear on an axis.",
"itemtype": "method",
"name": "getTotalMajorUnits",
"return": {
"description": "Number"
},
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 324,
"description": "Returns the distance between major units on an axis.",
"itemtype": "method",
"name": "getMajorUnitDistance",
"params": [
{
"name": "len",
"description": "Number of ticks",
"type": "Number"
},
{
"name": "uiLen",
"description": "Size of the axis.",
"type": "Number"
},
{
"name": "majorUnit",
"description": "Hash of properties used to determine the majorUnit",
"type": "Object"
}
],
"return": {
"description": "Number"
},
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 347,
"description": "Gets the distance that the first and last ticks are offset from there respective\nedges.",
"itemtype": "method",
"name": "getEdgeOffset",
"params": [
{
"name": "ct",
"description": "Number of ticks on the axis.",
"type": "Number"
},
{
"name": "l",
"description": "Length (in pixels) of the axis.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 361,
"description": "Calculates and returns a value based on the number of labels and the index of\nthe current label.",
"itemtype": "method",
"name": "getLabelByIndex",
"params": [
{
"name": "i",
"description": "Index of the label.",
"type": "Number"
},
{
"name": "l",
"description": "Total number of labels.",
"type": "Number"
}
],
"return": {
"description": "String"
},
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 381,
"description": "Updates the `Axis` after a change in keys.",
"itemtype": "method",
"name": "_keyChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 394,
"description": "Checks to see if data extends beyond the range of the axis. If so,\nthat data will need to be hidden. This method is internal, temporary and subject\nto removal in the future.",
"itemtype": "method",
"name": "_hasDataOverflow",
"access": "protected",
"tagname": "",
"return": {
"description": "Boolean"
},
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 413,
"description": "Hash of array identifed by a string value.",
"itemtype": "attribute",
"name": "keys",
"type": "Object",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 457,
"description": "Indicates how to round unit values.\n \n - niceNumber
- Units will be smoothed based on the number of ticks and data range.
\n - auto
- If the range is greater than 1, the units will be rounded.
\n - numeric value
- Units will be equal to the numeric value.
\n - null
- No rounding will occur.
\n
",
"itemtype": "attribute",
"name": "roundingMethod",
"type": "String",
"default": "niceNumber",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 474,
"description": "Returns the type of axis data\n \n - time
- Manages time data
\n - stacked
- Manages stacked numeric data
\n - numeric
- Manages numeric data
\n - category
- Manages categorical data
\n
",
"itemtype": "attribute",
"name": "type",
"type": "String",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 496,
"description": "Instance of `ChartDataProvider` that the class uses\nto build its own data.",
"itemtype": "attribute",
"name": "dataProvider",
"type": "Array",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 510,
"description": "The maximum value contained in the `data` array. Used for\n`maximum` when `autoMax` is true.",
"itemtype": "attribute",
"name": "dataMaximum",
"type": "Number",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 528,
"description": "The maximum value that will appear on an axis.",
"itemtype": "attribute",
"name": "maximum",
"type": "Number",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 560,
"description": "The minimum value contained in the `data` array. Used for\n`minimum` when `autoMin` is true.",
"itemtype": "attribute",
"name": "dataMinimum",
"type": "Number",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 578,
"description": "The minimum value that will appear on an axis.",
"itemtype": "attribute",
"name": "minimum",
"type": "Number",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 603,
"description": "Determines whether the maximum is calculated or explicitly \nset by the user.",
"itemtype": "attribute",
"name": "setMax",
"type": "Boolean",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 619,
"description": "Determines whether the minimum is calculated or explicitly\nset by the user.",
"itemtype": "attribute",
"name": "setMin",
"type": "Boolean",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 635,
"description": "Array of axis data",
"itemtype": "attribute",
"name": "data",
"type": "Array",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 652,
"description": "Array containing all the keys in the axis.",
"itemtype": "attribute",
"name": "keyCollection",
"type": "Array",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/AxisType.js",
"line": 676,
"description": "Method used for formatting a label. This attribute allows for the default label formatting method to overridden. The method use would need\nto implement the arguments below and return a `String`.\n\n - val
- Label to be formatted. (`String`)
\n - format
- Template for formatting label. (optional)
\n
",
"itemtype": "attribute",
"name": "labelFunction",
"type": "Function",
"class": "AxisType",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BarSeries.js",
"line": 13,
"description": "Helper method for calculating the size of markers.",
"itemtype": "method",
"name": "_getMarkerDimensions",
"params": [
{
"name": "xcoord",
"description": "The x-coordinate representing the data point for the marker.",
"type": "Number"
},
{
"name": "ycoord",
"description": "The y-coordinate representing the data point for the marker.",
"type": "Number"
},
{
"name": "calculatedSize",
"description": "The calculated size for the marker. For a `BarSeries` is it the width. For a `ColumnSeries` it is the height.",
"type": "Number"
},
{
"name": "offset",
"description": "Distance of position offset dictated by other marker series in the same graph.",
"type": "Number"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "BarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BarSeries.js",
"line": 42,
"description": "Resizes and positions markers based on a mouse interaction.",
"itemtype": "method",
"name": "updateMarkerState",
"params": [
{
"name": "type",
"description": "state of the marker",
"type": "String"
},
{
"name": "i",
"description": "index of the marker",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "BarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BarSeries.js",
"line": 100,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "bar",
"class": "BarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BarSeries.js",
"line": 111,
"description": "Indicates the direction of the category axis that the bars are plotted against.",
"itemtype": "attribute",
"name": "direction",
"type": "String",
"class": "BarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BarSeries.js",
"line": 121,
"description": "Style properties used for drawing markers. This attribute is inherited from `MarkerSeries`. Below are the default values:\n \n - fill
- A hash containing the following values:\n
\n - color
- Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n \n - alpha
- Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
\n
\n \n - border
- A hash containing the following values:\n
\n - color
- Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n - alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
\n - weight
- Number indicating the width of the border. The default value is 1.
\n
\n \n - height
- indicates the width of the marker. The default value is 12.
\n - over
- hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "BarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 11,
"description": "Default margins for text fields.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getDefaultMargins",
"return": {
"description": "Object"
},
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 28,
"description": "Sets the length of the tick on either side of the axis line.",
"itemtype": "method",
"name": "setTickOffsets",
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 65,
"description": "Calculates the coordinates for the first point on an axis.",
"itemtype": "method",
"name": "getLineStart",
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 90,
"description": "Draws a tick",
"itemtype": "method",
"name": "drawTick",
"params": [
{
"name": "path",
"description": "reference to the path `Path` element in which to draw the tick.",
"type": "Path"
},
{
"name": "pt",
"description": "hash containing x and y coordinates",
"type": "Object"
},
{
"name": "tickStyles",
"description": "hash of properties used to draw the tick",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 110,
"description": "Calculates the point for a label.",
"itemtype": "method",
"name": "getLabelPoint",
"params": [
{
"name": "pt",
"description": "Object containing x and y coordinates",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 123,
"description": "Updates the value for the `maxLabelSize` for use in calculating total size.",
"itemtype": "method",
"name": "updateMaxLabelSize",
"params": [
{
"name": "label",
"description": "to measure",
"type": "HTMLElement"
}
],
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 167,
"description": "Rotate and position title.",
"itemtype": "method",
"name": "positionTitle",
"params": [
{
"name": "label",
"description": "to rotate position",
"type": "HTMLElement"
}
],
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 258,
"description": "Rotate and position labels.",
"itemtype": "method",
"name": "positionLabel",
"params": [
{
"name": "label",
"description": "to rotate position",
"type": "HTMLElement"
},
{
"name": "pt",
"description": "hash containing the x and y coordinates in which the label will be positioned\nagainst.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 353,
"description": "Calculates the size and positions the content elements.",
"itemtype": "method",
"name": "setSizeAndPosition",
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 375,
"description": "Adjusts position for inner ticks.",
"itemtype": "method",
"name": "offsetNodeForTick",
"params": [
{
"name": "cb",
"description": "contentBox of the axis",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/BottomAxisLayout.js",
"line": 388,
"description": "Assigns a height based on the size of the contents.",
"itemtype": "method",
"name": "setCalculatedSize",
"access": "protected",
"tagname": "",
"class": "BottomAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 10,
"itemtype": "method",
"name": "renderUI",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 45,
"description": "When `interactionType` is set to `planar`, listens for mouse move events and fires `planarEvent:mouseover` or `planarEvent:mouseout` depending on the position of the mouse in relation to \ndata points on the `Chart`.",
"itemtype": "method",
"name": "_planarEventDispatcher",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 143,
"description": "Broadcasts when `interactionType` is set to `planar` and a series' marker plane has received a mouseover event.",
"itemtype": "event",
"name": "planarEvent:mouseover",
"preventable": "false",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n \n - categoryItem
- An array of hashes, each containing information about the category `Axis` of each marker whose plane has been intersected.
\n - valueItem
- An array of hashes, each containing information about the value `Axis` of each marker whose plane has been intersected.
\n - x
- The x-coordinate of the mouse in relation to the Chart.
\n - y
- The y-coordinate of the mouse in relation to the Chart.
\n - pageX
- The x location of the event on the page (including scroll)
\n - pageY
- The y location of the event on the page (including scroll)
\n - items
- An array including all the series which contain a marker whose plane has been intersected.
\n - index
- Index of the markers in their respective series.
\n - originEvent
- Underlying dom event.
\n
",
"type": "EventFacade"
}
],
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 163,
"description": "Broadcasts when `interactionType` is set to `planar` and a series' marker plane has received a mouseout event.",
"itemtype": "event",
"name": "planarEvent:mouseout",
"preventable": "false",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 191,
"description": "Indicates the default series type for the chart.",
"itemtype": "property",
"name": "_type",
"type": "{String}",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 200,
"description": "Queue of axes instances that will be updated. This method is used internally to determine when all axes have been updated.",
"itemtype": "property",
"name": "_axesRenderQueue",
"type": "Array",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 209,
"description": "Adds an `Axis` instance to the `_axesRenderQueue`.",
"itemtype": "method",
"name": "_addToAxesRenderQueue",
"params": [
{
"name": "axis",
"description": "An `Axis` instance.",
"type": "Axis"
}
],
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 228,
"description": "Returns the default value for the `seriesCollection` attribute.",
"itemtype": "method",
"name": "_getDefaultSeriesCollection",
"params": [
{
"name": "val",
"description": "Array containing either `CartesianSeries` instances or objects containing data to construct series instances.",
"type": "Array"
}
],
"return": {
"description": "Array"
},
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 332,
"description": "Parse and sets the axes for a series instance.",
"itemtype": "method",
"name": "_parseSeriesAxes",
"params": [
{
"name": "series",
"description": "A `CartesianSeries` instance.",
"type": "CartesianSeries"
}
],
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 365,
"description": "Returns the category axis instance for the chart.",
"itemtype": "method",
"name": "_getCategoryAxis",
"return": {
"description": "Axis"
},
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 381,
"description": "Returns the value axis for a series.",
"itemtype": "method",
"name": "_getSeriesAxis",
"params": [
{
"name": "key",
"description": "The key value used to determine the axis instance.",
"type": "String"
}
],
"return": {
"description": "Axis"
},
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 420,
"description": "Gets an attribute from an object, using a getter for Base objects and a property for object\nliterals. Used for determining attributes from series/axis references which can be an actual class instance\nor a hash of properties that will be used to create a class instance.",
"itemtype": "method",
"name": "_getBaseAttribute",
"params": [
{
"name": "item",
"description": "Object or instance in which the attribute resides.",
"type": "Object"
},
{
"name": "key",
"description": "Attribute whose value will be returned.",
"type": "String"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 444,
"description": "Sets an attribute on an object, using a setter of Base objects and a property for object\nliterals. Used for setting attributes on a Base class, either directly or to be stored in an object literal\nfor use at instantiation.",
"itemtype": "method",
"name": "_setBaseAttribute",
"params": [
{
"name": "item",
"description": "Object or instance in which the attribute resides.",
"type": "Object"
},
{
"name": "key",
"description": "Attribute whose value will be assigned.",
"type": "String"
},
{
"name": "value",
"description": "Value to be assigned to the attribute.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 467,
"description": "Creates `Axis` instances.",
"itemtype": "method",
"name": "_parseAxes",
"params": [
{
"name": "val",
"description": "Object containing `Axis` instances or objects in which to construct `Axis` instances.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 552,
"description": "Adds axes to the chart.",
"itemtype": "method",
"name": "_addAxes",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 611,
"description": "Renders the Graph.",
"itemtype": "method",
"name": "_addSeries",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 625,
"description": "Adds gridlines to the chart.",
"itemtype": "method",
"name": "_addGridlines",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 698,
"description": "Generates and returns a key-indexed object containing `Axis` instances or objects used to create `Axis` instances.",
"itemtype": "method",
"name": "_getDefaultAxes",
"params": [
{
"name": "axes",
"description": "Object containing `Axis` instances or `Axis` attributes.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 865,
"description": "Determines the position of an axis when one is not specified.",
"itemtype": "method",
"name": "_getDefaultAxisPosition",
"params": [
{
"name": "axis",
"description": "`Axis` instance.",
"type": "Axis"
},
{
"name": "valueAxes",
"description": "Array of `Axis` instances.",
"type": "Array"
},
{
"name": "position",
"description": "Default position depending on the direction of the chart and type of axis.",
"type": "String"
}
],
"return": {
"description": "String"
},
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 909,
"description": "Returns an object literal containing a categoryItem and a valueItem for a given series index.",
"itemtype": "method",
"name": "getSeriesItem",
"params": [
{
"name": "series",
"description": "Reference to a series.",
"type": "CartesianSeries"
},
{
"name": "index",
"description": "Index of the specified item within a series.",
"type": "Number"
}
],
"return": {
"description": "Object"
},
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 958,
"description": "Handler for axisRendered event.",
"itemtype": "method",
"name": "_axisRendered",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 974,
"description": "Handler for sizeChanged event.",
"itemtype": "method",
"name": "_sizeChanged",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 996,
"description": "Redraws and position all the components of the chart instance.",
"itemtype": "method",
"name": "_redraw",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1121,
"description": "Style object for the axes.",
"itemtype": "attribute",
"name": "axesStyles",
"type": "Object",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1165,
"description": "Style object for the series",
"itemtype": "attribute",
"name": "seriesStyles",
"type": "Object",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1228,
"description": "Styles for the graph.",
"itemtype": "attribute",
"name": "graphStyles",
"type": "Object",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1254,
"description": "Style properties for the chart. Contains a key indexed hash of the following:\n \n - series
- A key indexed hash containing references to the `styles` attribute for each series in the chart.\n Specific style attributes vary depending on the series:\n \n
\n - axes
- A key indexed hash containing references to the `styles` attribute for each axes in the chart. Specific\n style attributes can be found in the Axis class.
\n - graph
- A reference to the `styles` attribute in the chart. Specific style attributes can be found in the\n Graph class.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1319,
"description": "Axes to appear in the chart. This can be a key indexed hash of axis instances or object literals\nused to construct the appropriate axes.",
"itemtype": "attribute",
"name": "axes",
"type": "Object",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1335,
"description": "Collection of series to appear on the chart. This can be an array of Series instances or object literals\nused to construct the appropriate series.",
"itemtype": "attribute",
"name": "seriesCollection",
"type": "Array",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1351,
"description": "Reference to the left-aligned axes for the chart.",
"itemtype": "attribute",
"name": "leftAxesCollection",
"type": "Array",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1360,
"description": "Reference to the bottom-aligned axes for the chart.",
"itemtype": "attribute",
"name": "bottomAxesCollection",
"type": "Array",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1369,
"description": "Reference to the right-aligned axes for the chart.",
"itemtype": "attribute",
"name": "rightAxesCollection",
"type": "Array",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1378,
"description": "Reference to the top-aligned axes for the chart.",
"itemtype": "attribute",
"name": "topAxesCollection",
"type": "Array",
"access": "private",
"tagname": "",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1387,
"description": "Indicates whether or not the chart is stacked.",
"itemtype": "attribute",
"name": "stacked",
"type": "Boolean",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1397,
"description": "Direction of chart's category axis when there is no series collection specified. Charts can\nbe horizontal or vertical. When the chart type is column, the chart is horizontal.\nWhen the chart type is bar, the chart is vertical.",
"itemtype": "attribute",
"name": "direction",
"type": "String",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1427,
"description": "Indicates whether or not an area is filled in a combo chart.",
"itemtype": "attribute",
"name": "showAreaFill",
"type": "Boolean",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1435,
"description": "Indicates whether to display markers in a combo chart.",
"itemtype": "attribute",
"name": "showMarkers",
"type": "Boolean",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1443,
"description": "Indicates whether to display lines in a combo chart.",
"itemtype": "attribute",
"name": "showLines",
"type": "Boolean",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1451,
"description": "Indicates the key value used to identify a category axis in the `axes` hash. If\nnot specified, the categoryKey attribute value will be used.",
"itemtype": "attribute",
"name": "categoryAxisName",
"type": "String",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1461,
"description": "Indicates the key value used to identify a the series axis when an axis not generated.",
"itemtype": "attribute",
"name": "valueAxisName",
"type": "String",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1471,
"description": "Reference to the horizontalGridlines for the chart.",
"itemtype": "attribute",
"name": "horizontalGridlines",
"type": "Gridlines",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1505,
"description": "Reference to the verticalGridlines for the chart.",
"itemtype": "attribute",
"name": "verticalGridlines",
"type": "Gridlines",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1539,
"description": "Type of chart when there is no series collection specified.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianChart.js",
"line": 1576,
"description": "Reference to the category axis used by the chart.",
"itemtype": "attribute",
"name": "categoryAxis",
"type": "Axis",
"class": "CartesianChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 11,
"description": "Storage for `xDisplayName` attribute.",
"itemtype": "property",
"name": "_xDisplayName",
"type": "String",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 20,
"description": "Storage for `yDisplayName` attribute.",
"itemtype": "property",
"name": "_yDisplayName",
"type": "String",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 29,
"description": "Th x-coordinate for the left edge of the series.",
"itemtype": "property",
"name": "_leftOrigin",
"type": "String",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 38,
"description": "The y-coordinate for the bottom edge of the series.",
"itemtype": "property",
"name": "_bottomOrigin",
"type": "String",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 47,
"itemtype": "method",
"name": "render",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 59,
"description": "Adds event listeners.",
"itemtype": "method",
"name": "addListeners",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 105,
"description": "Event handler for the xAxisChange event.",
"itemtype": "method",
"name": "_xAxisChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 119,
"description": "Event handler the yAxisChange event.",
"itemtype": "method",
"name": "_yAxisChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 133,
"description": "Constant used to generate unique id.",
"itemtype": "property",
"name": "GUID",
"type": "String",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 142,
"description": "Event handler for xDataChange event.",
"itemtype": "method",
"name": "_xDataChangeHandler",
"params": [
{
"name": "event",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 158,
"description": "Event handler for yDataChange event.",
"itemtype": "method",
"name": "_yDataChangeHandler",
"params": [
{
"name": "event",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 174,
"description": "Checks to ensure that both xAxis and yAxis data are available. If so, set the `xData` and `yData` attributes and return `true`. Otherwise, return `false`.",
"itemtype": "method",
"name": "_updateAxisData",
"return": {
"description": "Boolean"
},
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 204,
"description": "Draws the series is the xAxis and yAxis data are both available.",
"itemtype": "method",
"name": "validate",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 222,
"description": "Creates a `Graphic` instance.",
"itemtype": "method",
"name": "_setCanvas",
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 235,
"description": "Calculates the coordinates for the series.",
"itemtype": "method",
"name": "setAreaData",
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 320,
"description": "Draws the series.",
"itemtype": "method",
"name": "draw",
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 361,
"description": "Default value for plane offsets when the parent chart's `interactiveType` is `planar`.",
"itemtype": "property",
"name": "_defaultPlaneOffset",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 370,
"description": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 388,
"description": "Collection of default colors used for lines in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultLineColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 397,
"description": "Collection of default colors used for marker fills in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultFillColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 406,
"description": "Collection of default colors used for marker borders in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultBorderColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 415,
"description": "Collection of default colors used for area fills, histogram fills and pie fills in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultSliceColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 424,
"description": "Parses a color based on a series order and type.",
"itemtype": "method",
"name": "_getDefaultColor",
"params": [
{
"name": "index",
"description": "Index indicating the series order.",
"type": "Number"
},
{
"name": "type",
"description": "Indicates which type of object needs the color.",
"type": "String"
}
],
"return": {
"description": "String"
},
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 452,
"description": "Shows/hides contents of the series.",
"itemtype": "method",
"name": "_handleVisibleChange",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 465,
"description": "Name used for for displaying data related to the x-coordinate.",
"itemtype": "attribute",
"name": "xDisplayName",
"type": "String",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 484,
"description": "Name used for for displaying data related to the y-coordinate.",
"itemtype": "attribute",
"name": "yDisplayName",
"type": "String",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 503,
"description": "Name used for for displaying category data",
"itemtype": "attribute",
"name": "categoryDisplayName",
"type": "String",
"readonly": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 519,
"description": "Name used for for displaying value data",
"itemtype": "attribute",
"name": "valueDisplayName",
"type": "String",
"readonly": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 535,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "cartesian",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 546,
"description": "Order of this instance of this `type`.",
"itemtype": "attribute",
"name": "order",
"type": "Number",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 554,
"description": "Order of the instance",
"itemtype": "attribute",
"name": "graphOrder",
"type": "Number",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 562,
"description": "x coordinates for the series.",
"itemtype": "attribute",
"name": "xcoords",
"type": "Array",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 570,
"description": "y coordinates for the series",
"itemtype": "attribute",
"name": "ycoords",
"type": "Array",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 578,
"description": "Reference to the `Chart` application.",
"itemtype": "attribute",
"name": "chart",
"type": "ChartBase",
"readonly": "",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 594,
"description": "Reference to the `Graph` in which the series is drawn into.",
"itemtype": "attribute",
"name": "graph",
"type": "Graph",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 602,
"description": "Reference to the `Axis` instance used for assigning \nx-values to the graph.",
"itemtype": "attribute",
"name": "xAxis",
"type": "Axis",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 611,
"description": "Reference to the `Axis` instance used for assigning \ny-values to the graph.",
"itemtype": "attribute",
"name": "yAxis",
"type": "Axis",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 620,
"description": "Indicates which array to from the hash of value arrays in \nthe x-axis `Axis` instance.",
"itemtype": "attribute",
"name": "xKey",
"type": "String",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 629,
"description": "Indicates which array to from the hash of value arrays in \nthe y-axis `Axis` instance.",
"itemtype": "attribute",
"name": "yKey",
"type": "String",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 638,
"description": "Array of x values for the series.",
"itemtype": "attribute",
"name": "xData",
"type": "Array",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 646,
"description": "Array of y values for the series.",
"itemtype": "attribute",
"name": "yData",
"type": "Array",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 654,
"description": "Indicates whether the Series has been through its initial set up.",
"itemtype": "attribute",
"name": "rendered",
"type": "Boolean",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 679,
"description": "Returns the height of the parent graph",
"itemtype": "attribute",
"name": "height",
"type": "Number",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 694,
"description": "Indicates whether to show the series",
"itemtype": "attribute",
"name": "visible",
"type": "Boolean",
"default": "true",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 705,
"description": "Collection of area maps along the xAxis. Used to determine mouseover for multiple\nseries.",
"itemtype": "attribute",
"name": "xMarkerPlane",
"type": "Array",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 714,
"description": "Collection of area maps along the yAxis. Used to determine mouseover for multiple\nseries.",
"itemtype": "attribute",
"name": "yMarkerPlane",
"type": "Array",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 723,
"description": "Distance from a data coordinate to the left/right for setting a hotspot.",
"itemtype": "attribute",
"name": "xMarkerPlaneOffset",
"type": "Number",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 740,
"description": "Distance from a data coordinate to the top/bottom for setting a hotspot.",
"itemtype": "attribute",
"name": "yMarkerPlaneOffset",
"type": "Number",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CartesianSeries.js",
"line": 757,
"description": "Direction of the series",
"itemtype": "attribute",
"name": "direction",
"type": "String",
"class": "CartesianSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 19,
"description": "Object storing key data.",
"itemtype": "property",
"name": "_indices",
"access": "private",
"tagname": "",
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 27,
"description": "Constant used to generate unique id.",
"itemtype": "property",
"name": "GUID",
"type": "String",
"access": "private",
"tagname": "",
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 36,
"description": "Type of data used in `Axis`.",
"itemtype": "property",
"name": "_dataType",
"readonly": "",
"access": "private",
"tagname": "",
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 45,
"description": "Calculates the maximum and minimum values for the `Axis`.",
"itemtype": "method",
"name": "_updateMinAndMax",
"access": "private",
"tagname": "",
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 57,
"description": "Gets an array of values based on a key.",
"itemtype": "method",
"name": "_getKeyArray",
"params": [
{
"name": "key",
"description": "Value key associated with the data array.",
"type": "String"
},
{
"name": "data",
"description": "Array in which the data resides.",
"type": "Array"
}
],
"return": {
"description": "Array"
},
"access": "private",
"tagname": "",
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 87,
"description": "Sets data by key",
"itemtype": "method",
"name": "_setDataByKey",
"params": [
{
"name": "key",
"description": "Key value to use.",
"type": "String"
},
{
"name": "data",
"description": "Array to use.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 118,
"description": "Returns an array of values based on an identifier key.",
"itemtype": "method",
"name": "getDataByKey",
"params": [
{
"name": "value",
"description": "value used to identify the array",
"type": "String"
}
],
"return": {
"description": "Array"
},
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 139,
"description": "Returns the total number of majorUnits that will appear on an axis.",
"itemtype": "method",
"name": "getTotalMajorUnits",
"params": [
{
"name": "majorUnit",
"description": "Object containing properties related to the majorUnit.",
"type": "Object"
},
{
"name": "len",
"description": "Length of the axis.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 152,
"description": "Returns the distance between major units on an axis.",
"itemtype": "method",
"name": "getMajorUnitDistance",
"params": [
{
"name": "len",
"description": "Number of ticks",
"type": "Number"
},
{
"name": "uiLen",
"description": "Size of the axis.",
"type": "Number"
},
{
"name": "majorUnit",
"description": "Hash of properties used to determine the majorUnit",
"type": "Object"
}
],
"return": {
"description": "Number"
},
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 175,
"description": "Gets the distance that the first and last ticks are offset from there respective\nedges.",
"itemtype": "method",
"name": "getEdgeOffset",
"params": [
{
"name": "ct",
"description": "Number of ticks on the axis.",
"type": "Number"
},
{
"name": "l",
"description": "Length (in pixels) of the axis.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CategoryAxis.js",
"line": 189,
"description": "Calculates and returns a value based on the number of labels and the index of\nthe current label.",
"itemtype": "method",
"name": "getLabelByIndex",
"params": [
{
"name": "i",
"description": "Index of the label.",
"type": "Number"
},
{
"name": "l",
"description": "Total number of labels.",
"type": "Number"
}
],
"return": {
"description": "String"
},
"class": "CategoryAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 11,
"description": "Reference to the default tooltip available for the chart.\nContains the following properties:
\n \n - node
- Reference to the actual dom node
\n - showEvent
- Event that should trigger the tooltip
\n - hideEvent
- Event that should trigger the removal of a tooltip (can be an event or an array of events)
\n - styles
- A hash of style properties that will be applied to the tooltip node
\n - show
- Indicates whether or not to show the tooltip
\n - markerEventHandler
- Displays and hides tooltip based on marker events
\n - planarEventHandler
- Displays and hides tooltip based on planar events
\n - markerLabelFunction
- Reference to the function used to format a marker event triggered tooltip's text
\n - planarLabelFunction
- Reference to the function used to format a planar event triggered tooltip's text
\n
",
"itemtype": "attribute",
"name": "tooltip",
"type": "Object",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 37,
"description": "The key value used for the chart's category axis.",
"itemtype": "attribute",
"name": "categoryKey",
"type": "String",
"default": "category",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 48,
"description": "Indicates the type of axis to use for the category axis.\n\n \n - category
- Specifies a `CategoryAxis`.
\n - time
- Specifies a `TimeAxis
\n
",
"itemtype": "attribute",
"name": "categoryType",
"type": "String",
"default": "category",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 64,
"description": "Indicates the the type of interactions that will fire events.\n\n \n - marker
- Events will be broadcasted when the mouse interacts with individual markers.
\n - planar
- Events will be broadcasted when the mouse intersects the plane of any markers on the chart.
\n - none
- No events will be broadcasted.
\n
",
"itemtype": "attribute",
"name": "interactionType",
"type": "String",
"default": "marker",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 81,
"description": "Data used to generate the chart.",
"itemtype": "attribute",
"name": "dataProvider",
"type": "Array",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 94,
"description": "A collection of keys that map to the series axes. If no keys are set,\nthey will be generated automatically depending on the data structure passed into \nthe chart.",
"itemtype": "attribute",
"name": "seriesKeys",
"type": "Array",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 104,
"description": "Reference to all the axes in the chart.",
"itemtype": "attribute",
"name": "axesCollection",
"type": "Array",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 112,
"description": "Reference to graph instance.",
"itemtype": "attribute",
"name": "graph",
"type": "Graph",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 124,
"description": "Default value function for the `Graph` attribute.",
"itemtype": "method",
"name": "_getGraph",
"return": {
"description": "Graph"
},
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 140,
"description": "Returns a series instance by index or key value.",
"itemtype": "method",
"name": "getSeries",
"params": [
{
"name": "val",
"description": ""
}
],
"return": {
"description": "CartesianSeries"
},
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 165,
"description": "Returns an `Axis` instance by key reference. If the axis was explicitly set through the `axes` attribute,\nthe key will be the same as the key used in the `axes` object. For default axes, the key for\nthe category axis is the value of the `categoryKey` (`category`). For the value axis, the default \nkey is `values`.",
"itemtype": "method",
"name": "getAxisByKey",
"params": [
{
"name": "val",
"description": "Key reference used to look up the axis.",
"type": "String"
}
],
"return": {
"description": "Axis"
},
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 186,
"description": "Returns the category axis for the chart.",
"itemtype": "method",
"name": "getCategoryAxis",
"return": {
"description": "Axis"
},
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 204,
"description": "Default direction of the chart.",
"itemtype": "property",
"name": "_direction",
"type": "String",
"default": "horizontal",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 214,
"description": "Storage for the `dataProvider` attribute.",
"itemtype": "property",
"name": "_dataProvider",
"type": "Array",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 223,
"description": "Setter method for `dataProvider` attribute.",
"itemtype": "method",
"name": "_setDataValues",
"params": [
{
"name": "val",
"description": "Array to be set as `dataProvider`.",
"type": "Array"
}
],
"return": {
"description": "Array"
},
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 256,
"description": "Storage for `seriesCollection` attribute.",
"itemtype": "property",
"name": "_seriesCollection",
"type": "Array",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 265,
"description": "Setter method for `seriesCollection` attribute.",
"itemtype": "property",
"name": "_setSeriesCollection",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts",
"subprops": [
{
"name": "val",
"description": "Array of either `CartesianSeries` instances or objects containing series attribute key value pairs.",
"type": "Array"
}
]
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 276,
"description": "Helper method that returns the axis class that a key references.",
"itemtype": "method",
"name": "_getAxisClass",
"params": [
{
"name": "t",
"description": "The type of axis.",
"type": "String"
}
],
"return": {
"description": "Axis"
},
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 289,
"description": "Key value pairs of axis types.",
"itemtype": "property",
"name": "_axisClass",
"type": "Object",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 303,
"description": "Collection of axes.",
"itemtype": "property",
"name": "_axes",
"type": "Array",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 312,
"itemtype": "method",
"name": "renderUI",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 331,
"itemtype": "property",
"name": "bindUI",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 393,
"description": "Event handler for marker events.",
"itemtype": "method",
"name": "_markerEventDispatcher",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 424,
"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a mouseover event.",
"itemtype": "event",
"name": "markerEvent:mouseover",
"preventable": "false",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n \n - categoryItem
- Hash containing information about the category `Axis`.
\n - valueItem
- Hash containing information about the value `Axis`.
\n - node
- The dom node of the marker.
\n - x
- The x-coordinate of the mouse in relation to the Chart.
\n - y
- The y-coordinate of the mouse in relation to the Chart.
\n - series
- Reference to the series of the marker.
\n - index
- Index of the marker in the series.
\n - seriesIndex
- The `order` of the marker's series.
\n
",
"type": "EventFacade"
}
],
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 443,
"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a mouseout event.",
"itemtype": "event",
"name": "markerEvent:mouseout",
"preventable": "false",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n \n - categoryItem
- Hash containing information about the category `Axis`.
\n - valueItem
- Hash containing information about the value `Axis`.
\n - node
- The dom node of the marker.
\n - x
- The x-coordinate of the mouse in relation to the Chart.
\n - y
- The y-coordinate of the mouse in relation to the Chart.
\n - series
- Reference to the series of the marker.
\n - index
- Index of the marker in the series.
\n - seriesIndex
- The `order` of the marker's series.
\n
",
"type": "EventFacade"
}
],
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 461,
"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a mousedown event.",
"itemtype": "event",
"name": "markerEvent:mousedown",
"preventable": "false",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n \n - categoryItem
- Hash containing information about the category `Axis`.
\n - valueItem
- Hash containing information about the value `Axis`.
\n - node
- The dom node of the marker.
\n - x
- The x-coordinate of the mouse in relation to the Chart.
\n - y
- The y-coordinate of the mouse in relation to the Chart.
\n - series
- Reference to the series of the marker.
\n - index
- Index of the marker in the series.
\n - seriesIndex
- The `order` of the marker's series.
\n
",
"type": "EventFacade"
}
],
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 479,
"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a mouseup event.",
"itemtype": "event",
"name": "markerEvent:mouseup",
"preventable": "false",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n \n - categoryItem
- Hash containing information about the category `Axis`.
\n - valueItem
- Hash containing information about the value `Axis`.
\n - node
- The dom node of the marker.
\n - x
- The x-coordinate of the mouse in relation to the Chart.
\n - y
- The y-coordinate of the mouse in relation to the Chart.
\n - series
- Reference to the series of the marker.
\n - index
- Index of the marker in the series.
\n - seriesIndex
- The `order` of the marker's series.
\n
",
"type": "EventFacade"
}
],
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 497,
"description": "Broadcasts when `interactionType` is set to `marker` and a series marker has received a click event.",
"itemtype": "event",
"name": "markerEvent:click",
"preventable": "false",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n \n - categoryItem
- Hash containing information about the category `Axis`.
\n - valueItem
- Hash containing information about the value `Axis`.
\n - node
- The dom node of the marker.
\n - x
- The x-coordinate of the mouse in relation to the Chart.
\n - y
- The y-coordinate of the mouse in relation to the Chart.
\n - pageX
- The x location of the event on the page (including scroll)
\n - pageY
- The y location of the event on the page (including scroll)
\n - series
- Reference to the series of the marker.
\n - index
- Index of the marker in the series.
\n - seriesIndex
- The `order` of the marker's series.
\n - originEvent
- Underlying dom event.
\n
",
"type": "EventFacade"
}
],
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 533,
"description": "Event handler for dataProviderChange.",
"itemtype": "method",
"name": "_dataProviderChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 559,
"description": "Event listener for toggling the tooltip. If a tooltip is visible, hide it. If not, it \nwill create and show a tooltip based on the event object.",
"itemtype": "method",
"name": "toggleTooltip",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 579,
"description": "Shows a tooltip",
"itemtype": "method",
"name": "_showTooltip",
"params": [
{
"name": "msg",
"description": "Message to dispaly in the tooltip.",
"type": "String"
},
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 602,
"description": "Positions the tooltip",
"itemtype": "method",
"name": "_positionTooltip",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 623,
"description": "Hides the default tooltip",
"itemtype": "method",
"name": "hideTooltip",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 639,
"description": "Adds a tooltip to the dom.",
"itemtype": "method",
"name": "_addTooltip",
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 660,
"description": "Updates the tooltip attribute.",
"itemtype": "method",
"name": "_updateTooltip",
"params": [
{
"name": "val",
"description": "Object containing properties for the tooltip.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 709,
"description": "Default getter for `tooltip` attribute.",
"itemtype": "method",
"name": "_getTooltip",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 760,
"description": "Formats tooltip text when `interactionType` is `planar`.",
"itemtype": "method",
"name": "_planarLabelFunction",
"params": [
{
"name": "categoryAxis",
"description": "Reference to the categoryAxis of the chart.",
"type": "Axis"
},
{
"name": "valueItems",
"description": "Array of objects for each series that has a data point in the coordinate plane of the event. Each object contains the following data:\n \n - axis
- The value axis of the series.
\n - key
- The key for the series.
\n - value
- The value for the series item.
\n - displayName
- The display name of the series. (defaults to key if not provided)
\n
",
"type": "Array"
},
{
"name": "index",
"description": "The index of the item within its series.",
"type": "Number"
},
{
"name": "seriesArray",
"description": "Array of series instances for each value item.",
"type": "Array"
},
{
"name": "seriesIndex",
"description": "The index of the series in the `seriesCollection`.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 803,
"description": "Formats tooltip text when `interactionType` is `marker`.",
"itemtype": "method",
"name": "_tooltipLabelFunction",
"params": [
{
"name": "categoryItem",
"description": "An object containing the following:\n \n - axis
- The axis to which the category is bound.
\n - displayName
- The display name set to the category (defaults to key if not provided)
\n - key
- The key of the category.
\n - value
- The value of the category
\n
",
"type": "Object"
},
{
"name": "valueItem",
"description": "An object containing the following:\n \n - axis
- The axis to which the item's series is bound.
\n - displayName
- The display name of the series. (defaults to key if not provided)
\n - key
- The key for the series.
\n - value
- The value for the series item.
\n
",
"type": "Object"
},
{
"name": "itemIndex",
"description": "The index of the item within the series.",
"type": "Number"
},
{
"name": "series",
"description": "The `CartesianSeries` instance of the item.",
"type": "CartesianSeries"
},
{
"name": "seriesIndex",
"description": "The index of the series in the `seriesCollection`.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ChartBase.js",
"line": 835,
"description": "Event handler for the tooltipChange.",
"itemtype": "method",
"name": "_tooltipChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "ChartBase",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ColumnSeries.js",
"line": 13,
"description": "Helper method for calculating the size of markers.",
"itemtype": "method",
"name": "_getMarkerDimensions",
"params": [
{
"name": "xcoord",
"description": "The x-coordinate representing the data point for the marker.",
"type": "Number"
},
{
"name": "ycoord",
"description": "The y-coordinate representing the data point for the marker.",
"type": "Number"
},
{
"name": "calculatedSize",
"description": "The calculated size for the marker. For a `BarSeries` is it the width. For a `ColumnSeries` it is the height.",
"type": "Number"
},
{
"name": "offset",
"description": "Distance of position offset dictated by other marker series in the same graph.",
"type": "Number"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "ColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ColumnSeries.js",
"line": 42,
"description": "Resizes and positions markers based on a mouse interaction.",
"itemtype": "method",
"name": "updateMarkerState",
"params": [
{
"name": "type",
"description": "state of the marker",
"type": "String"
},
{
"name": "i",
"description": "index of the marker",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "ColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ColumnSeries.js",
"line": 100,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"readonly": "",
"default": "column",
"class": "ColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ColumnSeries.js",
"line": 112,
"description": "Style properties used for drawing markers. This attribute is inherited from `MarkerSeries`. Below are the default values:\n \n - fill
- A hash containing the following values:\n
\n - color
- Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n \n - alpha
- Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
\n
\n \n - border
- A hash containing the following values:\n
\n - color
- Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n - alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
\n - weight
- Number indicating the width of the border. The default value is 1.
\n
\n \n - width
- indicates the width of the marker. The default value is 12.
\n - over
- hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "ColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 15,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 38,
"description": "Toggles visibility",
"itemtype": "method",
"name": "_toggleVisible",
"params": [
{
"name": "visible",
"description": "indicates visibilitye",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 78,
"access": "protected",
"tagname": "Returns the default hash for the `styles` attribute.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 97,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "combo",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 108,
"description": "Indicates whether a fill is displayed.",
"itemtype": "attribute",
"name": "showAreaFill",
"type": "Boolean",
"default": "false",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 119,
"description": "Indicates whether lines are displayed.",
"itemtype": "attribute",
"name": "showLines",
"type": "Boolean",
"default": "true",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 130,
"description": "Indicates whether markers are displayed.",
"itemtype": "attribute",
"name": "showMarkers",
"type": "Boolean",
"default": "true",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 141,
"description": "Reference to the styles of the markers. These styles can also\nbe accessed through the `styles` attribute. Below are default\nvalues:\n \n - fill
- A hash containing the following values:\n
\n - color
- Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#6084d0\", \"#eeb647\", \"#6c6b5f\", \"#d6484f\", \"#ce9ed1\", \"#ff9f3b\", \"#93b7ff\", \"#e0ddd0\", \"#94ecba\", \"#309687\"]`\n \n - alpha
- Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
\n
\n \n - border
- A hash containing the following values:\n
\n - color
- Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n - alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
\n - weight
- Number indicating the width of the border. The default value is 1.
\n
\n \n - width
- indicates the width of the marker. The default value is 10.
\n - height
- indicates the height of the marker The default value is 10.
\n - over
- hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.
\n
",
"itemtype": "attribute",
"name": "marker",
"type": "Object",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 186,
"description": "Reference to the styles of the lines. These styles can also be accessed through the `styles` attribute.\nBelow are the default values:\n \n - color
- The color of the line. The default value is determined by the order of the series on the graph. The color will be\n retrieved from the following array: \n `[\"#426ab3\", \"#d09b2c\", \"#000000\", \"#b82837\", \"#b384b5\", \"#ff7200\", \"#779de3\", \"#cbc8ba\", \"#7ed7a6\", \"#007a6c\"]`\n
- weight
- Number that indicates the width of the line. The default value is 6.
\n - alpha
- Number between 0 and 1 that indicates the opacity of the line. The default value is 1.
\n - lineType
- Indicates whether the line is solid or dashed. The default value is solid.
\n - dashLength
- When the `lineType` is dashed, indicates the length of the dash. The default value is 10.
\n - gapSpace
- When the `lineType` is dashed, indicates the distance between dashes. The default value is 10.
\n - connectDiscontinuousPoints
- Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.
\n - discontinuousType
- Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.
\n - discontinuousDashLength
- When the `discontinuousType` is dashed, indicates the length of the dash. The default value is 10.
\n - discontinuousGapSpace
- When the `discontinuousType` is dashed, indicates the distance between dashes. The default value is 10.
\n
",
"itemtype": "attribute",
"name": "line",
"type": "Object",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 219,
"description": "Reference to the styles of the area fills. These styles can also be accessed through the `styles` attribute.\nBelow are the default values:\n\n \n - color
- The color of the fill. The default value is determined by the order of the series on the graph. The color will be \n retrieved from the following array:\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n
\n - alpha
- Number between 0 and 1 that indicates the opacity of the fill. The default value is 1
\n
",
"itemtype": "attribute",
"name": "area",
"type": "Object",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSeries.js",
"line": 246,
"description": "Style properties for the series. Contains a key indexed hash of the following:\n \n - marker
- Style properties for the markers in the series. Specific style attributes are listed\n here.
\n - line
- Style properties for the lines in the series. Specific\n style attributes are listed here.
\n - area
- Style properties for the area fills in the series. Specific style attributes are listed\n here.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "ComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSplineSeries.js",
"line": 13,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "ComboSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/ComboSplineSeries.js",
"line": 37,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "comboSpline",
"class": "ComboSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CurveUtil.js",
"line": 13,
"description": "Creates an array of start, end and control points for splines.",
"itemtype": "method",
"name": "getCurveControlPoints",
"params": [
{
"name": "xcoords",
"description": "Collection of x-coordinates used for calculate the curves",
"type": "Array"
},
{
"name": "ycoords",
"description": "Collection of y-coordinates used for calculate the curves",
"type": "Array"
}
],
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "CurveUtil",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/CurveUtil.js",
"line": 88,
"description": "Gets the control points for the curve.",
"itemtype": "method",
"name": "getControlPoints",
"params": [
{
"name": "vals",
"description": "Collection of values coords used to generate control points.",
"type": "Array"
}
],
"return": {
"description": "Array"
},
"access": "private",
"tagname": "",
"class": "CurveUtil",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 29,
"description": "Returns a path shape used for drawing fills.",
"itemtype": "method",
"name": "_getPath",
"return": {
"description": "Path"
},
"access": "private",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 47,
"description": "Toggles visibility",
"itemtype": "method",
"name": "_toggleVisible",
"params": [
{
"name": "visible",
"description": "indicates visibilitye",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 62,
"description": "Draws fill",
"itemtype": "method",
"name": "drawFill",
"params": [
{
"name": "xcoords",
"description": "The x-coordinates for the series.",
"type": "Array"
},
{
"name": "ycoords",
"description": "The y-coordinates for the series.",
"type": "Array"
}
],
"access": "protected",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 111,
"description": "Draws a fill for a spline",
"itemtype": "method",
"name": "drawAreaSpline",
"access": "protected",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 169,
"description": "Draws a a stacked area spline",
"itemtype": "method",
"name": "drawStackedAreaSpline",
"access": "protected",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 260,
"description": "Storage for default area styles.",
"itemtype": "property",
"name": "_defaults",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 269,
"description": "Concatenates coordinate array with correct coordinates for closing an area fill.",
"itemtype": "method",
"name": "_getClosingPoints",
"return": {
"description": "Array"
},
"access": "protected",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 299,
"description": "Concatenates coordinate array with the correct coordinates for closing an area stack.",
"itemtype": "method",
"name": "_getStackedClosingPoints",
"return": {
"description": "Array"
},
"access": "protected",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Fills.js",
"line": 349,
"description": "Returns default values for area styles.",
"itemtype": "method",
"name": "_getAreaDefaults",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "Fills",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 12,
"itemtype": "method",
"name": "bindUI",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 25,
"itemtype": "method",
"name": "syncUI",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 71,
"description": "Object of arrays containing series mapped to a series type.",
"itemtype": "property",
"name": "seriesTypes",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 80,
"description": "Returns a series instance based on an index.",
"itemtype": "method",
"name": "getSeriesByIndex",
"params": [
{
"name": "val",
"description": "index of the series",
"type": "Number"
}
],
"return": {
"description": "CartesianSeries"
},
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 98,
"description": "Returns a series instance based on a key value.",
"itemtype": "method",
"name": "getSeriesByKey",
"params": [
{
"name": "val",
"description": "key value of the series",
"type": "String"
}
],
"return": {
"description": "CartesianSeries"
},
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 116,
"description": "Adds dispatcher to a `_dispatcher` used to\nto ensure all series have redrawn before for firing event.",
"itemtype": "method",
"name": "addDispatcher",
"params": [
{
"name": "val",
"description": "series instance to add",
"type": "CartesianSeries"
}
],
"access": "protected",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 133,
"description": "Collection of series to be displayed in the graph.",
"itemtype": "property",
"name": "_seriesCollection",
"type": "Array",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 142,
"description": "Object containing key value pairs of `CartesianSeries` instances.",
"itemtype": "property",
"name": "_seriesDictionary",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 151,
"description": "Parses series instances to be displayed in the graph.",
"itemtype": "method",
"name": "_parseSeriesCollection",
"params": [
{
"name": "Collection",
"description": "of `CartesianSeries` instances or objects container `CartesianSeries` attributes values.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 199,
"description": "Adds a series to the graph.",
"itemtype": "method",
"name": "_addSeries",
"params": [
{
"name": "series",
"description": "Series to add to the graph.",
"type": "CartesianSeries"
}
],
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 231,
"description": "Creates a `CartesianSeries` instance from an object containing attribute key value pairs. The key value pairs include attributes for the specific series and a type value which defines the type of\nseries to be used.",
"itemtype": "method",
"name": "createSeries",
"params": [
{
"name": "seriesData",
"description": "Series attribute key value pairs.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 264,
"description": "String reference for pre-defined `Series` classes.",
"itemtype": "property",
"name": "_seriesMap",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 295,
"description": "Returns a specific `CartesianSeries` class based on key value from a look up table of a direct reference to a class. When specifying a key value, the following options\nare available:\n\n \n | Key Value | Class |
|---|
\n | line | Y.LineSeries |
\n | column | Y.ColumnSeries |
\n | bar | Y.BarSeries |
\n | area | Y.AreaSeries |
\n | stackedarea | Y.StackedAreaSeries |
\n | stackedline | Y.StackedLineSeries |
\n | stackedcolumn | Y.StackedColumnSeries |
\n | stackedbar | Y.StackedBarSeries |
\n | markerseries | Y.MarkerSeries |
\n | spline | Y.SplineSeries |
\n | areaspline | Y.AreaSplineSeries |
\n | stackedspline | Y.StackedSplineSeries |
\n | stackedareaspline | Y.StackedAreaSplineSeries |
\n | stackedmarkerseries | Y.StackedMarkerSeries |
\n | pie | Y.PieSeries |
\n | combo | Y.ComboSeries |
\n | stackedcombo | Y.StackedComboSeries |
\n | combospline | Y.ComboSplineSeries |
\n | stackedcombospline | Y.StackedComboSplineSeries |
\n
\n\nWhen referencing a class directly, you can specify any of the above classes or any custom class that extends `CartesianSeries` or `PieSeries`.",
"itemtype": "method",
"name": "_getSeries",
"params": [
{
"name": "type",
"description": "Series type.",
"type": "String | Object"
}
],
"return": {
"description": "CartesianSeries"
},
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 343,
"description": "Event handler for marker events.",
"itemtype": "method",
"name": "_markerEventHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 360,
"description": "Collection of `CartesianSeries` instances to be redrawn.",
"itemtype": "property",
"name": "_dispatchers",
"type": "Array",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 369,
"description": "Updates the `Graph` styles.",
"itemtype": "method",
"name": "_updateStyles",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 386,
"description": "Event handler for size changes.",
"itemtype": "method",
"name": "_sizeChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 430,
"description": "Draws each series.",
"itemtype": "method",
"name": "_drawSeries",
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 469,
"description": "Event handler for series drawingComplete event.",
"itemtype": "method",
"name": "_drawingCompleteHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 496,
"description": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 522,
"description": "Reference to the chart instance using the graph.",
"itemtype": "attribute",
"name": "chart",
"type": "ChartBase",
"readonly": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 531,
"description": "Collection of series. When setting the `seriesCollection` the array can contain a combination of either\n`CartesianSeries` instances or object literals with properties that will define a series.",
"itemtype": "attribute",
"name": "seriesCollection",
"type": "CartesianSeries",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 551,
"description": "Indicates whether the `Graph` has a background.",
"itemtype": "attribute",
"name": "showBackground",
"type": "Boolean",
"default": "true",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 562,
"description": "Read-only hash lookup for all series on in the `Graph`.",
"itemtype": "attribute",
"name": "seriesDictionary",
"type": "Object",
"readonly": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 578,
"description": "Reference to the horizontal `Gridlines` instance.",
"itemtype": "attribute",
"name": "horizontalGridlines",
"type": "Gridlines",
"default": "null",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 609,
"description": "Reference to the vertical `Gridlines` instance.",
"itemtype": "attribute",
"name": "verticalGridlines",
"type": "Gridlines",
"default": "null",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 640,
"description": "Reference to graphic instance used for the background.",
"itemtype": "attribute",
"name": "background",
"type": "Graphic",
"readonly": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 660,
"description": "Reference to graphic instance used for gridlines.",
"itemtype": "attribute",
"name": "gridlines",
"type": "Graphic",
"readonly": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 682,
"description": "Reference to graphic instance used for series.",
"itemtype": "attribute",
"name": "graphic",
"type": "Graphic",
"readonly": "",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Graph.js",
"line": 704,
"description": "Style properties used for drawing a background. Below are the default values:\n \n - background
- An object containing the following values:\n
\n - fill
- Defines the style properties for the fill. Contains the following values:\n
\n - color
- Color of the fill. The default value is #faf9f2.
\n - alpha
- Number from 0 to 1 indicating the opacity of the background fill. The default value is 1.
\n
\n \n - border
- Defines the style properties for the border. Contains the following values:\n
\n - color
- Color of the border. The default value is #dad8c9.
\n - alpha
- Number from 0 to 1 indicating the opacity of the background border. The default value is 1.
\n - weight
- Number indicating the width of the border. The default value is 1.
\n
\n \n
\n \n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "Graph",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 11,
"description": "Reference to the `Path` element used for drawing Gridlines.",
"itemtype": "property",
"name": "_path",
"type": "Path",
"access": "private",
"tagname": "",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 20,
"description": "Removes the Gridlines.",
"itemtype": "method",
"name": "remove",
"access": "private",
"tagname": "",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 35,
"description": "Draws the gridlines",
"itemtype": "method",
"name": "draw",
"access": "protected",
"tagname": "",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 49,
"description": "Algorithm for drawing gridlines",
"itemtype": "method",
"name": "_drawGridlines",
"access": "private",
"tagname": "",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 105,
"description": "Algorithm for horizontal lines.",
"itemtype": "method",
"name": "_horizontalLine",
"params": [
{
"name": "path",
"description": "Reference to path element",
"type": "Path"
},
{
"name": "pt",
"description": "Coordinates corresponding to a major unit of an axis.",
"type": "Object"
},
{
"name": "w",
"description": "Width of the Graph",
"type": "Number"
},
{
"name": "h",
"description": "Height of the Graph",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 121,
"description": "Algorithm for vertical lines.",
"itemtype": "method",
"name": "_verticalLine",
"params": [
{
"name": "path",
"description": "Reference to path element",
"type": "Path"
},
{
"name": "pt",
"description": "Coordinates corresponding to a major unit of an axis.",
"type": "Object"
},
{
"name": "w",
"description": "Width of the Graph",
"type": "Number"
},
{
"name": "h",
"description": "Height of the Graph",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 137,
"description": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 160,
"description": "Indicates the direction of the gridline.",
"itemtype": "attribute",
"name": "direction",
"type": "String",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 168,
"description": "Indicate the `Axis` in which to bind\nthe gridlines.",
"itemtype": "attribute",
"name": "axis",
"type": "Axis",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Gridlines.js",
"line": 177,
"description": "Indicates the `Graph` in which the gridlines \nare drawn.",
"itemtype": "attribute",
"name": "graph",
"type": "Graph",
"class": "Gridlines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Histogram.js",
"line": 11,
"description": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"access": "protected",
"tagname": "",
"class": "Histogram",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Histogram.js",
"line": 123,
"description": "Collection of default colors used for marker fills in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultFillColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "Histogram",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Histogram.js",
"line": 132,
"description": "Gets the default style values for the markers.",
"itemtype": "method",
"name": "_getPlotDefaults",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "Histogram",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 11,
"description": "Default margins for text fields.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getDefaultMargins",
"return": {
"description": "Object"
},
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 28,
"description": "Sets the length of the tick on either side of the axis line.",
"itemtype": "method",
"name": "setTickOffset",
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 65,
"description": "Draws a tick",
"itemtype": "method",
"name": "drawTick",
"params": [
{
"name": "path",
"description": "reference to the path `Path` element in which to draw the tick.",
"type": "Path"
},
{
"name": "pt",
"description": "Point on the axis in which the tick will intersect.",
"type": "Object"
},
{
"name": "tickStyle",
"description": "Hash of properties to apply to the tick.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 85,
"description": "Calculates the coordinates for the first point on an axis.",
"itemtype": "method",
"name": "getLineStart",
"return": {
"description": "",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 111,
"description": "Calculates the point for a label.",
"itemtype": "method",
"name": "getLabelPoint",
"params": [
{
"name": "point",
"description": "Point on the axis in which the tick will intersect.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 124,
"description": "Updates the value for the `maxLabelSize` for use in calculating total size.",
"itemtype": "method",
"name": "updateMaxLabelSize",
"params": [
{
"name": "label",
"description": "to measure",
"type": "HTMLElement"
}
],
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 168,
"description": "Rotate and position title.",
"itemtype": "method",
"name": "positionTitle",
"params": [
{
"name": "label",
"description": "to rotate position",
"type": "HTMLElement"
}
],
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 263,
"description": "Rotate and position labels.",
"itemtype": "method",
"name": "positionLabel",
"params": [
{
"name": "label",
"description": "to rotate position",
"type": "HTMLElement"
},
{
"name": "pt",
"description": "hash containing the x and y coordinates in which the label will be positioned\nagainst.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 361,
"description": "Calculates the size and positions the content elements.",
"itemtype": "method",
"name": "setSizeAndPosition",
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 387,
"description": "Adjust the position of the Axis widget's content box for internal axes.",
"itemtype": "method",
"name": "offsetNodeForTick",
"params": [
{
"name": "cb",
"description": "Content box of the Axis.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LeftAxisLayout.js",
"line": 398,
"description": "Sets the width of the axis based on its contents.",
"itemtype": "method",
"name": "setCalculatedSize",
"access": "protected",
"tagname": "",
"class": "LeftAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Lines.js",
"line": 11,
"itemtype": "property",
"name": "_lineDefaults",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Lines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Lines.js",
"line": 18,
"description": "Creates a graphic in which to draw a series.",
"itemtype": "method",
"name": "_getGraphic",
"return": {
"description": "Graphic"
},
"access": "private",
"tagname": "",
"class": "Lines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Lines.js",
"line": 36,
"description": "Toggles visibility",
"itemtype": "method",
"name": "_toggleVisible",
"params": [
{
"name": "visible",
"description": "indicates visibilitye",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "Lines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Lines.js",
"line": 51,
"description": "Draws lines for the series.",
"itemtype": "method",
"name": "drawLines",
"access": "protected",
"tagname": "",
"class": "Lines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Lines.js",
"line": 144,
"description": "Connects data points with a consistent curve for a series.",
"itemtype": "method",
"name": "drawSpline",
"access": "protected",
"tagname": "",
"class": "Lines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Lines.js",
"line": 190,
"description": "Draws a dashed line between two points.",
"itemtype": "method",
"name": "drawDashedLine",
"params": [
{
"name": "xStart",
"description": "The x position of the start of the line",
"type": "Number"
},
{
"name": "yStart",
"description": "The y position of the start of the line",
"type": "Number"
},
{
"name": "xEnd",
"description": "The x position of the end of the line",
"type": "Number"
},
{
"name": "yEnd",
"description": "The y position of the end of the line",
"type": "Number"
},
{
"name": "dashSize",
"description": "the size of dashes, in pixels",
"type": "Number"
},
{
"name": "gapSize",
"description": "the size of gaps between dashes, in pixels",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "Lines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Lines.js",
"line": 242,
"description": "Default values for `styles` attribute.",
"itemtype": "method",
"name": "_getLineDefaults",
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Lines",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LineSeries.js",
"line": 11,
"access": "protected",
"tagname": "",
"itemtype": "method",
"name": "drawSeries",
"class": "LineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LineSeries.js",
"line": 21,
"access": "protected",
"tagname": "Method used by `styles` setter. Overrides base implementation.",
"itemtype": "method",
"name": "_setStyles",
"params": [
{
"name": "newStyles",
"description": "Hash of properties to update.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"class": "LineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LineSeries.js",
"line": 39,
"access": "protected",
"tagname": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"class": "LineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LineSeries.js",
"line": 56,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "line",
"class": "LineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/LineSeries.js",
"line": 67,
"description": "Style properties used for drawing lines. This attribute is inherited from `Renderer`. Below are the default values:\n \n - color
- The color of the line. The default value is determined by the order of the series on the graph. The color will be\n retrieved from the following array: \n `[\"#426ab3\", \"#d09b2c\", \"#000000\", \"#b82837\", \"#b384b5\", \"#ff7200\", \"#779de3\", \"#cbc8ba\", \"#7ed7a6\", \"#007a6c\"]`\n
- weight
- Number that indicates the width of the line. The default value is 6.
\n - alpha
- Number between 0 and 1 that indicates the opacity of the line. The default value is 1.
\n - lineType
- Indicates whether the line is solid or dashed. The default value is solid.
\n - dashLength
- When the `lineType` is dashed, indicates the length of the dash. The default value is 10.
\n - gapSpace
- When the `lineType` is dashed, indicates the distance between dashes. The default value is 10.
\n - connectDiscontinuousPoints
- Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.
\n - discontinuousType
- Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.
\n - discontinuousDashLength
- When the `discontinuousType` is dashed, indicates the length of the dash. The default value is 10.
\n - discontinuousGapSpace
- When the `discontinuousType` is dashed, indicates the distance between dashes. The default value is 10.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "LineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/MarkerSeries.js",
"line": 12,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "MarkerSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/MarkerSeries.js",
"line": 24,
"access": "protected",
"tagname": "Method used by `styles` setter. Overrides base implementation.",
"itemtype": "method",
"name": "_setStyles",
"params": [
{
"name": "newStyles",
"description": "Hash of properties to update.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"class": "MarkerSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/MarkerSeries.js",
"line": 43,
"access": "protected",
"tagname": "Gets the default value for the `styles` attribute. Overrides\nbase implementation.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"class": "MarkerSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/MarkerSeries.js",
"line": 59,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "marker",
"class": "MarkerSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/MarkerSeries.js",
"line": 70,
"description": "Style properties used for drawing markers. This attribute is inherited from `Renderer`. Below are the default values:\n \n - fill
- A hash containing the following values:\n
\n - color
- Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#6084d0\", \"#eeb647\", \"#6c6b5f\", \"#d6484f\", \"#ce9ed1\", \"#ff9f3b\", \"#93b7ff\", \"#e0ddd0\", \"#94ecba\", \"#309687\"]`\n \n - alpha
- Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
\n
\n \n - border
- A hash containing the following values:\n
\n - color
- Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n - alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
\n - weight
- Number indicating the width of the border. The default value is 1.
\n
\n \n - width
- indicates the width of the marker. The default value is 10.
\n - height
- indicates the height of the marker The default value is 10.
\n - over
- hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "MarkerSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 18,
"description": "Indicates whether 0 should always be displayed.",
"itemtype": "attribute",
"name": "alwaysShowZero",
"type": "Boolean",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 28,
"description": "Method used for formatting a label. This attribute allows for the default label formatting method to overridden. The method use would need\nto implement the arguments below and return a `String`.\n\n - val
- Label to be formatted. (`String`)
\n - format
- Object containing properties used to format the label. (optional)
\n
",
"itemtype": "attribute",
"name": "labelFunction",
"type": "Function",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 50,
"description": "Object containing properties used by the `labelFunction` to format a\nlabel.",
"itemtype": "attribute",
"name": "labelFormat",
"type": "Object",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 70,
"description": "Type of data used in `Axis`.",
"itemtype": "property",
"name": "_type",
"readonly": "",
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 79,
"description": "Returns a value based of a key value and an index.",
"itemtype": "method",
"name": "getKeyValueAt",
"params": [
{
"name": "key",
"description": "value used to look up the correct array",
"type": "String"
},
{
"name": "index",
"description": "within the array",
"type": "Number"
}
],
"return": {
"description": "Object"
},
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 98,
"description": "Helper method for getting a `roundingUnit` when calculating the minimum and maximum values.",
"itemtype": "method",
"name": "_getMinimumUnit",
"params": [
{
"name": "max",
"description": "Maximum number",
"type": "Number"
},
{
"name": "min",
"description": "Minimum number",
"type": "Number"
},
{
"name": "units",
"description": "Number of units on the axis",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 113,
"description": "Calculates a nice rounding unit based on the range.",
"itemtype": "method",
"name": "_getNiceNumber",
"params": [
{
"name": "roundingUnit",
"description": "The calculated rounding unit.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 145,
"description": "Calculates the maximum and minimum values for the `Axis`.",
"itemtype": "method",
"name": "_updateMinAndMax",
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 199,
"description": "Rounds the mimimum and maximum values based on the `roundingUnit` attribute.",
"itemtype": "method",
"name": "_roundMinAndMax",
"params": [
{
"name": "min",
"description": "Minimum value",
"type": "Number"
},
{
"name": "max",
"description": "Maximum value",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 486,
"description": "Calculates and returns a value based on the number of labels and the index of\nthe current label.",
"itemtype": "method",
"name": "getLabelByIndex",
"params": [
{
"name": "i",
"description": "Index of the label.",
"type": "Number"
},
{
"name": "l",
"description": "Total number of labels.",
"type": "Number"
}
],
"return": {
"description": "String"
},
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 524,
"description": "Rounds a Number to the nearest multiple of an input. For example, by rounding\n16 to the nearest 10, you will receive 20. Similar to the built-in function Math.round().",
"itemtype": "method",
"name": "_roundToNearest",
"params": [
{
"name": "number",
"description": "Number to round",
"type": "Number"
},
{
"name": "nearest",
"description": "Multiple to round towards.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 545,
"description": "Rounds a Number up to the nearest multiple of an input. For example, by rounding\n16 up to the nearest 10, you will receive 20. Similar to the built-in function Math.ceil().",
"itemtype": "method",
"name": "_roundUpToNearest",
"params": [
{
"name": "number",
"description": "Number to round",
"type": "Number"
},
{
"name": "nearest",
"description": "Multiple to round towards.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 565,
"description": "Rounds a Number down to the nearest multiple of an input. For example, by rounding\n16 down to the nearest 10, you will receive 10. Similar to the built-in function Math.floor().",
"itemtype": "method",
"name": "_roundDownToNearest",
"params": [
{
"name": "number",
"description": "Number to round",
"type": "Number"
},
{
"name": "nearest",
"description": "Multiple to round towards.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 585,
"description": "Rounds a number to a certain level of precision. Useful for limiting the number of\ndecimal places on a fractional number.",
"itemtype": "method",
"name": "_roundToPrecision",
"params": [
{
"name": "number",
"description": "Number to round",
"type": "Number"
},
{
"name": "precision",
"description": "Multiple to round towards.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/NumericAxis.js",
"line": 602,
"description": "Checks to see if data extends beyond the range of the axis. If so,\nthat data will need to be hidden. This method is internal, temporary and subject\nto removal in the future.",
"itemtype": "method",
"name": "_hasDataOverflow",
"access": "protected",
"tagname": "",
"return": {
"description": "Boolean"
},
"class": "NumericAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 10,
"description": "Calculates and returns a `seriesCollection`.",
"itemtype": "method",
"name": "_getSeriesCollection",
"return": {
"description": "Array"
},
"access": "private",
"tagname": "",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 52,
"description": "Creates `Axis` instances.",
"itemtype": "method",
"name": "_parseAxes",
"params": [
{
"name": "val",
"description": "Object containing `Axis` instances or objects in which to construct `Axis` instances.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 105,
"description": "Adds axes to the chart.",
"itemtype": "method",
"name": "_addAxes",
"access": "private",
"tagname": "",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 145,
"description": "Renders the Graph.",
"itemtype": "method",
"name": "_addSeries",
"access": "private",
"tagname": "",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 164,
"description": "Parse and sets the axes for the chart.",
"itemtype": "method",
"name": "_parseSeriesAxes",
"params": [
{
"name": "c",
"description": "A collection `PieSeries` instance.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 209,
"description": "Generates and returns a key-indexed object containing `Axis` instances or objects used to create `Axis` instances.",
"itemtype": "method",
"name": "_getDefaultAxes",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 249,
"description": "Returns an object literal containing a categoryItem and a valueItem for a given series index.",
"itemtype": "method",
"name": "getSeriesItem",
"params": [
{
"name": "series",
"description": "Reference to a series."
},
{
"name": "index",
"description": "Index of the specified item within a series."
}
],
"return": {
"description": "Object"
},
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 274,
"description": "Handler for sizeChanged event.",
"itemtype": "method",
"name": "_sizeChanged",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 290,
"description": "Redraws the chart instance.",
"itemtype": "method",
"name": "_redraw",
"access": "private",
"tagname": "",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 307,
"description": "Axes to appear in the chart.",
"itemtype": "attribute",
"name": "axes",
"type": "Object",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 325,
"description": "Collection of series to appear on the chart. This can be an array of Series instances or object literals\nused to describe a Series instance.",
"itemtype": "attribute",
"name": "seriesCollection",
"type": "Array",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieChart.js",
"line": 344,
"description": "Type of chart when there is no series collection specified.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"class": "PieChart",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 11,
"description": "Image map used for interactivity when rendered with canvas.",
"itemtype": "property",
"name": "_map",
"type": "HTMLElement",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 20,
"description": "Image used for image map when rendered with canvas.",
"itemtype": "property",
"name": "_image",
"type": "HTMLElement",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 29,
"description": "Creates or updates the image map when rendered with canvas.",
"itemtype": "method",
"name": "_setMap",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 65,
"description": "Storage for `categoryDisplayName` attribute.",
"itemtype": "property",
"name": "_categoryDisplayName",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 73,
"description": "Storage for `valueDisplayName` attribute.",
"itemtype": "property",
"name": "_valueDisplayName",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 81,
"description": "Adds event listeners.",
"itemtype": "method",
"name": "addListeners",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 106,
"description": "Draws the series.",
"itemtype": "method",
"name": "validate",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 118,
"description": "Event handler for the categoryAxisChange event.",
"itemtype": "method",
"name": "_categoryAxisChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 132,
"description": "Event handler for the valueAxisChange event.",
"itemtype": "method",
"name": "_valueAxisChangeHandler",
"params": [
{
"name": "e",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 146,
"description": "Constant used to generate unique id.",
"itemtype": "property",
"name": "GUID",
"type": "String",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 155,
"description": "Event handler for categoryDataChange event.",
"itemtype": "method",
"name": "_categoryDataChangeHandler",
"params": [
{
"name": "event",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 170,
"description": "Event handler for valueDataChange event.",
"itemtype": "method",
"name": "_valueDataChangeHandler",
"params": [
{
"name": "event",
"description": "Event object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 185,
"description": "Draws the series. Overrides the base implementation.",
"itemtype": "method",
"name": "draw",
"access": "protected",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 219,
"description": "Draws the markers",
"itemtype": "method",
"name": "drawPlots",
"access": "protected",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 345,
"description": "Adds an interactive map when rendering in canvas.",
"itemtype": "method",
"name": "_addHotspot",
"params": [
{
"name": "cfg",
"description": "Object containing data used to draw the hotspot",
"type": "Object"
},
{
"name": "seriesIndex",
"description": "Index of series in the `seriesCollection`.",
"type": "Number"
},
{
"name": "index",
"description": "Index of the marker using the hotspot.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 402,
"description": "Resizes and positions markers based on a mouse interaction.",
"itemtype": "method",
"name": "updateMarkerState",
"params": [
{
"name": "type",
"description": "state of the marker",
"type": "String"
},
{
"name": "i",
"description": "index of the marker",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 427,
"description": "Creates a shape to be used as a marker.",
"itemtype": "method",
"name": "_createMarker",
"params": [
{
"name": "styles",
"description": "Hash of style properties.",
"type": "Object"
},
{
"name": "order",
"description": "Order of the series.",
"type": "Number"
},
{
"name": "index",
"description": "Index within the series associated with the marker.",
"type": "Number"
}
],
"return": {
"description": "Shape"
},
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 448,
"description": "Creates a cache of markers for reuse.",
"itemtype": "method",
"name": "_createMarkerCache",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 470,
"description": "Gets the default style values for the markers.",
"itemtype": "method",
"name": "_getPlotDefaults",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 499,
"description": "Collection of default colors used for lines in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultLineColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 508,
"description": "Collection of default colors used for marker fills in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultFillColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 517,
"description": "Collection of default colors used for marker borders in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultBorderColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 526,
"description": "Collection of default colors used for area fills, histogram fills and pie fills in a series when not specified by user.",
"itemtype": "property",
"name": "_defaultSliceColors",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 535,
"description": "Colors used if style colors are not specified",
"itemtype": "method",
"name": "_getDefaultColor",
"params": [
{
"name": "index",
"description": "Index indicating the series order.",
"type": "Number"
},
{
"name": "type",
"description": "Indicates which type of object needs the color.",
"type": "String"
}
],
"return": {
"description": "String"
},
"access": "protected",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 564,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "pie",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 575,
"description": "Order of this instance of this `type`.",
"itemtype": "attribute",
"name": "order",
"type": "Number",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 583,
"description": "Reference to the `Graph` in which the series is drawn into.",
"itemtype": "attribute",
"name": "graph",
"type": "Graph",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 591,
"description": "Reference to the `Axis` instance used for assigning \ncategory values to the graph.",
"itemtype": "attribute",
"name": "categoryAxis",
"type": "Axis",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 607,
"description": "Reference to the `Axis` instance used for assigning \nseries values to the graph.",
"itemtype": "attribute",
"name": "categoryAxis",
"type": "Axis",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 623,
"description": "Indicates which array to from the hash of value arrays in \nthe category `Axis` instance.",
"itemtype": "attribute",
"name": "categoryKey",
"type": "String",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 638,
"description": "Indicates which array to from the hash of value arrays in \nthe value `Axis` instance.",
"itemtype": "attribute",
"name": "valueKey",
"type": "String",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 654,
"description": "Name used for for displaying category data",
"itemtype": "attribute",
"name": "categoryDisplayName",
"type": "String",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 673,
"description": "Name used for for displaying value data",
"itemtype": "attribute",
"name": "valueDisplayName",
"type": "String",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 692,
"itemtype": "attribute",
"name": "slices",
"type": "Array",
"access": "private",
"tagname": "",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/PieSeries.js",
"line": 699,
"description": "Style properties used for drawing markers. This attribute is inherited from `MarkerSeries`. Below are the default values:\n \n - fill
- A hash containing the following values:\n
\n - colors
- An array of colors to be used for the marker fills. The color for each marker is retrieved from the \n array below:
\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n \n - alphas
- An array of alpha references (Number from 0 to 1) indicating the opacity of each marker fill. The default value is [1].
\n
\n \n - border
- A hash containing the following values:\n
\n - color
- An array of colors to be used for the marker borders. The color for each marker is retrieved from the\n array below:
\n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n - alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
\n - weight
- Number indicating the width of the border. The default value is 1.
\n
\n \n - over
- hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "PieSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 22,
"description": "Storage for default marker styles.",
"itemtype": "property",
"name": "_plotDefaults",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 31,
"description": "Draws the markers",
"itemtype": "method",
"name": "drawPlots",
"access": "protected",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 93,
"description": "Gets the default values for series that use the utility. This method is used by\nthe class' `styles` attribute's getter to get build default values.",
"itemtype": "method",
"name": "_getPlotDefaults",
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 124,
"description": "Collection of markers to be used in the series.",
"itemtype": "property",
"name": "_markers",
"type": "Array",
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 133,
"description": "Collection of markers to be re-used on a series redraw.",
"itemtype": "property",
"name": "_markerCache",
"type": "Array",
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 142,
"description": "Gets and styles a marker. If there is a marker in cache, it will use it. Otherwise\nit will create one.",
"itemtype": "method",
"name": "getMarker",
"params": [
{
"name": "styles",
"description": "Hash of style properties.",
"type": "Object"
},
{
"name": "order",
"description": "Order of the series.",
"type": "Number"
},
{
"name": "index",
"description": "Index within the series associated with the marker.",
"type": "Number"
}
],
"return": {
"description": "Shape"
},
"access": "protected",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 184,
"description": "Creates a shape to be used as a marker.",
"itemtype": "method",
"name": "_createMarker",
"params": [
{
"name": "styles",
"description": "Hash of style properties.",
"type": "Object"
},
{
"name": "order",
"description": "Order of the series.",
"type": "Number"
},
{
"name": "index",
"description": "Index within the series associated with the marker.",
"type": "Number"
}
],
"return": {
"description": "Shape"
},
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 206,
"description": "Creates a cache of markers for reuse.",
"itemtype": "method",
"name": "_createMarkerCache",
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 225,
"description": "Toggles visibility",
"itemtype": "method",
"name": "_toggleVisible",
"params": [
{
"name": "visible",
"description": "indicates visibilitye",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 252,
"description": "Removes unused markers from the marker cache",
"itemtype": "method",
"name": "_clearMarkerCache",
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 271,
"description": "Resizes and positions markers based on a mouse interaction.",
"itemtype": "method",
"name": "updateMarkerState",
"params": [
{
"name": "type",
"description": "state of the marker",
"type": "String"
},
{
"name": "i",
"description": "index of the marker",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 303,
"description": "Parses a color from an array.",
"itemtype": "method",
"name": "_getItemColor",
"params": [
{
"name": "val",
"description": "collection of colors",
"type": "Array"
},
{
"name": "i",
"description": "index of the item",
"type": "Number"
}
],
"return": {
"description": "String"
},
"access": "protected",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 321,
"description": "Method used by `styles` setter. Overrides base implementation.",
"itemtype": "method",
"name": "_setStyles",
"params": [
{
"name": "newStyles",
"description": "Hash of properties to update.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 335,
"description": "Combines new styles with existing styles.",
"itemtype": "method",
"name": "_parseMarkerStyles",
"params": [
{
"name": "Object",
"description": "containing style properties for the marker.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 361,
"description": "Returns marker state based on event type",
"itemtype": "method",
"name": "_getState",
"params": [
{
"name": "type",
"description": "event type",
"type": "String"
}
],
"return": {
"description": "String"
},
"access": "protected",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Plots.js",
"line": 390,
"itemtype": "property",
"name": "_statSyles",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Plots",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Renderer.js",
"line": 28,
"description": "Style properties for class",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "Renderer",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Renderer.js",
"line": 48,
"description": "The graphic in which drawings will be rendered.",
"itemtype": "attribute",
"name": "graphic",
"type": "Graphic",
"class": "Renderer",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Renderer.js",
"line": 59,
"description": "Storage for `styles` attribute.",
"itemtype": "property",
"name": "_styles",
"type": "Object",
"access": "private",
"tagname": "",
"class": "Renderer",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Renderer.js",
"line": 68,
"description": "Method used by `styles` setter.",
"itemtype": "method",
"name": "_setStyles",
"params": [
{
"name": "newStyles",
"description": "Hash of properties to update.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Renderer",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Renderer.js",
"line": 82,
"description": "Merges to object literals so that only specified properties are \noverwritten.",
"itemtype": "method",
"name": "_mergeStyles",
"params": [
{
"name": "a",
"description": "Hash of new styles",
"type": "Object"
},
{
"name": "b",
"description": "Hash of original styles",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Renderer",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/Renderer.js",
"line": 113,
"description": "Gets the default value for the `styles` attribute.",
"itemtype": "method",
"name": "_getDefaultStyles",
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "Renderer",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 11,
"description": "Default margins for text fields.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getDefaultMargins",
"return": {
"description": "Object"
},
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 28,
"description": "Sets the length of the tick on either side of the axis line.",
"itemtype": "method",
"name": "setTickOffset",
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 65,
"description": "Draws a tick",
"itemtype": "method",
"name": "drawTick",
"params": [
{
"name": "path",
"description": "reference to the path `Path` element in which to draw the tick.",
"type": "Path"
},
{
"name": "pt",
"description": "Point on the axis in which the tick will intersect.",
"type": "Object"
},
{
"name": "{Object)",
"description": "tickStyle Hash of properties to apply to the tick."
}
],
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 85,
"description": "Calculates the coordinates for the first point on an axis.",
"itemtype": "method",
"name": "getLineStart",
"return": {
"description": "",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 112,
"description": "Calculates the point for a label.",
"itemtype": "method",
"name": "getLabelPoint",
"params": [
{
"name": "point",
"description": "Point on the axis in which the tick will intersect.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Object"
},
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 125,
"description": "Updates the value for the `maxLabelSize` for use in calculating total size.",
"itemtype": "method",
"name": "updateMaxLabelSize",
"params": [
{
"name": "label",
"description": "to measure",
"type": "HTMLElement"
}
],
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 169,
"description": "Rotate and position title.",
"itemtype": "method",
"name": "positionTitle",
"params": [
{
"name": "label",
"description": "to rotate position",
"type": "HTMLElement"
}
],
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 265,
"description": "Rotate and position labels.",
"itemtype": "method",
"name": "positionLabel",
"params": [
{
"name": "label",
"description": "to rotate position",
"type": "HTMLElement"
},
{
"name": "pt",
"description": "hash containing the x and y coordinates in which the label will be positioned\nagainst.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 351,
"description": "Calculates the size and positions the content elements.",
"itemtype": "method",
"name": "setSizeAndPosition",
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 373,
"description": "Adjusts position for inner ticks.",
"itemtype": "method",
"name": "offsetNodeForTick",
"params": [
{
"name": "cb",
"description": "contentBox of the axis",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/RightAxisLayout.js",
"line": 388,
"description": "Assigns a height based on the size of the contents.",
"itemtype": "method",
"name": "setCalculatedSize",
"access": "protected",
"tagname": "",
"class": "RightAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/SplineSeries.js",
"line": 12,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "SplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/SplineSeries.js",
"line": 25,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "spline",
"class": "SplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/SplineSeries.js",
"line": 36,
"description": "Style properties used for drawing lines. This attribute is inherited from `Renderer`. Below are the default values:\n \n - color
- The color of the line. The default value is determined by the order of the series on the graph. The color will be\n retrieved from the following array: \n `[\"#426ab3\", \"#d09b2c\", \"#000000\", \"#b82837\", \"#b384b5\", \"#ff7200\", \"#779de3\", \"#cbc8ba\", \"#7ed7a6\", \"#007a6c\"]`\n
- weight
- Number that indicates the width of the line. The default value is 6.
\n - alpha
- Number between 0 and 1 that indicates the opacity of the line. The default value is 1.
\n - lineType
- Indicates whether the line is solid or dashed. The default value is solid.
\n - dashLength
- When the `lineType` is dashed, indicates the length of the dash. The default value is 10.
\n - gapSpace
- When the `lineType` is dashed, indicates the distance between dashes. The default value is 10.
\n - connectDiscontinuousPoints
- Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.
\n - discontinuousType
- Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.
\n - discontinuousDashLength
- When the `discontinuousType` is dashed, indicates the length of the dash. The default value is 10.
\n - discontinuousGapSpace
- When the `discontinuousType` is dashed, indicates the distance between dashes. The default value is 10.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "SplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedAreaSeries.js",
"line": 12,
"access": "protected",
"tagname": "Calculates the coordinates for the series. Overrides base implementation.",
"itemtype": "method",
"name": "setAreaData",
"class": "StackedAreaSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedAreaSeries.js",
"line": 25,
"access": "protected",
"tagname": "Draws the series",
"itemtype": "method",
"name": "drawSeries",
"class": "StackedAreaSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedAreaSeries.js",
"line": 38,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedArea",
"class": "StackedAreaSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedAreaSplineSeries.js",
"line": 12,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "StackedAreaSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedAreaSplineSeries.js",
"line": 26,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedAreaSpline",
"class": "StackedAreaSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedAxis.js",
"line": 20,
"description": "Calculates the maximum and minimum values for the `Axis`.",
"itemtype": "method",
"name": "_updateMinAndMax",
"access": "private",
"tagname": "",
"class": "StackedAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedBarSeries.js",
"line": 12,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "StackedBarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedBarSeries.js",
"line": 141,
"access": "protected",
"tagname": "Resizes and positions markers based on a mouse interaction.",
"itemtype": "method",
"name": "updateMarkerState",
"params": [
{
"name": "type",
"description": "state of the marker",
"type": "String"
},
{
"name": "i",
"description": "index of the marker",
"type": "Number"
}
],
"class": "StackedBarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedBarSeries.js",
"line": 168,
"access": "protected",
"tagname": "Returns default values for the `styles` attribute.",
"itemtype": "method",
"name": "_getPlotDefaults",
"return": {
"description": "Object"
},
"class": "StackedBarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedBarSeries.js",
"line": 207,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedBar",
"class": "StackedBarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedBarSeries.js",
"line": 218,
"description": "Direction of the series",
"itemtype": "attribute",
"name": "direction",
"type": "String",
"default": "vertical",
"class": "StackedBarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedBarSeries.js",
"line": 229,
"access": "private",
"tagname": "",
"itemtype": "attribute",
"name": "negativeBaseValues",
"type": "Array",
"default": "null",
"class": "StackedBarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedBarSeries.js",
"line": 240,
"access": "private",
"tagname": "",
"itemtype": "attribute",
"name": "positiveBaseValues",
"type": "Array",
"default": "null",
"class": "StackedBarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedBarSeries.js",
"line": 251,
"description": "Style properties used for drawing markers. This attribute is inherited from `BarSeries`. Below are the default values:\n \n - fill
- A hash containing the following values:\n
\n - color
- Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n \n - alpha
- Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
\n
\n \n - border
- A hash containing the following values:\n
\n - color
- Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n - alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
\n - weight
- Number indicating the width of the border. The default value is 1.
\n
\n \n - height
- indicates the width of the marker. The default value is 24.
\n - over
- hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "StackedBarSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedColumnSeries.js",
"line": 12,
"description": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"access": "protected",
"tagname": "",
"class": "StackedColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedColumnSeries.js",
"line": 140,
"description": "Resizes and positions markers based on a mouse interaction.",
"itemtype": "method",
"name": "updateMarkerState",
"params": [
{
"name": "type",
"description": "state of the marker",
"type": "String"
},
{
"name": "i",
"description": "index of the marker",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "StackedColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedColumnSeries.js",
"line": 169,
"description": "Gets the default values for the markers.",
"itemtype": "method",
"name": "_getPlotDefaults",
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "StackedColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedColumnSeries.js",
"line": 207,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedColumn",
"class": "StackedColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedColumnSeries.js",
"line": 218,
"itemtype": "attribute",
"name": "negativeBaseValues",
"type": "Array",
"default": "null",
"access": "private",
"tagname": "",
"class": "StackedColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedColumnSeries.js",
"line": 228,
"itemtype": "attribute",
"name": "positiveBaseValues",
"type": "Array",
"default": "null",
"access": "private",
"tagname": "",
"class": "StackedColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedColumnSeries.js",
"line": 238,
"description": "Style properties used for drawing markers. This attribute is inherited from `ColumnSeries`. Below are the default values:\n \n - fill
- A hash containing the following values:\n
\n - color
- Color of the fill. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#66007f\", \"#a86f41\", \"#295454\", \"#996ab2\", \"#e8cdb7\", \"#90bdbd\",\"#000000\",\"#c3b8ca\", \"#968373\", \"#678585\"]`\n \n - alpha
- Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
\n
\n \n - border
- A hash containing the following values:\n
\n - color
- Color of the border. The default value is determined by the order of the series on the graph. The color\n will be retrieved from the below array:
\n `[\"#205096\", \"#b38206\", \"#000000\", \"#94001e\", \"#9d6fa0\", \"#e55b00\", \"#5e85c9\", \"#adab9e\", \"#6ac291\", \"#006457\"]`\n - alpha
- Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
\n - weight
- Number indicating the width of the border. The default value is 1.
\n
\n \n - width
- indicates the width of the marker. The default value is 24.
\n - over
- hash containing styles for markers when highlighted by a `mouseover` event. The default \n values for each style is null. When an over style is not set, the non-over value will be used. For example,\n the default value for `marker.over.fill.color` is equivalent to `marker.fill.color`.
\n
",
"itemtype": "attribute",
"name": "styles",
"type": "Object",
"class": "StackedColumnSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedComboSeries.js",
"line": 14,
"access": "protected",
"tagname": "Calculates the coordinates for the series. Overrides base implementation.",
"itemtype": "method",
"name": "setAreaData",
"class": "StackedComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedComboSeries.js",
"line": 27,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "StackedComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedComboSeries.js",
"line": 52,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedCombo",
"class": "StackedComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedComboSeries.js",
"line": 63,
"description": "Indicates whether a fill is displayed.",
"itemtype": "attribute",
"name": "showAreaFill",
"type": "Boolean",
"default": "true",
"class": "StackedComboSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedComboSplineSeries.js",
"line": 14,
"access": "protected",
"tagname": "Draws the series.",
"itemtype": "method",
"name": "drawSeries",
"class": "StackedComboSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedComboSplineSeries.js",
"line": 38,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedComboSpline",
"class": "StackedComboSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedComboSplineSeries.js",
"line": 49,
"description": "Indicates whether a fill is displayed.",
"itemtype": "attribute",
"name": "showAreaFill",
"type": "Boolean",
"default": "true",
"class": "StackedComboSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedLineSeries.js",
"line": 12,
"access": "protected",
"tagname": "Calculates the coordinates for the series. Overrides base implementation.",
"itemtype": "method",
"name": "setAreaData",
"class": "StackedLineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedLineSeries.js",
"line": 26,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedLine",
"class": "StackedLineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedMarkerSeries.js",
"line": 12,
"access": "protected",
"tagname": "Calculates the coordinates for the series. Overrides base implementation.",
"itemtype": "method",
"name": "setAreaData",
"class": "StackedMarkerSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedMarkerSeries.js",
"line": 26,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedMarker",
"class": "StackedMarkerSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedSplineSeries.js",
"line": 12,
"access": "protected",
"tagname": "Calculates the coordinates for the series. Overrides base implementation.",
"itemtype": "method",
"name": "setAreaData",
"class": "StackedSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackedSplineSeries.js",
"line": 26,
"description": "Read-only attribute indicating the type of series.",
"itemtype": "attribute",
"name": "type",
"type": "String",
"default": "stackedSpline",
"class": "StackedSplineSeries",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/StackingUtil.js",
"line": 11,
"access": "protected",
"tagname": "Adjusts coordinate values for stacked series.",
"itemtype": "method",
"name": "_stackCoordinates",
"class": "StackingUtil",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 19,
"description": "Indicates whether the maximum is calculated or explicitly set.",
"itemtype": "attribute",
"name": "setMax",
"readonly": "",
"type": "Boolean",
"access": "private",
"tagname": "",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 37,
"description": "Indicates whether the minimum is calculated or explicitly set.",
"itemtype": "attribute",
"name": "setMin",
"readonly": "",
"type": "Boolean",
"access": "private",
"tagname": "",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 55,
"description": "The maximum value that will appear on an axis. Unless explicitly set, this value is calculated by the `Axis`.",
"itemtype": "attribute",
"name": "maximum",
"type": "Number",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 78,
"description": "The minimum value that will appear on an axis. Unless explicitly set, this value is calculated by the `Axis`.",
"itemtype": "attribute",
"name": "minimum",
"type": "Number",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 101,
"description": "Method used for formatting a label. This attribute allows for the default label formatting method to overridden. The method use would need\nto implement the arguments below and return a `String`.\n\n - val
- Label to be formatted. (`String`)
\n - format
- STRFTime string used to format the label. (optional)
\n
",
"itemtype": "attribute",
"name": "labelFunction",
"type": "Function",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 124,
"description": "Pattern used by the `labelFunction` to format a label.",
"itemtype": "attribute",
"name": "labelFormat",
"type": "String",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 136,
"description": "Constant used to generate unique id.",
"itemtype": "property",
"name": "GUID",
"type": "String",
"access": "private",
"tagname": "",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 145,
"description": "Type of data used in `Axis`.",
"itemtype": "property",
"name": "_dataType",
"readonly": "",
"access": "private",
"tagname": "",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 154,
"description": "Calculates and returns a value based on the number of labels and the index of\nthe current label.",
"itemtype": "method",
"name": "getLabelByIndex",
"params": [
{
"name": "i",
"description": "Index of the label.",
"type": "Number"
},
{
"name": "l",
"description": "Total number of labels.",
"type": "Number"
}
],
"return": {
"description": "String"
},
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 183,
"description": "Gets an array of values based on a key.",
"itemtype": "method",
"name": "_getKeyArray",
"params": [
{
"name": "key",
"description": "Value key associated with the data array.",
"type": "String"
},
{
"name": "data",
"description": "Array in which the data resides.",
"type": "Array"
}
],
"return": {
"description": "Array"
},
"access": "private",
"tagname": "",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 238,
"description": "Sets data by key",
"itemtype": "method",
"name": "_setDataByKey",
"params": [
{
"name": "key",
"description": "Key value to use.",
"type": "String"
},
{
"name": "data",
"description": "Array to use.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TimeAxis.js",
"line": 294,
"description": "Parses value into a number.",
"itemtype": "method",
"name": "_getNumber",
"params": [
{
"name": "val",
"description": "Value to parse into a number",
"type": "Object"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "TimeAxis",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 11,
"description": "Default margins for text fields.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getDefaultMargins",
"return": {
"description": "Object"
},
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 28,
"description": "Sets the length of the tick on either side of the axis line.",
"itemtype": "method",
"name": "setTickOffsets",
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 64,
"description": "Calculates the coordinates for the first point on an axis.",
"itemtype": "method",
"name": "getLineStart",
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 90,
"description": "Draws a tick",
"itemtype": "method",
"name": "drawTick",
"params": [
{
"name": "path",
"description": "reference to the path `Path` element in which to draw the tick.",
"type": "Path"
},
{
"name": "pt",
"description": "hash containing x and y coordinates",
"type": "Object"
},
{
"name": "tickStyles",
"description": "hash of properties used to draw the tick",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 110,
"description": "Calculates the point for a label.",
"itemtype": "method",
"name": "getLabelPoint",
"params": [
{
"name": "pt",
"description": "hash containing x and y coordinates",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 123,
"description": "Updates the value for the `maxLabelSize` for use in calculating total size.",
"itemtype": "method",
"name": "updateMaxLabelSize",
"params": [
{
"name": "label",
"description": "to measure",
"type": "HTMLElement"
}
],
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 167,
"description": "Rotate and position title.",
"itemtype": "method",
"name": "positionTitle",
"params": [
{
"name": "label",
"description": "to rotate position",
"type": "HTMLElement"
}
],
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 262,
"description": "Rotate and position labels.",
"itemtype": "method",
"name": "positionLabel",
"params": [
{
"name": "label",
"description": "to rotate position",
"type": "HTMLElement"
},
{
"name": "pt",
"description": "hash containing the x and y coordinates in which the label will be positioned\nagainst.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 360,
"description": "Calculates the size and positions the content elements.",
"itemtype": "method",
"name": "setSizeAndPosition",
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 388,
"description": "Adjusts position for inner ticks.",
"itemtype": "method",
"name": "offsetNodeForTick",
"params": [
{
"name": "cb",
"description": "contentBox of the axis",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/charts/js/TopAxisLayout.js",
"line": 399,
"description": "Assigns a height based on the size of the contents.",
"itemtype": "method",
"name": "setCalculatedSize",
"access": "protected",
"tagname": "",
"class": "TopAxisLayout",
"module": "charts"
},
{
"file": "lib/yui3/src/classnamemanager/js/classnamemanager.js",
"line": 26,
"description": "Configuration property indicating the prefix for all CSS class names in this YUI instance.",
"itemtype": "property",
"name": "classNamePrefix",
"type": "{String}",
"default": "\"yui\"",
"static": 1,
"class": "ClassNameManager",
"module": "classnamemanager"
},
{
"file": "lib/yui3/src/classnamemanager/js/classnamemanager.js",
"line": 36,
"description": "Configuration property indicating the delimiter used to compose all CSS class names in\nthis YUI instance.",
"itemtype": "property",
"name": "classNameDelimiter",
"type": "{String}",
"default": "\"-\"",
"static": 1,
"class": "ClassNameManager",
"module": "classnamemanager"
},
{
"file": "lib/yui3/src/classnamemanager/js/classnamemanager.js",
"line": 54,
"description": "Returns a class name prefixed with the the value of the \nY.config.classNamePrefix attribute + the provided strings.\nUses the Y.config.classNameDelimiter attribute to delimit the \nprovided strings. E.g. Y.ClassNameManager.getClassName('foo','bar'); // yui-foo-bar",
"itemtype": "method",
"name": "getClassName",
"params": [
{
"name": "+",
"description": "classnameSection one or more classname sections to be joined",
"type": "String"
},
{
"name": "skipPrefix",
"description": "If set to true, the classname will not be prefixed with the default Y.config.classNameDelimiter value.",
"type": "Boolean"
}
],
"class": "ClassNameManager",
"module": "classnamemanager"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 10,
"description": "Returns the index of the last item in the array that contains the specified\nvalue, or `-1` if the value isn't found.",
"itemtype": "method",
"name": "lastIndexOf",
"params": [
{
"name": "a",
"description": "Array to search in.",
"type": "Array"
},
{
"name": "val",
"description": "Value to search for.",
"type": "Any"
},
{
"name": "fromIndex",
"description": "Index at which to start searching backwards.\n Defaults to the array's length - 1. If negative, it will be taken as an offset\n from the end of the array. If the calculated index is less than 0, the array\n will not be searched and `-1` will be returned.",
"type": "Number",
"optional": true
}
],
"return": {
"description": "Index of the item that contains the value, or `-1` if not\n found.",
"type": "Number"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 53,
"description": "Returns a copy of the specified array with duplicate items removed.",
"itemtype": "method",
"name": "unique",
"params": [
{
"name": "a",
"description": "Array to dedupe.",
"type": "Array"
}
],
"return": {
"description": "Copy of the array with duplicate items removed.",
"type": "Array"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 105,
"description": "Executes the supplied function on each item in the array. Returns a new array\ncontaining the items for which the supplied function returned a truthy value.",
"itemtype": "method",
"name": "filter",
"params": [
{
"name": "a",
"description": "Array to filter.",
"type": "Array"
},
{
"name": "f",
"description": "Function to execute on each item.",
"type": "Function"
},
{
"name": "o",
"description": "Optional context object.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "Array of items for which the supplied function returned a\n truthy value (empty if it never returned a truthy value).",
"type": "Array"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 140,
"description": "The inverse of `Array.filter()`. Executes the supplied function on each item.\nReturns a new array containing the items for which the supplied function\nreturned `false`.",
"itemtype": "method",
"name": "reject",
"params": [
{
"name": "a",
"description": "the array to iterate.",
"type": "Array"
},
{
"name": "f",
"description": "the function to execute on each item.",
"type": "Function"
},
{
"name": "o",
"description": "Optional context object.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "The items for which the supplied function returned `false`.",
"type": "Array"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 158,
"description": "Executes the supplied function on each item in the array. Iteration stops if the\nsupplied function does not return a truthy value.",
"itemtype": "method",
"name": "every",
"params": [
{
"name": "a",
"description": "the array to iterate.",
"type": "Array"
},
{
"name": "f",
"description": "the function to execute on each item.",
"type": "Function"
},
{
"name": "o",
"description": "Optional context object.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "`true` if every item in the array returns `true` from the\n supplied function, `false` otherwise.",
"type": "Boolean"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 184,
"description": "Executes the supplied function on each item in the array and returns a new array\ncontaining all the values returned by the supplied function.",
"example": [
"\n\n // Convert an array of numbers into an array of strings.\n Y.Array.map([1, 2, 3, 4], function (item) {\n return '' + item;\n });\n // => ['1', '2', '3', '4']"
],
"itemtype": "method",
"name": "map",
"params": [
{
"name": "a",
"description": "the array to iterate.",
"type": "Array"
},
{
"name": "f",
"description": "the function to execute on each item.",
"type": "Function"
},
{
"name": "o",
"description": "Optional context object.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "A new array containing the return value of the supplied function\n for each item in the original array.",
"type": "Array"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 223,
"description": "Executes the supplied function on each item in the array, \"folding\" the array\ninto a single value.",
"itemtype": "method",
"name": "reduce",
"params": [
{
"name": "a",
"description": "Array to iterate.",
"type": "Array"
},
{
"name": "init",
"description": "Initial value to start with.",
"type": "Any"
},
{
"name": "f",
"description": "Function to execute on each item. This function should\n update and return the value of the computation. It will receive the following\n arguments:",
"type": "Function",
"props": [
{
"name": "previousValue",
"description": "Value returned from the previous iteration,\n or the initial value if this is the first iteration.",
"type": "Any"
},
{
"name": "currentValue",
"description": "Value of the current item being iterated.",
"type": "Any"
},
{
"name": "index",
"description": "Index of the current item.",
"type": "Number"
},
{
"name": "array",
"description": "Array being iterated.",
"type": "Array"
}
]
},
{
"name": "o",
"description": "Optional context object.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "Final result from iteratively applying the given function to each\n element in the array.",
"type": "Any"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 265,
"description": "Executes the supplied function on each item in the array, searching for the\nfirst item that matches the supplied function.",
"itemtype": "method",
"name": "find",
"params": [
{
"name": "a",
"description": "the array to search.",
"type": "Array"
},
{
"name": "f",
"description": "the function to execute on each item. Iteration is stopped\n as soon as this function returns `true`.",
"type": "Function"
},
{
"name": "o",
"description": "Optional context object.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "the first item that the supplied function returns `true` for,\n or `null` if it never returns `true`.",
"type": "Object"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 287,
"description": "Iterates over an array, returning a new array of all the elements that match the\nsupplied regular expression.",
"itemtype": "method",
"name": "grep",
"params": [
{
"name": "a",
"description": "Array to iterate over.",
"type": "Array"
},
{
"name": "pattern",
"description": "Regular expression to test against each item.",
"type": "RegExp"
}
],
"return": {
"description": "All the items in the array that produce a match against the\n supplied regular expression. If no items match, an empty array is returned.",
"type": "Array"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 304,
"description": "Partitions an array into two new arrays, one with the items for which the\nsupplied function returns `true`, and one with the items for which the function\nreturns `false`.",
"itemtype": "method",
"name": "partition",
"params": [
{
"name": "a",
"description": "Array to iterate over.",
"type": "Array"
},
{
"name": "f",
"description": "Function to execute for each item in the array. It will\n receive the following arguments:",
"type": "Function",
"props": [
{
"name": "item",
"description": "Current item.",
"type": "Any"
},
{
"name": "index",
"description": "Index of the current item.",
"type": "Number"
},
{
"name": "array",
"description": "The array being iterated.",
"type": "Array"
}
]
},
{
"name": "o",
"description": "Optional execution context.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "An object with two properties: `matches` and `rejects`. Each is\n an array containing the items that were selected or rejected by the test\n function (or an empty array if none).",
"type": "Object"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/array-extras.js",
"line": 336,
"description": "Creates an array of arrays by pairing the corresponding elements of two arrays\ntogether into a new array.",
"itemtype": "method",
"name": "zip",
"params": [
{
"name": "a",
"description": "Array to iterate over.",
"type": "Array"
},
{
"name": "a2",
"description": "Another array whose values will be paired with values of the\n first array.",
"type": "Array"
}
],
"return": {
"description": "An array of arrays formed by pairing each element of the first\n array with an item in the second array having the corresponding index.",
"type": "Array"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-extras"
},
{
"file": "lib/yui3/src/collection/js/arraylist-add.js",
"line": 13,
"description": "Add a single item to the ArrayList. Does not prevent duplicates.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "item",
"description": "Item presumably of the same type as others in the\n ArrayList.",
"type": "Mixed"
},
{
"name": "index",
"description": "(Optional.) Number representing the position at\nwhich the item should be inserted.",
"type": "Number"
}
],
"return": {
"description": "the instance.",
"type": "ArrayList"
},
"chainable": 1,
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist-add"
},
{
"file": "lib/yui3/src/collection/js/arraylist-add.js",
"line": 38,
"description": "Removes first or all occurrences of an item to the ArrayList. If a\ncomparator is not provided, uses itemsAreEqual method to determine\nmatches.",
"itemtype": "method",
"name": "remove",
"params": [
{
"name": "needle",
"description": "Item to find and remove from the list.",
"type": "Mixed"
},
{
"name": "all",
"description": "If true, remove all occurrences.",
"type": "Boolean"
},
{
"name": "comparator",
"description": "optional a/b function to test equivalence.",
"type": "Function"
}
],
"return": {
"description": "the instance.",
"type": "ArrayList"
},
"chainable": 1,
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist-add"
},
{
"file": "lib/yui3/src/collection/js/arraylist-add.js",
"line": 66,
"description": "Default comparator for items stored in this list. Used by remove().",
"itemtype": "method",
"name": "itemsAreEqual",
"params": [
{
"name": "a",
"description": "item to test equivalence with.",
"type": "Mixed"
},
{
"name": "b",
"description": "other item to test equivalance.",
"type": "Mixed"
}
],
"return": {
"description": "true if items are deemed equivalent.",
"type": "Boolean"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist-add"
},
{
"file": "lib/yui3/src/collection/js/arraylist-filter.js",
"line": 12,
"description": "Create a new ArrayList (or augmenting class instance) from a subset\nof items as determined by the boolean function passed as the\nargument. The original ArrayList is unchanged.
\n\nThe validator signature is validator( item ).
",
"itemtype": "method",
"name": "filter",
"params": [
{
"name": "validator",
"description": "Boolean function to determine in or out.",
"type": "Function"
}
],
"return": {
"description": "New instance based on who passed the validator.",
"type": "ArrayList"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist-filter"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 37,
"description": "Get an item by index from the list. Override this method if managing a\nlist of objects that have a different public representation (e.g. Node\ninstances vs DOM nodes). The iteration methods that accept a user\nfunction will use this method for access list items for operation.",
"itemtype": "method",
"name": "item",
"params": [
{
"name": "i",
"description": "index to fetch",
"type": "Integer"
}
],
"return": {
"description": "the item at the requested index",
"type": "Mixed"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 51,
"description": "Execute a function on each item of the list, optionally providing a\ncustom execution context. Default context is the item.
\n\nThe callback signature is callback( item, index ).
",
"itemtype": "method",
"name": "each",
"params": [
{
"name": "fn",
"description": "the function to execute",
"type": "Function"
},
{
"name": "context",
"description": "optional override 'this' in the function",
"type": "Mixed"
}
],
"return": {
"description": "this instance",
"type": "ArrayList"
},
"chainable": 1,
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 73,
"description": "Execute a function on each item of the list, optionally providing a\ncustom execution context. Default context is the item.
\n\nThe callback signature is callback( item, index ).
\n\nUnlike each, if the callback returns true, the\niteratation will stop.
",
"itemtype": "method",
"name": "some",
"params": [
{
"name": "fn",
"description": "the function to execute",
"type": "Function"
},
{
"name": "context",
"description": "optional override 'this' in the function",
"type": "Mixed"
}
],
"return": {
"description": "True if the function returned true on an item",
"type": "Boolean"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 95,
"description": "Finds the first index of the needle in the managed array of items.",
"itemtype": "method",
"name": "indexOf",
"params": [
{
"name": "needle",
"description": "The item to search for",
"type": "Mixed"
}
],
"return": {
"description": "Array index if found. Otherwise -1",
"type": "Integer"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 106,
"description": "How many items are in this list?",
"itemtype": "method",
"name": "size",
"return": {
"description": "Number of items in the list",
"type": "Integer"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 116,
"description": "Is this instance managing any items?",
"itemtype": "method",
"name": "isEmpty",
"return": {
"description": "true if 1 or more items are being managed",
"type": "Boolean"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 126,
"description": "Provides an array-like representation for JSON.stringify.",
"itemtype": "method",
"name": "toJSON",
"return": {
"description": "an array representation of the ArrayList",
"type": "Array"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 138,
"description": "Protected method for optimizations that may be appropriate for API\nmirroring. Similar in functionality to item, but is used by\nmethods added with ArrayList.addMethod().",
"itemtype": "method",
"name": "_item",
"access": "protected",
"tagname": "",
"params": [
{
"name": "i",
"description": "Index of item to fetch",
"type": "Integer"
}
],
"return": {
"description": "The item appropriate for pass through API methods",
"type": "Mixed"
},
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/arraylist.js",
"line": 154,
"description": "Adds a pass through method to dest (typically the prototype of a list\nclass) that calls the named method on each item in the list with\nwhatever parameters are passed in. Allows for API indirection via list\ninstances.
\n\nAccepts a single string name or an array of string names.
\n\n
list.each( function ( item ) {\n item.methodName( 1, 2, 3 );\n} );\n// becomes\nlist.methodName( 1, 2, 3 );
\n\n
Additionally, the pass through methods use the item retrieved by the\n_item method in case there is any special behavior that is\nappropriate for API mirroring.
\n\n
If the iterated method returns a value, the return value from the\nadded method will be an array of values with each value being at the\ncorresponding index for that item. If the iterated method does not\nreturn a value, the added method will be chainable.",
"itemtype": "method",
"name": "addMethod",
"static": 1,
"params": [
{
"name": "dest",
"description": "Object or prototype to receive the iterator method",
"type": "Object"
},
{
"name": "name",
"description": "Name of method of methods to create",
"type": "String|String[]"
}
],
"class": "ArrayList",
"module": "collection",
"submodule": "arraylist"
},
{
"file": "lib/yui3/src/collection/js/invoke.js",
"line": 6,
"description": "Executes a named method on each item in an array of objects. Items in the array\nthat do not have a function by that name will be skipped.",
"example": [
"\n\n Y.Array.invoke(arrayOfDrags, 'plug', Y.Plugin.DDProxy);"
],
"itemtype": "method",
"name": "invoke",
"params": [
{
"name": "items",
"description": "Array of objects supporting the named method.",
"type": "Array"
},
{
"name": "name",
"description": "the name of the method to execute on each item.",
"type": "String"
},
{
"name": "args*",
"description": "Any number of additional args are passed as parameters to\n the execution of the named method.",
"type": "Any",
"optional": true
}
],
"return": {
"description": "All return values, indexed according to the item index.",
"type": "Array"
},
"static": 1,
"class": "Array",
"module": "collection",
"submodule": "array-invoke"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 100,
"description": "Category to prefix all event subscriptions to allow for ease of detach\nduring destroy.",
"itemtype": "property",
"name": "_evtCat",
"type": "string",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 110,
"description": "Reference to the Node instance containing the header contents.",
"itemtype": "property",
"name": "_head",
"type": "Node",
"default": "null",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 120,
"description": "Reference to the Node instance that will house the console messages.",
"itemtype": "property",
"name": "_body",
"type": "Node",
"default": "null",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 130,
"description": "Reference to the Node instance containing the footer contents.",
"itemtype": "property",
"name": "_foot",
"type": "Node",
"default": "null",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 140,
"description": "Holds the object API returned from Y.later for the print\nloop interval.",
"itemtype": "property",
"name": "_printLoop",
"type": "Object",
"default": "null",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 151,
"description": "Array of normalized message objects awaiting printing.",
"itemtype": "property",
"name": "buffer",
"type": "Array",
"default": "null",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 161,
"description": "Wrapper for Y.log.",
"itemtype": "method",
"name": "log",
"params": [
{
"name": "arg",
"description": "(all arguments passed through to Y.log)",
"type": "MIXED",
"multiple": true
}
],
"chainable": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 174,
"description": "Clear the console of messages and flush the buffer of pending messages.",
"itemtype": "method",
"name": "clearConsole",
"chainable": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 191,
"description": "Clears the console and resets internal timers.",
"itemtype": "method",
"name": "reset",
"chainable": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 203,
"description": "Collapses the body and footer.",
"itemtype": "method",
"name": "collapse",
"chainable": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 215,
"description": "Expands the body and footer if collapsed.",
"itemtype": "method",
"name": "expand",
"chainable": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 227,
"description": "Outputs buffered messages to the console UI. This is typically called\nfrom a scheduled interval until the buffer is empty (referred to as the\nprint loop). The number of buffered messages output to the Console is\nlimited to the number provided as an argument. If no limit is passed,\nall buffered messages are rendered.",
"itemtype": "method",
"name": "printBuffer",
"params": [
{
"name": "limit",
"description": "(optional) max number of buffered entries to write",
"type": "Number"
}
],
"chainable": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 288,
"description": "Constructor code. Set up the buffer and entry template, publish\ninternal events, and subscribe to the configured logEvent.",
"itemtype": "method",
"name": "initializer",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 303,
"description": "Transfers a received message to the print loop buffer. Default\nbehavior defined in _defEntryFn.",
"itemtype": "event",
"name": "entry",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following attribute specific properties added:\n
\n - message
\n - The message data normalized into an object literal (see _normalizeMessage)
\n
",
"type": "Event.Facade"
}
],
"preventable": "_defEntryFn",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 317,
"description": "Triggers the reset behavior via the default logic in _defResetFn.",
"itemtype": "event",
"name": "reset",
"params": [
{
"name": "event",
"description": "Event Facade object",
"type": "Event.Facade"
}
],
"preventable": "_defResetFn",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 329,
"description": "Tears down the instance, flushing event subscriptions and purging the UI.",
"itemtype": "method",
"name": "destructor",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 345,
"description": "Generate the Console UI.",
"itemtype": "method",
"name": "renderUI",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 363,
"description": "Sync the UI state to the current attribute state.",
"itemtype": "method",
"name": "syncUI",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 374,
"description": "Set up event listeners to wire up the UI to the internal state.",
"itemtype": "method",
"name": "bindUI",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 402,
"description": "Create the DOM structure for the header elements.",
"itemtype": "method",
"name": "_initHead",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 420,
"description": "Create the DOM structure for the console body—where messages are\nrendered.",
"itemtype": "method",
"name": "_initBody",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 435,
"description": "Create the DOM structure for the footer elements.",
"itemtype": "method",
"name": "_initFoot",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 453,
"description": "Determine if incoming log messages are within the configured logLevel\nto be buffered for printing.",
"itemtype": "method",
"name": "_isInLogLevel",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 479,
"description": "Create a log entry message from the inputs including the following keys:\n
\n - time - this moment
\n - message - leg message
\n - category - logLevel or custom category for the message
\n - source - when provided, the widget or util calling Y.log
\n - sourceAndDetail - same as source but can include instance info
\n - localTime - readable version of time
\n - elapsedTime - ms since last entry
\n - totalTime - ms since Console was instantiated or reset
\n
",
"itemtype": "method",
"name": "_normalizeMessage",
"params": [
{
"name": "e",
"description": "custom event containing the log message",
"type": "Event"
}
],
"return": {
"description": "Object the message object"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 527,
"description": "Sets an interval for buffered messages to be output to the console.",
"itemtype": "method",
"name": "_schedulePrint",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 542,
"description": "Translates message meta into the markup for a console entry.",
"itemtype": "method",
"name": "_createEntryHTML",
"params": [
{
"name": "m",
"description": "object literal containing normalized message metadata",
"type": "Object"
}
],
"return": {
"description": "String"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 565,
"description": "Scrolls to the most recent entry",
"itemtype": "method",
"name": "scrollToLatest",
"chainable": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 579,
"description": "Performs HTML escaping on strings in the message object.",
"itemtype": "method",
"name": "_htmlEscapeMessage",
"params": [
{
"name": "m",
"description": "the normalized message object",
"type": "Object"
}
],
"return": {
"description": "Object the message object with proper escapement"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 596,
"description": "Removes the oldest message entries from the UI to maintain the limit\nspecified in the consoleLimit configuration.",
"itemtype": "method",
"name": "_trimOldEntries",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 642,
"description": "Returns the input string with ampersands (&), <, and > encoded\nas HTML entities.",
"itemtype": "method",
"name": "_encodeHTML",
"params": [
{
"name": "s",
"description": "the raw string",
"type": "String"
}
],
"return": {
"description": "String the encoded string"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 659,
"description": "Clears the timeout for printing buffered messages.",
"itemtype": "method",
"name": "_cancelPrintLoop",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 672,
"description": "Validates input value for style attribute. Accepts only values 'inline',\n'block', and 'separate'.",
"itemtype": "method",
"name": "_validateStyle",
"params": [
{
"name": "style",
"description": "the proposed value",
"type": "String"
}
],
"return": {
"description": "pass/fail",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 685,
"description": "Event handler for clicking on the Pause checkbox to update the paused\nattribute.",
"itemtype": "method",
"name": "_onPauseClick",
"params": [
{
"name": "e",
"description": "DOM event facade for the click event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 697,
"description": "Event handler for clicking on the Clear button. Pass-through to\n
this.clearConsole().",
"itemtype": "method",
"name": "_onClearClick",
"params": [
{
"name": "e",
"description": "DOM event facade for the click event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 709,
"description": "Event handler for clicking on the Collapse/Expand button. Sets the\n"collapsed" attribute accordingly.",
"itemtype": "method",
"name": "_onCollapseClick",
"params": [
{
"name": "e",
"description": "DOM event facade for the click event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 722,
"description": "Validator for logSource attribute.",
"itemtype": "method",
"name": "_validateLogSource",
"params": [
{
"name": "v",
"description": "the desired logSource",
"type": "Object"
}
],
"return": {
"description": "true if the input is an object with an
on\n method",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 735,
"description": "Setter method for logLevel attribute. Acceptable values are\n"error", "warn", and "info" (case\ninsensitive). Other values are treated as "info".",
"itemtype": "method",
"name": "_setLogLevel",
"params": [
{
"name": "v",
"description": "the desired log level",
"type": "String"
}
],
"return": {
"description": "String One of Console.LOG_LEVEL_INFO, _WARN, or _ERROR"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 753,
"description": "Getter method for useBrowserConsole attribute. Just a pass through to\nthe YUI instance configuration setting.",
"itemtype": "method",
"name": "_getUseBrowserConsole",
"return": {
"description": "or null if logSource is not a YUI instance",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 767,
"description": "Setter method for useBrowserConsole attributes. Only functional if the\nlogSource attribute points to a YUI instance. Passes the value down to\nthe YUI instance. NOTE: multiple Console instances cannot maintain\nindependent useBrowserConsole values, since it is just a pass through to\nthe YUI instance configuration.",
"itemtype": "method",
"name": "_setUseBrowserConsole",
"params": [
{
"name": "v",
"description": "false to disable browser console printing (default)",
"type": "Boolean"
}
],
"return": {
"description": "true|false if logSource is a YUI instance",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 790,
"description": "Set the height of the Console container. Set the body height to the\ndifference between the configured height and the calculated heights of\nthe header and footer.\nOverrides Widget.prototype._uiSetHeight.",
"itemtype": "method",
"name": "_uiSetHeight",
"params": [
{
"name": "v",
"description": "the new height",
"type": "String|Number"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 812,
"description": "Over-ride default content box sizing to do nothing, since we're sizing\nthe body section to fill out height ourselves.",
"itemtype": "method",
"name": "_uiSizeCB",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 824,
"description": "Updates the UI if changes are made to any of the strings in the strings\nattribute.",
"itemtype": "method",
"name": "_afterStringsChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 851,
"description": "Updates the UI and schedules or cancels the print loop.",
"itemtype": "method",
"name": "_afterPausedChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 872,
"description": "Checks or unchecks the paused checkbox",
"itemtype": "method",
"name": "_uiUpdatePaused",
"params": [
{
"name": "on",
"description": "the new checked state",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 887,
"description": "Calls this._trimOldEntries() in response to changes in the configured\nconsoleLimit attribute.",
"itemtype": "method",
"name": "_afterConsoleLimitChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 900,
"description": "Updates the className of the contentBox, which should trigger CSS to\nhide or show the body and footer sections depending on the new value.",
"itemtype": "method",
"name": "_afterCollapsedChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 912,
"description": "Updates the UI to reflect the new Collapsed state",
"itemtype": "method",
"name": "_uiUpdateCollapsed",
"params": [
{
"name": "v",
"description": "true for collapsed, false for expanded",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 934,
"description": "Makes adjustments to the UI if needed when the Console is hidden or shown",
"itemtype": "method",
"name": "_afterVisibleChange",
"params": [
{
"name": "e",
"description": "the visibleChange event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 947,
"description": "Recalculates dimensions and updates appropriately when shown",
"itemtype": "method",
"name": "_uiUpdateFromHideShow",
"params": [
{
"name": "v",
"description": "true for visible, false for hidden",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 960,
"description": "Responds to log events by normalizing qualifying messages and passing\nthem along through the entry event for buffering etc.",
"itemtype": "method",
"name": "_onLogEvent",
"params": [
{
"name": "msg",
"description": "the log message",
"type": "String"
},
{
"name": "cat",
"description": "OPTIONAL the category or logLevel of the message",
"type": "String"
},
{
"name": "src",
"description": "OPTIONAL the source of the message (e.g. widget name)",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 987,
"description": "Clears the console, resets the startTime attribute, enables and\nunpauses the widget.",
"itemtype": "method",
"name": "_defResetFn",
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1001,
"description": "Buffers incoming message objects and schedules the printing.",
"itemtype": "method",
"name": "_defEntryFn",
"params": [
{
"name": "e",
"description": "The Custom event carrying the message in its payload",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1019,
"description": "The identity of the widget.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1028,
"description": "Static identifier for logLevel configuration setting to allow all\nincoming messages to generate Console entries.",
"itemtype": "property",
"name": "LOG_LEVEL_INFO",
"type": "String",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1038,
"description": "Static identifier for logLevel configuration setting to allow only\nincoming messages of logLevel "warn" or "error"\nto generate Console entries.",
"itemtype": "property",
"name": "LOG_LEVEL_WARN",
"type": "String",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1049,
"description": "Static identifier for logLevel configuration setting to allow only\nincoming messages of logLevel "error" to generate\nConsole entries.",
"itemtype": "property",
"name": "LOG_LEVEL_ERROR",
"type": "String",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1060,
"description": "Map (object) of classNames used to populate the placeholders in the\nConsole.ENTRY_TEMPLATE markup when rendering a new Console entry.\n\n
By default, the keys contained in the object are:
\n
\n - entry_class
\n - entry_meta_class
\n - entry_cat_class
\n - entry_src_class
\n - entry_time_class
\n - entry_content_class
\n
",
"itemtype": "property",
"name": "ENTRY_CLASSES",
"type": "Object",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1087,
"description": "Map (object) of classNames used to populate the placeholders in the\nConsole.HEADER_TEMPLATE, Console.BODY_TEMPLATE, and\nConsole.FOOTER_TEMPLATE markup when rendering the Console UI.\n\n
By default, the keys contained in the object are:
\n
\n - console_hd_class
\n - console_bd_class
\n - console_ft_class
\n - console_controls_class
\n - console_checkbox_class
\n - console_pause_class
\n - console_pause_label_class
\n - console_button_class
\n - console_clear_class
\n - console_collapse_class
\n - console_title_class
\n
",
"itemtype": "property",
"name": "CHROME_CLASSES",
"type": "Object",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1125,
"description": "Markup template used to generate the DOM structure for the header\nsection of the Console when it is rendered. The template includes\nthese {placeholder}s:\n\n
\n - console_button_class - contributed by Console.CHROME_CLASSES
\n - console_collapse_class - contributed by Console.CHROME_CLASSES
\n - console_hd_class - contributed by Console.CHROME_CLASSES
\n - console_title_class - contributed by Console.CHROME_CLASSES
\n - str_collapse - pulled from attribute strings.collapse
\n - str_title - pulled from attribute strings.title
\n
",
"itemtype": "property",
"name": "HEADER_TEMPLATE",
"type": "String",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1151,
"description": "Markup template used to generate the DOM structure for the Console body\n(where the messages are inserted) when it is rendered. The template\nincludes only the {placeholder} "console_bd_class", which is\nconstributed by Console.CHROME_CLASSES.",
"itemtype": "property",
"name": "BODY_TEMPLATE",
"type": "String",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1163,
"description": "Markup template used to generate the DOM structure for the footer\nsection of the Console when it is rendered. The template includes\nmany of the {placeholder}s from Console.CHROME_CLASSES as well as:\n\n
\n - id_guid - generated unique id, relates the label and checkbox
\n - str_pause - pulled from attribute strings.pause
\n - str_clear - pulled from attribute strings.clear
\n
",
"itemtype": "property",
"name": "FOOTER_TEMPLATE",
"type": "String",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1191,
"description": "Default markup template used to create the DOM structure for Console\nentries. The markup contains {placeholder}s for content and classes\nthat are replaced via Y.substitute. The default template contains\nthe {placeholder}s identified in Console.ENTRY_CLASSES as well as the\nfollowing placeholders that will be populated by the log entry data:\n\n
\n - cat_class
\n - src_class
\n - totalTime
\n - elapsedTime
\n - localTime
\n - sourceAndDetail
\n - message
\n
",
"itemtype": "property",
"name": "ENTRY_TEMPLATE",
"type": "String",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1214,
"description": "Static property used to define the default attribute configuration of\nthe Widget.",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1224,
"description": "Name of the custom event that will communicate log messages.",
"itemtype": "attribute",
"name": "logEvent",
"type": "String",
"default": "\"yui:log\"",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1237,
"description": "Object that will emit the log events. By default the YUI instance.\nTo have a single Console capture events from all YUI instances, set\nthis to the Y.Global object.",
"itemtype": "attribute",
"name": "logSource",
"type": "EventTarget",
"default": "Y",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1254,
"description": "Collection of strings used to label elements in the Console UI.\nDefault collection contains the following name:value pairs:\n\n
\n - title : "Log Console"
\n - pause : "Pause"
\n - clear : "Clear"
\n - collapse : "Collapse"
\n - expand : "Expand"
\n
",
"itemtype": "attribute",
"name": "strings",
"type": "Object",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1273,
"description": "Boolean to pause the outputting of new messages to the console.\nWhen paused, messages will accumulate in the buffer.",
"itemtype": "attribute",
"name": "paused",
"type": "boolean",
"default": "false",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1286,
"description": "If a category is not specified in the Y.log(..) statement, this\ncategory will be used. Categories "info",\n"warn", and "error" are also called log level.",
"itemtype": "attribute",
"name": "defaultCategory",
"type": "String",
"default": "\"info\"",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1300,
"description": "If a source is not specified in the Y.log(..) statement, this\nsource will be used.",
"itemtype": "attribute",
"name": "defaultSource",
"type": "String",
"default": "\"global\"",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1313,
"description": "Markup template used to create the DOM structure for Console entries.",
"itemtype": "attribute",
"name": "entryTemplate",
"type": "String",
"default": "Console.ENTRY_TEMPLATE",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1325,
"description": "Minimum entry log level to render into the Console. The initial\nlogLevel value for all Console instances defaults from the\nY.config.logLevel YUI configuration, or Console.LOG_LEVEL_INFO if\nthat configuration is not set.\n\nPossible values are "info", "warn",\n"error" (case insensitive), or their corresponding statics\nConsole.LOG_LEVEL_INFO and so on.",
"itemtype": "attribute",
"name": "logLevel",
"type": "String",
"default": "Y.config.logLevel or Console.LOG_LEVEL_INFO",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1346,
"description": "Millisecond timeout between iterations of the print loop, moving\nentries from the buffer to the UI.",
"itemtype": "attribute",
"name": "printTimeout",
"type": "Number",
"default": "100",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1359,
"description": "Maximum number of entries printed in each iteration of the print\nloop. This is used to prevent excessive logging locking the page UI.",
"itemtype": "attribute",
"name": "printLimit",
"type": "Number",
"default": "50",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1372,
"description": "Maximum number of Console entries allowed in the Console body at one\ntime. This is used to keep acquired messages from exploding the\nDOM tree and impacting page performance.",
"itemtype": "attribute",
"name": "consoleLimit",
"type": "Number",
"default": "300",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1386,
"description": "New entries should display at the top of the Console or the bottom?",
"itemtype": "attribute",
"name": "newestOnTop",
"type": "Boolean",
"default": "true",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1397,
"description": "When new entries are added to the Console UI, should they be\nscrolled into view?",
"itemtype": "attribute",
"name": "scrollIntoView",
"type": "Boolean",
"default": "true",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1409,
"description": "The baseline time for this Console instance, used to measure elapsed\ntime from the moment the console module is
used to the\nmoment each new entry is logged (not rendered).\n\nThis value is reset by the instance method myConsole.reset().",
"itemtype": "attribute",
"name": "startTime",
"type": "Date",
"default": "The moment the console module is
used",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1424,
"description": "The precise time the last entry was logged. Used to measure elapsed\ntime between log messages.",
"itemtype": "attribute",
"name": "lastTime",
"type": "Date",
"default": "The moment the console module is
used",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1437,
"description": "Controls the collapsed state of the Console",
"itemtype": "attribute",
"name": "collapsed",
"type": "Boolean",
"default": "false",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1448,
"description": "String with units, or number, representing the height of the Console,\ninclusive of header and footer. If a number is provided, the default\nunit, defined by Widget's DEF_UNIT, property is used.",
"itemtype": "attribute",
"name": "height",
"default": "\"300px\"",
"type": "{String | Number}",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1461,
"description": "String with units, or number, representing the width of the Console.\nIf a number is provided, the default unit, defined by Widget's\nDEF_UNIT, property is used.",
"itemtype": "attribute",
"name": "width",
"default": "\"300px\"",
"type": "{String | Number}",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1474,
"description": "Pass through to the YUI instance useBrowserConsole configuration.\nBy default this is set to false, which will disable logging to the\nbrowser console when a Console instance is created. If the\nlogSource is not a YUI instance, this has no effect.",
"itemtype": "attribute",
"name": "useBrowserConsole",
"type": "{Boolean}",
"default": "false",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console/js/console.js",
"line": 1495,
"description": "Allows the Console to flow in the document. Available values are\n'inline', 'block', and 'separate' (the default).",
"itemtype": "attribute",
"name": "style",
"type": "{String}",
"default": "'separate'",
"class": "Console",
"module": "console"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 43,
"description": "Collection of all log messages passed through since the plugin's\ninstantiation. This holds all messages regardless of filter status.\nUsed as a single source of truth for repopulating the Console body when\nfilters are changed.",
"itemtype": "property",
"name": "_entries",
"type": "Array",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 55,
"description": "Maximum number of entries to store in the message cache.",
"itemtype": "property",
"name": "_cacheLimit",
"type": "{Number}",
"default": "Infinity",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 65,
"description": "The container node created to house the category filters.",
"itemtype": "property",
"name": "_categories",
"type": "Node",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 74,
"description": "The container node created to house the source filters.",
"itemtype": "property",
"name": "_sources",
"type": "Node",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 83,
"description": "Initialize entries collection and attach listeners to host events and\nmethods.",
"itemtype": "method",
"name": "initializer",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 110,
"description": "Removes the plugin UI and unwires events.",
"itemtype": "method",
"name": "destructor",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 129,
"description": "Adds the category and source filter sections to the Console footer.",
"itemtype": "method",
"name": "renderUI",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 154,
"description": "Binds to checkbox click events and internal attribute change events to\nmaintain the UI state.",
"itemtype": "method",
"name": "bindUI",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 170,
"description": "Updates the UI to be in accordance with the current state of the plugin.",
"itemtype": "method",
"name": "syncUI",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 187,
"description": "Ensures a filter is set up for any new categories or sources and\ncollects the messages in _entries. If the message is stamped with a\ncategory or source that is currently being filtered out, the message\nwill not pass to the Console's print buffer.",
"itemtype": "method",
"name": "_onEntry",
"params": [
{
"name": "e",
"description": "the custom event object",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 228,
"description": "Flushes the cached entries after a call to the Console's clearConsole().",
"itemtype": "method",
"name": "_afterClearConsole",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 238,
"description": "Triggers the Console to update if a known category filter\nchanges value (e.g. visible => hidden). Updates the appropriate\ncheckbox's checked state if necessary.",
"itemtype": "method",
"name": "_afterCategoryChange",
"params": [
{
"name": "e",
"description": "the attribute change event object",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 264,
"description": "Triggers the Console to update if a known source filter\nchanges value (e.g. visible => hidden). Updates the appropriate\ncheckbox's checked state if necessary.",
"itemtype": "method",
"name": "_afterSourceChange",
"params": [
{
"name": "e",
"description": "the attribute change event object",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 290,
"description": "Flushes the Console's print buffer of any entries that have a category\nor source that is currently being excluded.",
"itemtype": "method",
"name": "_filterBuffer",
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 317,
"description": "Trims the cache of entries to the appropriate new length.",
"itemtype": "method",
"name": "_afterCacheLimitChange",
"params": [
{
"name": "e",
"description": "the attribute change event object",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 334,
"description": "Repopulates the Console with entries appropriate to the current filter\nsettings.",
"itemtype": "method",
"name": "refreshConsole",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 368,
"description": "Updates the checked property of a filter checkbox of the specified type.\nIf no checkbox is found for the input params, one is created.",
"itemtype": "method",
"name": "_uiSetCheckbox",
"params": [
{
"name": "type",
"description": "'category' or 'source'",
"type": "String"
},
{
"name": "item",
"description": "the name of the filter (e.g. 'info', 'event')",
"type": "String"
},
{
"name": "checked",
"description": "value to set the checkbox's checked property",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 401,
"description": "Passes checkbox clicks on to the category attribute.",
"itemtype": "method",
"name": "_onCategoryCheckboxClick",
"params": [
{
"name": "e",
"description": "the DOM event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 419,
"description": "Passes checkbox clicks on to the source attribute.",
"itemtype": "method",
"name": "_onSourceCheckboxClick",
"params": [
{
"name": "e",
"description": "the DOM event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 437,
"description": "Hides any number of categories from the UI. Convenience method for\nmyConsole.filter.set('category.foo', false); set('category.bar', false);\nand so on.",
"itemtype": "method",
"name": "hideCategory",
"params": [
{
"name": "cat",
"description": "1..n categories to filter out of the UI",
"type": "String",
"multiple": true
}
],
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 453,
"description": "Shows any number of categories in the UI. Convenience method for\nmyConsole.filter.set('category.foo', true); set('category.bar', true);\nand so on.",
"itemtype": "method",
"name": "showCategory",
"params": [
{
"name": "cat",
"description": "1..n categories to allow to display in the UI",
"type": "String",
"multiple": true
}
],
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 469,
"description": "Hides any number of sources from the UI. Convenience method for\nmyConsole.filter.set('source.foo', false); set('source.bar', false);\nand so on.",
"itemtype": "method",
"name": "hideSource",
"params": [
{
"name": "src",
"description": "1..n sources to filter out of the UI",
"type": "String",
"multiple": true
}
],
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 485,
"description": "Shows any number of sources in the UI. Convenience method for\nmyConsole.filter.set('source.foo', true); set('source.bar', true);\nand so on.",
"itemtype": "method",
"name": "showSource",
"params": [
{
"name": "src",
"description": "1..n sources to allow to display in the UI",
"type": "String",
"multiple": true
}
],
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 501,
"description": "Creates a checkbox and label from the ConsoleFilters.FILTER_TEMPLATE for\nthe provided type and name. The checkbox and label are appended to the\ncontainer node passes as the first arg.",
"itemtype": "method",
"name": "_createCheckbox",
"params": [
{
"name": "container",
"description": "the parentNode of the new checkbox and label",
"type": "Node"
},
{
"name": "name",
"description": "the identifier of the filter",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 522,
"description": "Validates category updates are objects and the subattribute is not too\ndeep.",
"itemtype": "method",
"name": "_validateCategory",
"params": [
{
"name": "cat",
"description": "the new category:visibility map",
"type": "String"
},
{
"name": "v",
"description": "the subattribute path updated",
"type": "String"
}
],
"return": {
"description": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 536,
"description": "Validates source updates are objects and the subattribute is not too\ndeep.",
"itemtype": "method",
"name": "_validateSource",
"params": [
{
"name": "cat",
"description": "the new source:visibility map",
"type": "String"
},
{
"name": "v",
"description": "the subattribute path updated",
"type": "String"
}
],
"return": {
"description": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 550,
"description": "Setter method for cacheLimit attribute. Basically a validator to ensure\nnumeric input.",
"itemtype": "method",
"name": "_setCacheLimit",
"params": [
{
"name": "v",
"description": "Maximum number of entries",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Number"
},
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 571,
"description": "Plugin name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"default": "'consoleFilters'",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 581,
"description": "The namespace hung off the host object that this plugin will inhabit.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"default": "'filter'",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 591,
"description": "Markup template used to create the container for the category filters.",
"itemtype": "property",
"name": "CATEGORIES_TEMPLATE",
"type": "String",
"static": 1,
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 601,
"description": "Markup template used to create the container for the source filters.",
"itemtype": "property",
"name": "SOURCES_TEMPLATE",
"type": "String",
"static": 1,
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 611,
"description": "Markup template used to create the category and source filter checkboxes.",
"itemtype": "property",
"name": "FILTER_TEMPLATE",
"type": "String",
"static": 1,
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 628,
"description": "Classnames used by the templates when creating nodes.",
"itemtype": "property",
"name": "CHROME_CLASSES",
"type": "Object",
"static": 1,
"access": "protected",
"tagname": "",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 646,
"description": "Default visibility applied to new categories and sources.",
"itemtype": "attribute",
"name": "defaultVisibility",
"type": "{Boolean}",
"default": "true",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 658,
"description": "
Map of entry categories to their visibility status. Update a\nparticular category's visibility by setting the subattribute to true\n(visible) or false (hidden).
\n\n
For example, yconsole.filter.set('category.info', false) to hide\nlog entries with the category/logLevel of 'info'.
\n\n
Similarly, yconsole.filter.get('category.warn') will return a\nboolean indicating whether that category is currently being included\nin the UI.
\n\n
Unlike the YUI instance configuration's logInclude and logExclude\nproperties, filtered entries are only hidden from the UI, but\ncan be made visible again.
",
"itemtype": "attribute",
"name": "category",
"type": "Object",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 684,
"description": "
Map of entry sources to their visibility status. Update a\nparticular sources's visibility by setting the subattribute to true\n(visible) or false (hidden).
\n\n
For example, yconsole.filter.set('sources.slider', false) to hide\nlog entries originating from Y.Slider.
",
"itemtype": "attribute",
"name": "source",
"type": "Object",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/console-filters/js/console-filters.js",
"line": 702,
"description": "Maximum number of entries to store in the message cache. Use this to\nlimit the memory footprint in environments with heavy log usage.\nBy default, there is no limit (Number.POSITIVE_INFINITY).",
"itemtype": "attribute",
"name": "cacheLimit",
"type": "{Number}",
"default": "Number.POSITIVE_INFINITY",
"class": "Plugin.ConsoleFilters",
"module": "console-filters",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 58,
"description": "Creates a cookie string that can be assigned into document.cookie.",
"params": [
{
"name": "name",
"description": "The name of the cookie.",
"type": "String"
},
{
"name": "value",
"description": "The value of the cookie.",
"type": "String"
},
{
"name": "encodeValue",
"description": "True to encode the value, false to leave as-is.",
"type": "Boolean"
},
{
"name": "options",
"description": "(Optional) Options for the cookie.",
"type": "Object"
}
],
"return": {
"description": "The formatted cookie string.",
"type": "String"
},
"itemtype": "method",
"name": "_createCookieString",
"access": "private",
"tagname": "",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 104,
"description": "Formats a cookie value for an object containing multiple values.",
"params": [
{
"name": "hash",
"description": "An object of key-value pairs to create a string for.",
"type": "Object"
}
],
"return": {
"description": "A string suitable for use as a cookie value.",
"type": "String"
},
"itemtype": "method",
"name": "_createCookieHashString",
"access": "private",
"tagname": "",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 128,
"description": "Parses a cookie hash string into an object.",
"params": [
{
"name": "text",
"description": "The cookie hash string to parse (format: n1=v1&n2=v2).",
"type": "String"
}
],
"return": {
"description": "An object containing entries for each cookie value.",
"type": "Object"
},
"itemtype": "method",
"name": "_parseCookieHash",
"access": "private",
"tagname": "",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 152,
"description": "Parses a cookie string into an object representing all accessible cookies.",
"params": [
{
"name": "text",
"description": "The cookie string to parse.",
"type": "String"
},
{
"name": "shouldDecode",
"description": "(Optional) Indicates if the cookie values should be decoded or not. Default is true.",
"type": "Boolean"
}
],
"return": {
"description": "An object containing entries for each accessible cookie.",
"type": "Object"
},
"itemtype": "method",
"name": "_parseCookieString",
"access": "private",
"tagname": "",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 197,
"description": "Sets the document object that the cookie utility uses for setting\ncookies. This method is necessary to ensure that the cookie utility\nunit tests can pass even when run on a domain instead of locally.\nThis method should not be used otherwise; you should use \n
Y.config.doc to change the document that the cookie\nutility uses for everyday purposes.",
"params": [
{
"name": "newDoc",
"description": "The object to use as the document.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "_setDoc",
"access": "private",
"tagname": "",
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 217,
"description": "Determines if the cookie with the given name exists. This is useful for\nBoolean cookies (those that do not follow the name=value convention).",
"params": [
{
"name": "name",
"description": "The name of the cookie to check.",
"type": "String"
}
],
"return": {
"description": "True if the cookie exists, false if not.",
"type": "Boolean"
},
"itemtype": "method",
"name": "exists",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 234,
"description": "Returns the cookie value for the given name.",
"params": [
{
"name": "name",
"description": "The name of the cookie to retrieve.",
"type": "String"
},
{
"name": "options",
"description": "(Optional) An object containing one or more\n cookie options: raw (true/false) and converter (a function).\n The converter function is run on the value before returning it. The\n function is not used if the cookie doesn't exist. The function can be\n passed instead of the options object for backwards compatibility. When\n raw is set to true, the cookie value is not URI decoded.",
"type": "Function|Object"
}
],
"return": {
"description": "If no converter is specified, returns a string or null if\n the cookie doesn't exist. If the converter is specified, returns the value\n returned from the converter or null if the cookie doesn't exist.",
"type": "Variant"
},
"itemtype": "method",
"name": "get",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 282,
"description": "Returns the value of a subcookie.",
"params": [
{
"name": "name",
"description": "The name of the cookie to retrieve.",
"type": "String"
},
{
"name": "subName",
"description": "The name of the subcookie to retrieve.",
"type": "String"
},
{
"name": "converter",
"description": "(Optional) A function to run on the value before returning\n it. The function is not used if the cookie doesn't exist.",
"type": "Function"
}
],
"return": {
"description": "If the cookie doesn't exist, null is returned. If the subcookie\n doesn't exist, null if also returned. If no converter is specified and the\n subcookie exists, a string is returned. If a converter is specified and the\n subcookie exists, the value returned from the converter is returned.",
"type": "Variant"
},
"itemtype": "method",
"name": "getSub",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 318,
"description": "Returns an object containing name-value pairs stored in the cookie with the given name.",
"params": [
{
"name": "name",
"description": "The name of the cookie to retrieve.",
"type": "String"
}
],
"return": {
"description": "An object of name-value pairs if the cookie with the given name\n exists, null if it does not.",
"type": "Object"
},
"itemtype": "method",
"name": "getSubs",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 337,
"description": "Removes a cookie from the machine by setting its expiration date to\nsometime in the past.",
"params": [
{
"name": "name",
"description": "The name of the cookie to remove.",
"type": "String"
},
{
"name": "options",
"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), \n and secure (true/false). The expires option will be overwritten\n by the method.",
"type": "Object"
}
],
"return": {
"description": "The created cookie string.",
"type": "String"
},
"itemtype": "method",
"name": "remove",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 362,
"description": "Removes a sub cookie with a given name.",
"params": [
{
"name": "name",
"description": "The name of the cookie in which the subcookie exists.",
"type": "String"
},
{
"name": "subName",
"description": "The name of the subcookie to remove.",
"type": "String"
},
{
"name": "options",
"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), expires (a Date object),\n removeIfEmpty (true/false), and secure (true/false). This must be the same\n settings as the original subcookie.",
"type": "Object"
}
],
"return": {
"description": "The created cookie string.",
"type": "String"
},
"itemtype": "method",
"name": "removeSub",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 409,
"description": "Sets a cookie with a given name and value.",
"params": [
{
"name": "name",
"description": "The name of the cookie to set.",
"type": "String"
},
{
"name": "value",
"description": "The value to set for the cookie.",
"type": "Variant"
},
{
"name": "options",
"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), expires (a Date object),\n secure (true/false), and raw (true/false). Setting raw to true indicates\n that the cookie should not be URI encoded before being set.",
"type": "Object"
}
],
"return": {
"description": "The created cookie string.",
"type": "String"
},
"itemtype": "method",
"name": "set",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 436,
"description": "Sets a sub cookie with a given name to a particular value.",
"params": [
{
"name": "name",
"description": "The name of the cookie to set.",
"type": "String"
},
{
"name": "subName",
"description": "The name of the subcookie to set.",
"type": "String"
},
{
"name": "value",
"description": "The value to set.",
"type": "Variant"
},
{
"name": "options",
"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), expires (a Date object),\n and secure (true/false).",
"type": "Object"
}
],
"return": {
"description": "The created cookie string.",
"type": "String"
},
"itemtype": "method",
"name": "setSub",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/cookie/js/Cookie.js",
"line": 470,
"description": "Sets a cookie with a given name to contain a hash of name-value pairs.",
"params": [
{
"name": "name",
"description": "The name of the cookie to set.",
"type": "String"
},
{
"name": "value",
"description": "An object containing name-value pairs.",
"type": "Object"
},
{
"name": "options",
"description": "(Optional) An object containing one or more\n cookie options: path (a string), domain (a string), expires (a Date object),\n and secure (true/false).",
"type": "Object"
}
],
"return": {
"description": "The created cookie string.",
"type": "String"
},
"itemtype": "method",
"name": "setSubs",
"static": 1,
"class": "Cookie",
"module": "cookie"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-array.js",
"line": 29,
"description": "Applies a schema to an array of data, returning a normalized object\nwith results in the `results` property. The `meta` property of the\nresponse object is present for consistency, but is assigned an empty\nobject. If the input data is absent or not an array, an `error`\nproperty will be added.\n\nThe input array is expected to contain objects, arrays, or strings.\n\nIf _schema_ is not specified or _schema.resultFields_ is not an array,\n`response.results` will be assigned the input array unchanged.\n\nWhen a _schema_ is specified, the following will occur:\n\nIf the input array contains strings, they will be copied as-is into the\n`response.results` array.\n\nIf the input array contains arrays, `response.results` will contain an\narray of objects with key:value pairs assuming the fields in\n_schema.resultFields_ are ordered in accordance with the data array\nvalues.\n\nIf the input array contains objects, the identified\n_schema.resultFields_ will be used to extract a value from those\nobjects for the output result.\n\n_schema.resultFields_ field identifiers are objects with the following properties:\n\n * `key` :
(required) The locator name (String)\n * `parser`: A function or the name of a function on `Y.Parsers` used\n to convert the input value into a normalized type. Parser\n functions are passed the value as input and are expected to\n return a value.\n\nIf no value parsing is needed, you can use strings as identifiers\ninstead of objects (see example below).",
"example": [
"\n // Process array of arrays\n var schema = { resultFields: [ 'fruit', 'color' ] },\n data = [\n [ 'Banana', 'yellow' ],\n [ 'Orange', 'orange' ],\n [ 'Eggplant', 'purple' ]\n ];\n\n var response = Y.DataSchema.Array.apply(schema, data);\n\n // response.results[0] is { fruit: \"Banana\", color: \"yellow\" }\n\n \n // Process array of objects\n data = [\n { fruit: 'Banana', color: 'yellow', price: '1.96' },\n{ fruit: 'Orange', color: 'orange', price: '2.04' },\n { fruit: 'Eggplant', color: 'purple', price: '4.31' }\n ];\n\n response = Y.DataSchema.Array.apply(schema, data);\n\n // response.results[0] is { fruit: \"Banana\", color: \"yellow\" }\n\n\n // Use parsers\n schema.resultFields = [\n {\n key: 'fruit',\n parser: function (val) { return val.toUpperCase(); }\n },\n {\n key: 'price',\n parser: 'number' // Uses Y.Parsers.number\n }\n ];\n\n response = Y.DataSchema.Array.apply(schema, data);\n\n // Note price was converted from a numeric string to a number\n // response.results[0] looks like { fruit: \"BANANA\", price: 1.96 }"
],
"itemtype": "method",
"name": "apply",
"params": [
{
"name": "schema",
"description": "Schema to apply. Supported configuration\n properties are:",
"type": "Object",
"optional": true,
"props": [
{
"name": "resultFields",
"description": "Field identifiers to\n locate/assign values in the response records. See above for\n details.",
"type": "Array",
"optional": true
}
]
},
{
"name": "data",
"description": "Array data.",
"type": "Array"
}
],
"return": {
"description": "An Object with properties `results` and `meta`",
"type": "Object"
},
"static": 1,
"class": "DataSchema.Array",
"module": "dataschema",
"submodule": "dataschema-array"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-array.js",
"line": 141,
"description": "Schema-parsed list of results from full data",
"itemtype": "method",
"name": "_parseResults",
"params": [
{
"name": "fields",
"description": "Schema to parse against.",
"type": "Array"
},
{
"name": "array_in",
"description": "Array to parse.",
"type": "Array"
},
{
"name": "data_out",
"description": "In-progress parsed data to update.",
"type": "Object"
}
],
"return": {
"description": "Parsed data object.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.Array",
"module": "dataschema",
"submodule": "dataschema-array"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-base.js",
"line": 25,
"description": "Overridable method returns data as-is.",
"itemtype": "method",
"name": "apply",
"params": [
{
"name": "schema",
"description": "Schema to apply.",
"type": "Object"
},
{
"name": "data",
"description": "Data.",
"type": "Object"
}
],
"return": {
"description": "Schema-parsed data.",
"type": "Object"
},
"static": 1,
"class": "DataSchema.Base",
"module": "dataschema",
"submodule": "dataschema-base"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-base.js",
"line": 38,
"description": "Applies field parser, if defined",
"itemtype": "method",
"name": "parse",
"params": [
{
"name": "value",
"description": "Original value.",
"type": "Object"
},
{
"name": "field",
"description": "Field.",
"type": "Object"
}
],
"return": {
"description": "Type-converted value.",
"type": "Object"
},
"class": "DataSchema.Base",
"module": "dataschema",
"submodule": "dataschema-base"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-json.js",
"line": 34,
"description": "Utility function converts JSON locator strings into walkable paths",
"itemtype": "method",
"name": "getPath",
"params": [
{
"name": "locator",
"description": "JSON value locator.",
"type": "String"
}
],
"return": {
"description": "Walkable path to data value.",
"type": "String[]"
},
"static": 1,
"class": "DataSchema.JSON",
"module": "dataschema",
"submodule": "dataschema-json"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-json.js",
"line": 78,
"description": "Utility function to walk a path and return the value located there.",
"itemtype": "method",
"name": "getLocationValue",
"params": [
{
"name": "path",
"description": "Locator path.",
"type": "String[]"
},
{
"name": "data",
"description": "Data to traverse.",
"type": "String"
}
],
"return": {
"description": "Data value at location.",
"type": "Object"
},
"static": 1,
"class": "DataSchema.JSON",
"module": "dataschema",
"submodule": "dataschema-json"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-json.js",
"line": 101,
"description": "Applies a schema to an array of data located in a JSON structure, returning\na normalized object with results in the `results` property. Additional\ninformation can be parsed out of the JSON for inclusion in the `meta`\nproperty of the response object. If an error is encountered during\nprocessing, an `error` property will be added.\n\nThe input _data_ is expected to be an object or array. If it is a string,\nit will be passed through `Y.JSON.parse()`.\n\nIf _data_ contains an array of data records to normalize, specify the\n_schema.resultListLocator_ as a dot separated path string just as you would\nreference it in JavaScript. So if your _data_ object has a record array at\n_data.response.results_, use _schema.resultListLocator_ =\n\"response.results\". Bracket notation can also be used for array indices or\nobject properties (e.g. \"response['results']\"); This is called a \"path\nlocator\"\n\nField data in the result list is extracted with field identifiers in\n_schema.resultFields_. Field identifiers are objects with the following\nproperties:\n\n * `key` :
(required) The path locator (String)\n * `parser`: A function or the name of a function on `Y.Parsers` used\n to convert the input value into a normalized type. Parser\n functions are passed the value as input and are expected to\n return a value.\n\nIf no value parsing is needed, you can use path locators (strings) \ninstead of field identifiers (objects) -- see example below.\n\nIf no processing of the result list array is needed, _schema.resultFields_\ncan be omitted; the `response.results` will point directly to the array.\n\nIf the result list contains arrays, `response.results` will contain an\narray of objects with key:value pairs assuming the fields in\n_schema.resultFields_ are ordered in accordance with the data array\nvalues.\n\nIf the result list contains objects, the identified _schema.resultFields_\nwill be used to extract a value from those objects for the output result.\n\nTo extract additional information from the JSON, include an array of\npath locators in _schema.metaFields_. The collected values will be\nstored in `response.meta`.",
"example": [
"\n// Process array of arrays\n var schema = {\n resultListLocator: 'produce.fruit',\n resultFields: [ 'name', 'color' ]\n },\n data = {\n produce: {\n fruit: [\n [ 'Banana', 'yellow' ],\n [ 'Orange', 'orange' ],\n [ 'Eggplant', 'purple' ]\n ]\n }\n };\n\n var response = Y.DataSchema.JSON.apply(schema, data);\n\n // response.results[0] is { name: \"Banana\", color: \"yellow\" }\n\n \n // Process array of objects + some metadata\n schema.metaFields = [ 'lastInventory' ];\n\n data = {\n produce: {\n fruit: [\n { name: 'Banana', color: 'yellow', price: '1.96' },\n { name: 'Orange', color: 'orange', price: '2.04' },\n { name: 'Eggplant', color: 'purple', price: '4.31' }\n ]\n },\n lastInventory: '2011-07-19'\n };\n\n response = Y.DataSchema.JSON.apply(schema, data);\n\n // response.results[0] is { name: \"Banana\", color: \"yellow\" }\n // response.meta.lastInventory is '2001-07-19'\n\n\n // Use parsers\n schema.resultFields = [\n {\n key: 'name',\n parser: function (val) { return val.toUpperCase(); }\n },\n {\n key: 'price',\n parser: 'number' // Uses Y.Parsers.number\n }\n ];\n\n response = Y.DataSchema.JSON.apply(schema, data);\n\n // Note price was converted from a numeric string to a number\n // response.results[0] looks like { fruit: \"BANANA\", price: 1.96 }"
],
"itemtype": "method",
"name": "apply",
"params": [
{
"name": "schema",
"description": "Schema to apply. Supported configuration\n properties are:",
"type": "Object",
"optional": true,
"props": [
{
"name": "resultListLocator",
"description": "Path locator for the\n location of the array of records to flatten into `response.results`",
"type": "String",
"optional": true
},
{
"name": "resultFields",
"description": "Field identifiers to\n locate/assign values in the response records. See above for\n details.",
"type": "Array",
"optional": true
},
{
"name": "metaFields",
"description": "Path locators to extract extra\n non-record related information from the data object.",
"type": "Array",
"optional": true
}
]
},
{
"name": "data",
"description": "JSON data or its string serialization.",
"type": "Object|Array|String"
}
],
"return": {
"description": "An Object with properties `results` and `meta`",
"type": "Object"
},
"static": 1,
"class": "DataSchema.JSON",
"module": "dataschema",
"submodule": "dataschema-json"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-json.js",
"line": 252,
"description": "Schema-parsed list of results from full data",
"itemtype": "method",
"name": "_parseResults",
"params": [
{
"name": "schema",
"description": "Schema to parse against.",
"type": "Object"
},
{
"name": "json_in",
"description": "JSON to parse.",
"type": "Object"
},
{
"name": "data_out",
"description": "In-progress parsed data to update.",
"type": "Object"
}
],
"return": {
"description": "Parsed data object.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.JSON",
"module": "dataschema",
"submodule": "dataschema-json"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-json.js",
"line": 293,
"description": "Get field data values out of list of full results",
"itemtype": "method",
"name": "_getFieldValues",
"params": [
{
"name": "fields",
"description": "Fields to find.",
"type": "Array"
},
{
"name": "array_in",
"description": "Results to parse.",
"type": "Array"
},
{
"name": "data_out",
"description": "In-progress parsed data to update.",
"type": "Object"
}
],
"return": {
"description": "Parsed data object.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.JSON",
"module": "dataschema",
"submodule": "dataschema-json"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-json.js",
"line": 407,
"description": "Parses results data according to schema",
"itemtype": "method",
"name": "_parseMeta",
"params": [
{
"name": "metaFields",
"description": "Metafields definitions.",
"type": "Object"
},
{
"name": "json_in",
"description": "JSON to parse.",
"type": "Object"
},
{
"name": "data_out",
"description": "In-progress parsed data to update.",
"type": "Object"
}
],
"return": {
"description": "Schema-parsed meta data.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.JSON",
"module": "dataschema",
"submodule": "dataschema-json"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-text.js",
"line": 31,
"description": "Applies a schema to a string of delimited data, returning a normalized\nobject with results in the `results` property. The `meta` property of\nthe response object is present for consistency, but is assigned an\nempty object. If the input data is absent or not a string, an `error`\nproperty will be added.\n\nUse _schema.resultDelimiter_ and _schema.fieldDelimiter_ to instruct\n`apply` how to split up the string into an array of data arrays for\nprocessing.\n\nUse _schema.resultFields_ to specify the keys in the generated result\nobjects in `response.results`. The key:value pairs will be assigned\nin the order of the _schema.resultFields_ array, assuming the values\nin the data records are defined in the same order.\n\n_schema.resultFields_ field identifiers are objects with the following\nproperties:\n\n * `key` :
(required) The property name you want\n the data value assigned to in the result object (String)\n * `parser`: A function or the name of a function on `Y.Parsers` used\n to convert the input value into a normalized type. Parser\n functions are passed the value as input and are expected to\n return a value.\n\nIf no value parsing is needed, you can use just the desired property\nname string as the field identifier instead of an object (see example\nbelow).",
"example": [
"\n // Process simple csv\n var schema = {\n resultDelimiter: \"\\n\",\n fieldDelimiter: \",\",\n resultFields: [ 'fruit', 'color' ]\n },\n data = \"Banana,yellow\\nOrange,orange\\nEggplant,purple\";\n\n var response = Y.DataSchema.Text.apply(schema, data);\n\n // response.results[0] is { fruit: \"Banana\", color: \"yellow\" }\n\n\n // Use parsers\n schema.resultFields = [\n {\n key: 'fruit',\n parser: function (val) { return val.toUpperCase(); }\n },\n 'color' // mix and match objects and strings\n ];\n\n response = Y.DataSchema.Text.apply(schema, data);\n\n // response.results[0] is { fruit: \"BANANA\", color: \"yellow\" }"
],
"itemtype": "method",
"name": "apply",
"params": [
{
"name": "schema",
"description": "Schema to apply. Supported configuration\n properties are:",
"type": "Object",
"props": [
{
"name": "resultDelimiter",
"description": "Character or character\n sequence that marks the end of one record and the start of\n another.",
"type": "String"
},
{
"name": "fieldDelimiter",
"description": "Character or character\n sequence that marks the end of a field and the start of\n another within the same record.",
"type": "String",
"optional": true
},
{
"name": "resultFields",
"description": "Field identifiers to\n assign values in the response records. See above for details.",
"type": "Array",
"optional": true
}
]
},
{
"name": "data",
"description": "Text data.",
"type": "String"
}
],
"return": {
"description": "An Object with properties `results` and `meta`",
"type": "Object"
},
"static": 1,
"class": "DataSchema.Text",
"module": "dataschema",
"submodule": "dataschema-text"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-text.js",
"line": 118,
"description": "Schema-parsed list of results from full data",
"itemtype": "method",
"name": "_parseResults",
"params": [
{
"name": "schema",
"description": "Schema to parse against.",
"type": "Array"
},
{
"name": "text_in",
"description": "Text to parse.",
"type": "String"
},
{
"name": "data_out",
"description": "In-progress parsed data to update.",
"type": "Object"
}
],
"return": {
"description": "Parsed data object.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.Text",
"module": "dataschema",
"submodule": "dataschema-text"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-xml.js",
"line": 34,
"description": "Applies a schema to an XML data tree, returning a normalized object with\nresults in the `results` property. Additional information can be parsed out\nof the XML for inclusion in the `meta` property of the response object. If\nan error is encountered during processing, an `error` property will be\nadded.\n\nField data in the nodes captured by the XPath in _schema.resultListLocator_\nis extracted with the field identifiers described in _schema.resultFields_.\nField identifiers are objects with the following properties:\n\n * `key` :
(required) The desired property name to use\n store the retrieved value in the result object. If `locator` is\n not specified, `key` is also used as the XPath locator (String)\n * `locator`: The XPath locator to the node or attribute within each\n result node found by _schema.resultListLocator_ containing the\n desired field data (String)\n * `parser` : A function or the name of a function on `Y.Parsers` used\n to convert the input value into a normalized type. Parser\n functions are passed the value as input and are expected to\n return a value.\n * `schema` : Used to retrieve nested field data into an array for\n assignment as the result field value. This object follows the same\n conventions as _schema_.\n\nIf no value parsing or nested parsing is needed, you can use XPath locators\n(strings) instead of field identifiers (objects) -- see example below.\n\n`response.results` will contain an array of objects with key:value pairs.\nThe keys are the field identifier `key`s, and the values are the data\nvalues extracted from the nodes or attributes found by the field `locator`\n(or `key` fallback).\n\nTo extract additional information from the XML, include an array of\nXPath locators in _schema.metaFields_. The collected values will be\nstored in `response.meta` with the XPath locator as keys.",
"example": [
"\n var schema = {\n resultListLocator: '//produce/item',\n resultFields: [\n {\n locator: 'name',\n key: 'name'\n },\n {\n locator: 'color',\n key: 'color',\n parser: function (val) { return val.toUpperCase(); }\n }\n ]\n };\n\n // Assumes data like\n //
\n // \n // - Bananayellow
\n // - Orangeorange
\n // - Eggplantpurple
\n // \n // \n\n var response = Y.DataSchema.JSON.apply(schema, data);\n\n // response.results[0] is { name: \"Banana\", color: \"YELLOW\" }"
],
"itemtype": "method",
"name": "apply",
"params": [
{
"name": "schema",
"description": "Schema to apply. Supported configuration\n properties are:",
"type": "Object",
"props": [
{
"name": "resultListLocator",
"description": "XPath locator for the\n XML nodes that contain the data to flatten into `response.results`",
"type": "String",
"optional": true
},
{
"name": "resultFields",
"description": "Field identifiers to\n locate/assign values in the response records. See above for\n details.",
"type": "Array",
"optional": true
},
{
"name": "metaFields",
"description": "XPath locators to extract extra\n non-record related information from the XML data",
"type": "Array",
"optional": true
}
]
},
{
"name": "data",
"description": "XML data to parse",
"type": "XMLDoc"
}
],
"return": {
"description": "An Object with properties `results` and `meta`",
"type": "Object"
},
"static": 1,
"class": "DataSchema.XML",
"module": "dataschema",
"submodule": "dataschema-xml"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-xml.js",
"line": 132,
"description": "Get an XPath-specified value for a given field from an XML node or document.",
"itemtype": "method",
"name": "_getLocationValue",
"params": [
{
"name": "field",
"description": "Field definition.",
"type": "String | Object"
},
{
"name": "context",
"description": "XML node or document to search within.",
"type": "Object"
}
],
"return": {
"description": "Data value or null.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.XML",
"module": "dataschema",
"submodule": "dataschema-xml"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-xml.js",
"line": 168,
"description": "Fetches the XPath-specified result for a given location in an XML node\nor document.",
"itemtype": "method",
"name": "_getXPathResult",
"params": [
{
"name": "locator",
"description": "The XPath location.",
"type": "String"
},
{
"name": "context",
"description": "XML node or document to search within.",
"type": "Object"
},
{
"name": "xmldoc",
"description": "XML document to resolve namespace.",
"type": "Object"
}
],
"return": {
"description": "Data collection or null.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.XML",
"module": "dataschema",
"submodule": "dataschema-xml"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-xml.js",
"line": 262,
"description": "Schema-parsed result field.",
"itemtype": "method",
"name": "_parseField",
"params": [
{
"name": "field",
"description": "Required. Field definition.",
"type": "String | Object"
},
{
"name": "result",
"description": "Required. Schema parsed data object.",
"type": "Object"
},
{
"name": "context",
"description": "Required. XML node or document to search within.",
"type": "Object"
}
],
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.XML",
"module": "dataschema",
"submodule": "dataschema-xml"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-xml.js",
"line": 286,
"description": "Parses results data according to schema",
"itemtype": "method",
"name": "_parseMeta",
"params": [
{
"name": "xmldoc_in",
"description": "XML document parse.",
"type": "Object"
},
{
"name": "data_out",
"description": "In-progress schema-parsed data to update.",
"type": "Object"
}
],
"return": {
"description": "Schema-parsed data.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.XML",
"module": "dataschema",
"submodule": "dataschema-xml"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-xml.js",
"line": 310,
"description": "Schema-parsed result to add to results list.",
"itemtype": "method",
"name": "_parseResult",
"params": [
{
"name": "fields",
"description": "Required. A collection of field definition.",
"type": "Array"
},
{
"name": "context",
"description": "Required. XML node or document to search within.",
"type": "Object"
}
],
"return": {
"description": "Schema-parsed data.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.XML",
"module": "dataschema",
"submodule": "dataschema-xml"
},
{
"file": "lib/yui3/src/dataschema/js/dataschema-xml.js",
"line": 331,
"description": "Schema-parsed list of results from full data",
"itemtype": "method",
"name": "_parseResults",
"params": [
{
"name": "schema",
"description": "Schema to parse against.",
"type": "Object"
},
{
"name": "context",
"description": "XML node or document to parse.",
"type": "Object"
},
{
"name": "data_out",
"description": "In-progress schema-parsed data to update.",
"type": "Object"
}
],
"return": {
"description": "Schema-parsed data.",
"type": "Object"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "DataSchema.XML",
"module": "dataschema",
"submodule": "dataschema-xml"
},
{
"file": "lib/yui3/src/datasource/js/datasource-arrayschema.js",
"line": 18,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"schema\"",
"class": "DataSourceArraySchema",
"module": "datasource",
"submodule": "datasource-arrayschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-arrayschema.js",
"line": 30,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceArraySchema\"",
"class": "DataSourceArraySchema",
"module": "datasource",
"submodule": "datasource-arrayschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-arrayschema.js",
"line": 55,
"description": "Internal init() handler.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataSourceArraySchema",
"module": "datasource",
"submodule": "datasource-arrayschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-arrayschema.js",
"line": 66,
"description": "Parses raw data into a normalized response.",
"itemtype": "method",
"name": "_beforeDefDataFn",
"params": [
{
"name": "tId",
"description": "Unique transaction ID.",
"type": "Number"
},
{
"name": "request",
"description": "The request.",
"type": "Object"
},
{
"name": "callback",
"description": "The callback object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
",
"type": "Object"
},
{
"name": "data",
"description": "Raw data.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataSourceArraySchema",
"module": "datasource",
"submodule": "datasource-arrayschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-cache.js",
"line": 16,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"cache\"",
"class": "DataSourceCacheExtension",
"module": "datasource",
"submodule": "datasource-cache"
},
{
"file": "lib/yui3/src/datasource/js/datasource-cache.js",
"line": 28,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceCacheExtension\"",
"class": "DataSourceCacheExtension",
"module": "datasource",
"submodule": "datasource-cache"
},
{
"file": "lib/yui3/src/datasource/js/datasource-cache.js",
"line": 41,
"description": "Internal init() handler.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataSourceCacheExtension",
"module": "datasource",
"submodule": "datasource-cache"
},
{
"file": "lib/yui3/src/datasource/js/datasource-cache.js",
"line": 53,
"description": "First look for cached response, then send request to live data.",
"itemtype": "method",
"name": "_beforeDefRequestFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- The callback object.
\n- cfg (Object)
- Configuration object.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "DataSourceCacheExtension",
"module": "datasource",
"submodule": "datasource-cache"
},
{
"file": "lib/yui3/src/datasource/js/datasource-cache.js",
"line": 82,
"description": "Adds data to cache before returning data.",
"itemtype": "method",
"name": "_beforeDefResponseFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- The callback object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- data (Object)
- Raw data.
\n- response (Object)
- Normalized response object with the following properties:\n
\n - cached (Object)
- True when response is cached.
\n - results (Object)
- Parsed results.
\n - meta (Object)
- Parsed meta data.
\n - error (Object)
- Error object.
\n
\n \n- cfg (Object)
- Configuration object.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "DataSourceCacheExtension",
"module": "datasource",
"submodule": "datasource-cache"
},
{
"file": "lib/yui3/src/datasource/js/datasource-cache.js",
"line": 136,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"cache\"",
"class": "DataSourceCache",
"module": "datasource",
"submodule": "datasource-cache"
},
{
"file": "lib/yui3/src/datasource/js/datasource-cache.js",
"line": 148,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceCache\"",
"class": "DataSourceCache",
"module": "datasource",
"submodule": "datasource-cache"
},
{
"file": "lib/yui3/src/datasource/js/datasource-function.js",
"line": 27,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceFunction\"",
"class": "DataSource.Function",
"module": "datasource",
"submodule": "datasource-function"
},
{
"file": "lib/yui3/src/datasource/js/datasource-function.js",
"line": 46,
"itemtype": "attribute",
"name": "source",
"description": "Pointer to live data.",
"type": "MIXED",
"default": "null",
"class": "DataSource.Function",
"module": "datasource",
"submodule": "datasource-function"
},
{
"file": "lib/yui3/src/datasource/js/datasource-function.js",
"line": 59,
"description": "Passes query string to IO. Fires
response event when\nresponse is received asynchronously.",
"itemtype": "method",
"name": "_defRequestFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- The callback object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "DataSource.Function",
"module": "datasource",
"submodule": "datasource-function"
},
{
"file": "lib/yui3/src/datasource/js/datasource-get.js",
"line": 20,
"description": "Passes query string to Get Utility. Fires
response event when\nresponse is received asynchronously.",
"itemtype": "method",
"name": "_defRequestFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- The callback object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "DataSource.Get",
"module": "datasource",
"submodule": "datasource-get"
},
{
"file": "lib/yui3/src/datasource/js/datasource-get.js",
"line": 47,
"description": "Stores the most recent request id for validation against stale\nresponse handling.",
"itemtype": "property",
"name": "_last",
"type": "{String}",
"access": "protected",
"tagname": "",
"class": "DataSource.Get",
"module": "datasource",
"submodule": "datasource-get"
},
{
"file": "lib/yui3/src/datasource/js/datasource-get.js",
"line": 110,
"description": "Default method for adding callback param to url. See\ngenerateRequestCallback attribute.",
"itemtype": "method",
"name": "_generateRequest",
"params": [
{
"name": "guid",
"description": "unique identifier for callback function wrapper",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "DataSource.Get",
"module": "datasource",
"submodule": "datasource-get"
},
{
"file": "lib/yui3/src/datasource/js/datasource-get.js",
"line": 125,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceGet\"",
"class": "DataSource.Get",
"module": "datasource",
"submodule": "datasource-get"
},
{
"file": "lib/yui3/src/datasource/js/datasource-get.js",
"line": 143,
"description": "Pointer to Get Utility.",
"itemtype": "attribute",
"name": "get",
"type": "Y.Get",
"default": "Y.Get",
"class": "DataSource.Get",
"module": "datasource",
"submodule": "datasource-get"
},
{
"file": "lib/yui3/src/datasource/js/datasource-get.js",
"line": 155,
"description": "Defines request/response management in the following manner:\n
\n \n - ignoreStaleResponses
\n - Send all requests, but handle only the response for the most\n recently sent request.
\n - allowAll
\n - Send all requests and handle all responses.
\n
",
"itemtype": "attribute",
"name": "asyncMode",
"type": "String",
"default": "\"allowAll\"",
"class": "DataSource.Get",
"module": "datasource",
"submodule": "datasource-get"
},
{
"file": "lib/yui3/src/datasource/js/datasource-get.js",
"line": 179,
"description": "Callback string parameter name sent to the remote script. By default,\nrequests are sent to\n<URI>?<scriptCallbackParam>=callbackFunction",
"itemtype": "attribute",
"name": "scriptCallbackParam",
"type": "String",
"default": "\"callback\"",
"class": "DataSource.Get",
"module": "datasource",
"submodule": "datasource-get"
},
{
"file": "lib/yui3/src/datasource/js/datasource-get.js",
"line": 192,
"description": "Accepts the DataSource instance and a callback ID, and returns a callback\nparam/value string that gets appended to the script URI. Implementers\ncan customize this string to match their server's query syntax.",
"itemtype": "attribute",
"name": "generateRequestCallback",
"type": "Function",
"class": "DataSource.Get",
"module": "datasource",
"submodule": "datasource-get"
},
{
"file": "lib/yui3/src/datasource/js/datasource-io.js",
"line": 25,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceIO\"",
"class": "DataSource.IO",
"module": "datasource",
"submodule": "datasource-io"
},
{
"file": "lib/yui3/src/datasource/js/datasource-io.js",
"line": 44,
"description": "Pointer to IO Utility.",
"itemtype": "attribute",
"name": "io",
"type": "Y.io",
"default": "Y.io",
"class": "DataSource.IO",
"module": "datasource",
"submodule": "datasource-io"
},
{
"file": "lib/yui3/src/datasource/js/datasource-io.js",
"line": 56,
"description": "Default IO Config.",
"itemtype": "attribute",
"name": "ioConfig",
"type": "Object",
"default": "null",
"class": "DataSource.IO",
"module": "datasource",
"submodule": "datasource-io"
},
{
"file": "lib/yui3/src/datasource/js/datasource-io.js",
"line": 70,
"description": "Internal init() handler.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataSource.IO",
"module": "datasource",
"submodule": "datasource-io"
},
{
"file": "lib/yui3/src/datasource/js/datasource-io.js",
"line": 81,
"description": "IO success callback.",
"itemtype": "method",
"name": "successHandler",
"params": [
{
"name": "id",
"description": "Transaction ID.",
"type": "String"
},
{
"name": "response",
"description": "Response.",
"type": "String"
},
{
"name": "e",
"description": "Event facade.",
"type": "Event.Facade"
}
],
"access": "private",
"tagname": "",
"class": "DataSource.IO",
"module": "datasource",
"submodule": "datasource-io"
},
{
"file": "lib/yui3/src/datasource/js/datasource-io.js",
"line": 106,
"description": "IO failure callback.",
"itemtype": "method",
"name": "failureHandler",
"params": [
{
"name": "id",
"description": "Transaction ID.",
"type": "String"
},
{
"name": "response",
"description": "Response.",
"type": "String"
},
{
"name": "e",
"description": "Event facade.",
"type": "Event.Facade"
}
],
"access": "private",
"tagname": "",
"class": "DataSource.IO",
"module": "datasource",
"submodule": "datasource-io"
},
{
"file": "lib/yui3/src/datasource/js/datasource-io.js",
"line": 134,
"itemtype": "property",
"name": "_queue",
"description": "Object literal to manage asynchronous request/response\ncycles enabled if queue needs to be managed (asyncMode/ioConnMode):\n
\n - interval {Number}
\n - Interval ID of in-progress queue.
\n - conn
\n - In-progress connection identifier (if applicable).
\n - requests {Object[]}
\n - Array of queued request objects: {request:request, callback:callback}.
\n
",
"type": "Object",
"default": "{interval:null, conn:null, requests:[]}",
"access": "private",
"tagname": "",
"class": "DataSource.IO",
"module": "datasource",
"submodule": "datasource-io"
},
{
"file": "lib/yui3/src/datasource/js/datasource-io.js",
"line": 152,
"description": "Passes query string to IO. Fires
response event when\nresponse is received asynchronously.",
"itemtype": "method",
"name": "_defRequestFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- The callback object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "DataSource.IO",
"module": "datasource",
"submodule": "datasource-io"
},
{
"file": "lib/yui3/src/datasource/js/datasource-jsonschema.js",
"line": 18,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"schema\"",
"class": "DataSourceJSONSchema",
"module": "datasource",
"submodule": "datasource-jsonschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-jsonschema.js",
"line": 30,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceJSONSchema\"",
"class": "DataSourceJSONSchema",
"module": "datasource",
"submodule": "datasource-jsonschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-jsonschema.js",
"line": 55,
"description": "Internal init() handler.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataSourceJSONSchema",
"module": "datasource",
"submodule": "datasource-jsonschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-jsonschema.js",
"line": 66,
"description": "Parses raw data into a normalized response. To accommodate XHR responses,\nwill first look for data in data.responseText. Otherwise will just work\nwith data.",
"itemtype": "method",
"name": "_beforeDefDataFn",
"params": [
{
"name": "tId",
"description": "Unique transaction ID.",
"type": "Number"
},
{
"name": "request",
"description": "The request.",
"type": "Object"
},
{
"name": "callback",
"description": "The callback object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
",
"type": "Object"
},
{
"name": "data",
"description": "Raw data.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataSourceJSONSchema",
"module": "datasource",
"submodule": "datasource-jsonschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 36,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceLocal\"",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 54,
"itemtype": "attribute",
"name": "source",
"description": "Pointer to live data.",
"type": "MIXED",
"default": "null",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 65,
"description": "Global transaction counter.",
"itemtype": "property",
"name": "_tId",
"type": "Number",
"static": 1,
"access": "private",
"tagname": "",
"default": "0",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 76,
"description": "Global in-progress transaction objects.",
"itemtype": "property",
"name": "transactions",
"type": "Object",
"static": 1,
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 85,
"description": "Returns data to callback.",
"itemtype": "method",
"name": "issueCallback",
"params": [
{
"name": "e",
"description": "Event Facade.",
"type": "EventFacade"
},
{
"name": "caller",
"description": "Calling DataSource instance.",
"type": "DataSource"
}
],
"static": 1,
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 113,
"description": "Internal init() handler.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 124,
"description": "This method creates all the events for this module.",
"itemtype": "method",
"name": "_initEvents",
"access": "private",
"tagname": "",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 130,
"description": "Fired when a data request is received.",
"itemtype": "event",
"name": "request",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- The callback object\n (deprecated, refer to on
\n- on (Object)
- The map of configured callback\n functions.
\n- cfg (Object)
- Configuration object.
\n
",
"type": "Event.Facade"
}
],
"preventable": "_defRequestFn",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 148,
"description": "Fired when raw data is received.",
"itemtype": "event",
"name": "data",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- Deprecated alias for the\n on property
\n- on (Object)
- The map of configured transaction\n callbacks. An object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n- data (Object)
- Raw data.
\n
",
"type": "Event.Facade"
}
],
"preventable": "_defDataFn",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 172,
"description": "Fired when response is returned.",
"itemtype": "event",
"name": "response",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- Deprecated alias for the\n on property
\n- on (Object)
- The map of configured transaction\n callbacks. An object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n- data (Object)
- Raw data.
\n- response (Object)
\n - Normalized response object with the following properties:\n
\n - results (Object)
- Parsed results.
\n - meta (Object)
- Parsed meta data.
\n - error (Boolean)
- Error flag.
\n
\n \n- error
\n - Any error that occurred along the transaction lifecycle.
\n
",
"type": "Event.Facade"
}
],
"preventable": "_defResponseFn",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 206,
"description": "Fired when an error is encountered.",
"itemtype": "event",
"name": "error",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- Deprecated alias for the\n on property
\n- on (Object)
- The map of configured transaction\n callbacks. An object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n- data (Object)
- Raw data.
\n- response (Object)
\n - Normalized response object with the following properties:\n
\n - results (Object)
- Parsed results.
\n - meta (Object)
- Parsed meta data.
\n - error (Object)
- Error object.
\n
\n \n- error
\n - Any error that occurred along the transaction lifecycle.
\n
",
"type": "Event.Facade"
}
],
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 240,
"description": "Manages request/response transaction. Must fire
response\nevent when response is received. This method should be implemented by\nsubclasses to achieve more complex behavior such as accessing remote data.",
"itemtype": "method",
"name": "_defRequestFn",
"params": [
{
"name": "e",
"description": "Event Facadewith the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- Deprecated alias for the\n on property
\n- on (Object)
- The map of configured transaction\n callbacks. An object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 279,
"description": "Normalizes raw data into a response that includes results and meta properties.",
"itemtype": "method",
"name": "_defDataFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- Deprecated alias for the\n on property
\n- on (Object)
- The map of configured transaction\n callbacks. An object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n- data (Object)
- Raw data.
\n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 314,
"description": "Sends data as a normalized response to callback.",
"itemtype": "method",
"name": "_defResponseFn",
"params": [
{
"name": "e",
"description": "Event Facade with the following properties:\n
\n- tId (Number)
- Unique transaction ID.
\n- request (Object)
- The request.
\n- callback (Object)
- Deprecated alias for the\n on property
\n- on (Object)
- The map of configured transaction\n callbacks. An object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
\n \n- cfg (Object)
- Configuration object.
\n- data (Object)
- Raw data.
\n- response (Object)
- Normalized response object with the following properties:\n
\n - results (Object)
- Parsed results.
\n - meta (Object)
- Parsed meta data.
\n - error (Boolean)
- Error flag.
\n
\n \n
",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-local.js",
"line": 348,
"description": "Generates a unique transaction ID and fires
request event.\n
Note: the property
callback is a\ndeprecated alias for the
on transaction configuration\nproperty described below.",
"itemtype": "method",
"name": "sendRequest",
"params": [
{
"name": "request",
"description": "An object literal with the following properties:\n
\n request- The request to send to the live data source, if any.
\n on- An object literal with the following properties:\n
\n success- The function to call when the data is ready.
\n failure- The function to call upon a response failure condition.
\n argument- Arbitrary data payload that will be passed back to the success and failure handlers.
\n
\n \n cfg- Configuration object, if any.
\n
",
"type": "Object"
}
],
"return": {
"description": "Transaction ID.",
"type": "Number"
},
"class": "DataSource.Local",
"module": "datasource",
"submodule": "datasource-local"
},
{
"file": "lib/yui3/src/datasource/js/datasource-polling.js",
"line": 19,
"itemtype": "property",
"name": "_intervals",
"description": "Hash of polling interval IDs that have been enabled,\nstored here to be able to clear all intervals.",
"access": "private",
"tagname": "",
"class": "Pollable",
"module": "datasource",
"submodule": "datasource-polling"
},
{
"file": "lib/yui3/src/datasource/js/datasource-polling.js",
"line": 27,
"description": "Sets up a polling mechanism to send requests at set intervals and\nforward responses to given callback.",
"itemtype": "method",
"name": "setInterval",
"params": [
{
"name": "msec",
"description": "Length of interval in milliseconds.",
"type": "Number"
},
{
"name": "request",
"description": "An object literal with the following properties:\n
\n request- The request to send to the live data source, if any.
\n callback- An object literal with the following properties:\n
\n success- The function to call when the data is ready.
\n failure- The function to call upon a response failure condition.
\n argument- Arbitrary data payload that will be passed back to the success and failure handlers.
\n
\n \n cfg- Configuration object, if any.
\n
",
"type": "Object"
}
],
"return": {
"description": "Interval ID.",
"type": "Number"
},
"class": "Pollable",
"module": "datasource",
"submodule": "datasource-polling"
},
{
"file": "lib/yui3/src/datasource/js/datasource-polling.js",
"line": 61,
"description": "Disables polling mechanism associated with the given interval ID.",
"itemtype": "method",
"name": "clearInterval",
"params": [
{
"name": "id",
"description": "Interval ID.",
"type": "Number"
}
],
"class": "Pollable",
"module": "datasource",
"submodule": "datasource-polling"
},
{
"file": "lib/yui3/src/datasource/js/datasource-polling.js",
"line": 78,
"description": "Clears all intervals.",
"itemtype": "method",
"name": "clearAllIntervals",
"class": "Pollable",
"module": "datasource",
"submodule": "datasource-polling"
},
{
"file": "lib/yui3/src/datasource/js/datasource-textschema.js",
"line": 18,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"schema\"",
"class": "DataSourceTextSchema",
"module": "datasource",
"submodule": "datasource-textschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-textschema.js",
"line": 30,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceTextSchema\"",
"class": "DataSourceTextSchema",
"module": "datasource",
"submodule": "datasource-textschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-textschema.js",
"line": 55,
"description": "Internal init() handler.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataSourceTextSchema",
"module": "datasource",
"submodule": "datasource-textschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-textschema.js",
"line": 66,
"description": "Parses raw data into a normalized response.",
"itemtype": "method",
"name": "_beforeDefDataFn",
"params": [
{
"name": "tId",
"description": "Unique transaction ID.",
"type": "Number"
},
{
"name": "request",
"description": "The request.",
"type": "Object"
},
{
"name": "callback",
"description": "The callback object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
",
"type": "Object"
},
{
"name": "data",
"description": "Raw data.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataSourceTextSchema",
"module": "datasource",
"submodule": "datasource-textschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-xmlschema.js",
"line": 18,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"schema\"",
"class": "DataSourceXMLSchema",
"module": "datasource",
"submodule": "datasource-xmlschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-xmlschema.js",
"line": 30,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataSourceXMLSchema\"",
"class": "DataSourceXMLSchema",
"module": "datasource",
"submodule": "datasource-xmlschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-xmlschema.js",
"line": 55,
"description": "Internal init() handler.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataSourceXMLSchema",
"module": "datasource",
"submodule": "datasource-xmlschema"
},
{
"file": "lib/yui3/src/datasource/js/datasource-xmlschema.js",
"line": 66,
"description": "Parses raw data into a normalized response.",
"itemtype": "method",
"name": "_beforeDefDataFn",
"params": [
{
"name": "tId",
"description": "Unique transaction ID.",
"type": "Number"
},
{
"name": "request",
"description": "The request.",
"type": "Object"
},
{
"name": "callback",
"description": "The callback object with the following properties:\n
\n - success (Function)
- Success handler.
\n - failure (Function)
- Failure handler.
\n
",
"type": "Object"
},
{
"name": "data",
"description": "Raw data.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataSourceXMLSchema",
"module": "datasource",
"submodule": "datasource-xmlschema"
},
{
"file": "lib/yui3/src/datasource/tests/src/datasource-xmlschema.js",
"line": 61,
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datasource/tests/src/datasource-xmlschema.js",
"line": 62,
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datasource/tests/src/datasource-xmlschema.js",
"line": 63,
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datasource/tests/datasource-xmlschema-tests.js",
"line": 63,
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datasource/tests/datasource-xmlschema-tests.js",
"line": 64,
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datasource/tests/datasource-xmlschema-tests.js",
"line": 65,
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 18,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "{String}",
"static": 1,
"final": 1,
"value": "\"column\"",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 35,
"description": "Unique internal identifier, used to stamp ID on TH element.",
"itemtype": "attribute",
"name": "id",
"type": "{String}",
"readonly": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 47,
"description": "User-supplied identifier. Defaults to id.",
"itemtype": "attribute",
"name": "key",
"type": "{String}",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 56,
"description": "Points to underlying data field (for sorting or formatting, for\nexample). Useful when column doesn't hold any data itself, but is just\na visual representation of data from another column or record field.\nDefaults to key.",
"itemtype": "attribute",
"name": "field",
"type": "{String}",
"default": "(column key)",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 70,
"description": "Display label for column header. Defaults to key.",
"itemtype": "attribute",
"name": "label",
"type": "{String}",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 80,
"description": "Array of child column definitions (for nested headers).",
"itemtype": "attribute",
"name": "children",
"type": "{String}",
"default": "null",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 91,
"description": "TH abbr attribute.",
"itemtype": "attribute",
"name": "abbr",
"type": "{String}",
"default": "\"\"",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 109,
"description": "Formating template string or function for cells in this column.\n\nFunction formatters receive a single object (described below) and are\nexpected to output the `innerHTML` of the cell.\n\nString templates can include markup and {placeholder} tokens to be\nfilled in from the object passed to function formatters.",
"itemtype": "attribute",
"name": "formatter",
"type": "{String|Function}",
"params": [
{
"name": "data",
"description": "Data relevant to the rendering of this cell",
"type": "Object",
"props": [
{
"name": "classnames",
"description": "CSS classes to add to the cell",
"type": "String"
},
{
"name": "column",
"description": "This Column instance",
"type": "Column"
},
{
"name": "data",
"description": "The raw object data from the Record",
"type": "Object"
},
{
"name": "field",
"description": "This Column's \"field\" attribute value",
"type": "String"
},
{
"name": "headers",
"description": "TH ids to reference in the cell's\n \"headers\" attribute",
"type": "String"
},
{
"name": "record",
"description": "The Record instance for this row",
"type": "Record"
},
{
"name": "rowindex",
"description": "The index for this row",
"type": "Number"
},
{
"name": "tbody",
"description": "The TBODY Node that will house the cell",
"type": "Node"
},
{
"name": "tr",
"description": "The row TR Node that will house the cell",
"type": "Node"
},
{
"name": "value",
"description": "The raw Record data for this cell",
"type": "Any"
}
]
}
],
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 135,
"description": "The default markup to display in cells that have no corresponding record\ndata or content from formatters.",
"itemtype": "attribute",
"name": "emptyCellValue",
"type": "{String}",
"default": "''",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 180,
"description": "Return ID for instance.",
"itemtype": "method",
"name": "_defaultId",
"return": {
"description": "",
"type": "String"
},
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 191,
"description": "Return key for instance. Defaults to ID if one was not provided.",
"itemtype": "method",
"name": "_defaultKey",
"return": {
"description": "",
"type": "String"
},
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 202,
"description": "Return field for instance. Defaults to key if one was not provided.",
"itemtype": "method",
"name": "_defaultField",
"return": {
"description": "",
"type": "String"
},
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 213,
"description": "Return label for instance. Defaults to key if one was not provided.",
"itemtype": "method",
"name": "_defaultLabel",
"return": {
"description": "",
"type": "String"
},
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 224,
"description": "Updates the UI if changes are made to abbr.",
"itemtype": "method",
"name": "_afterAbbrChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change.",
"type": "Event"
}
],
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 240,
"description": "Reference to Column's current position index within its Columnset's keys\narray, if applicable. This property only applies to non-nested and bottom-\nlevel child Columns. Value is set by Columnset code.",
"itemtype": "property",
"name": "keyIndex",
"type": "{Number}",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 250,
"description": "Array of TH IDs associated with this column, for TD \"headers\" attribute.\nValue is set by Columnset code",
"itemtype": "property",
"name": "headers",
"type": "{String[]}",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 259,
"description": "Number of cells the header spans. Value is set by Columnset code.",
"itemtype": "property",
"name": "colSpan",
"type": "{Number}",
"default": "1",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 268,
"description": "Number of rows the header spans. Value is set by Columnset code.",
"itemtype": "property",
"name": "rowSpan",
"type": "{Number}",
"default": "1",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 277,
"description": "Column's parent Column instance, if applicable. Value is set by Columnset\ncode.",
"itemtype": "property",
"name": "parent",
"type": "{Column}",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 286,
"description": "The Node reference to the associated TH element.",
"itemtype": "property",
"name": "thNode",
"type": "{Node}",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 308,
"description": "Initializer.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 318,
"description": "Destructor.",
"itemtype": "method",
"name": "destructor",
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 327,
"description": "Returns classnames for Column.",
"itemtype": "method",
"name": "_getClassnames",
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 342,
"description": "Syncs UI to intial state.",
"itemtype": "method",
"name": "syncUI",
"access": "private",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/column.js",
"line": 352,
"description": "Updates abbr.",
"itemtype": "method",
"name": "_uiSetAbbr",
"params": [
{
"name": "val",
"description": "New abbr.",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "Column",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 18,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"columnset\"",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 35,
"itemtype": "attribute",
"name": "definitions",
"description": "Array of column definitions that will populate this Columnset.",
"type": "Array",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 58,
"itemtype": "method",
"name": "_setDefinitions",
"description": "Clones definitions before setting.",
"params": [
{
"name": "definitions",
"description": "Array of column definitions.",
"type": "Array"
}
],
"return": {
"description": "Array"
},
"access": "private",
"tagname": "",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 74,
"description": "Top-down tree representation of Column hierarchy. Used to create DOM\nelements.",
"itemtype": "property",
"name": "tree",
"type": "{Column[]}",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 83,
"description": "Hash of all Columns by ID.",
"itemtype": "property",
"name": "idHash",
"type": "Object",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 91,
"description": "Hash of all Columns by key.",
"itemtype": "property",
"name": "keyHash",
"type": "Object",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 99,
"description": "Array of only Columns that are meant to be displayed in DOM.",
"itemtype": "property",
"name": "keys",
"type": "{Column[]}",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 112,
"description": "Initializer. Generates all internal representations of the collection of\nColumns.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 215,
"description": "Destructor.",
"itemtype": "method",
"name": "destructor",
"access": "private",
"tagname": "",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 229,
"description": "Cascade certain properties to children if not defined on their own.",
"itemtype": "method",
"name": "_cascadePropertiesToChildren",
"access": "private",
"tagname": "",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 274,
"itemtype": "method",
"name": "_setColSpans",
"description": "Calculates and sets colSpan attribute on given Column.",
"params": [
{
"name": "column",
"description": "Column instance.",
"type": "Array"
},
{
"name": "definition",
"description": "Column definition.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 306,
"itemtype": "method",
"name": "_setRowSpans",
"description": "Calculates and sets rowSpan attribute on all Columns.",
"access": "private",
"tagname": "",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/columnset.js",
"line": 372,
"itemtype": "method",
"name": "_setHeaders",
"description": "Calculates and sets headers attribute on all Columns.",
"access": "private",
"tagname": "",
"class": "Columnset",
"module": "datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 34,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataTable\"",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 51,
"itemtype": "attribute",
"name": "columnset",
"description": "Pointer to Columnset instance.",
"type": "Array | Y.Columnset",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 60,
"itemtype": "attribute",
"name": "recordset",
"description": "Pointer to Recordset instance.",
"type": "Array | Y.Recordset",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 82,
"itemtype": "attribute",
"name": "summary",
"description": "Summary.",
"type": "String",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 90,
"itemtype": "attribute",
"name": "caption",
"description": "Caption",
"type": "String",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 98,
"itemtype": "attribute",
"name": "thValueTemplate",
"description": "Tokenized markup template for TH value.",
"type": "String",
"default": "'{value}'",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 108,
"itemtype": "attribute",
"name": "tdValueTemplate",
"description": "Tokenized markup template for TD value.",
"type": "String",
"default": "'{value}'",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 118,
"itemtype": "attribute",
"name": "trTemplate",
"description": "Tokenized markup template for TR node creation.",
"type": "String",
"default": "'
|
'",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 147,
"itemtype": "property",
"name": "thTemplate",
"description": "Tokenized markup template for TH node creation.",
"type": "String",
"default": "'
{value} | '",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 155,
"itemtype": "property",
"name": "tdTemplate",
"description": "Tokenized markup template for TD node creation.",
"type": "String",
"default": "'
{value} | '",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 163,
"itemtype": "property",
"name": "_theadNode",
"description": "Pointer to THEAD node.",
"type": "{Node}",
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 171,
"itemtype": "property",
"name": "_tbodyNode",
"description": "Pointer to TBODY node.",
"type": "{Node}",
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 179,
"itemtype": "property",
"name": "_msgNode",
"description": "Pointer to message display node.",
"type": "{Node}",
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 192,
"itemtype": "method",
"name": "_setColumnset",
"description": "Converts Array to Y.Columnset.",
"params": [
{
"name": "columns",
"description": "",
"type": "Array | Y.Columnset"
}
],
"return": {
"description": "",
"type": "Columnset"
},
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 203,
"description": "Updates the UI if Columnset is changed.",
"itemtype": "method",
"name": "_afterColumnsetChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change.",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 214,
"itemtype": "method",
"name": "_setRecordset",
"description": "Converts Array to Y.Recordset.",
"params": [
{
"name": "records",
"description": "",
"type": "Array | Recordset"
}
],
"return": {
"description": "",
"type": "Recordset"
},
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 230,
"description": "Updates the UI if Recordset is changed.",
"itemtype": "method",
"name": "_afterRecordsetChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change.",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 241,
"description": "Updates the UI if Recordset records are changed.",
"itemtype": "method",
"name": "_afterRecordsChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change.",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 252,
"description": "Updates the UI if summary is changed.",
"itemtype": "method",
"name": "_afterSummaryChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change.",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 263,
"description": "Updates the UI if caption is changed.",
"itemtype": "method",
"name": "_afterCaptionChange",
"params": [
{
"name": "e",
"description": "Custom event for the attribute change.",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 280,
"description": "Destructor.",
"itemtype": "method",
"name": "destructor",
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 296,
"description": "Renders UI.",
"itemtype": "method",
"name": "renderUI",
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 322,
"description": "Creates and attaches TABLE element to given container.",
"itemtype": "method",
"name": "_addTableNode",
"params": [
{
"name": "containerNode",
"description": "Parent node.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 337,
"description": "Creates and attaches COLGROUP element to given TABLE.",
"itemtype": "method",
"name": "_addColgroupNode",
"params": [
{
"name": "tableNode",
"description": "Parent node.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 363,
"description": "Creates and attaches THEAD element to given container.",
"itemtype": "method",
"name": "_addTheadNode",
"params": [
{
"name": "tableNode",
"description": "Parent node.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 378,
"description": "Creates and attaches TBODY element to given container.",
"itemtype": "method",
"name": "_addTbodyNode",
"params": [
{
"name": "tableNode",
"description": "Parent node.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 391,
"description": "Creates and attaches message display element to given container.",
"itemtype": "method",
"name": "_addMessageNode",
"params": [
{
"name": "tableNode",
"description": "Parent node.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 404,
"description": "Creates and attaches CAPTION element to given container.",
"itemtype": "method",
"name": "_addCaptionNode",
"params": [
{
"name": "tableNode",
"description": "Parent node.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 422,
"description": "Binds events.",
"itemtype": "method",
"name": "bindUI",
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 455,
"description": "Syncs UI to intial state.",
"itemtype": "method",
"name": "syncUI",
"access": "private",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 472,
"description": "Updates summary.",
"itemtype": "method",
"name": "_uiSetSummary",
"params": [
{
"name": "val",
"description": "New summary.",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 484,
"description": "Updates caption.",
"itemtype": "method",
"name": "_uiSetCaption",
"params": [
{
"name": "val",
"description": "New caption.",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 510,
"description": "Updates THEAD.",
"itemtype": "method",
"name": "_uiSetColumnset",
"params": [
{
"name": "cs",
"description": "New Columnset.",
"type": "Columnset"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 548,
"description": "Creates and attaches header row element.",
"itemtype": "method",
"name": "_addTheadTrNode",
"params": [
{
"name": "o",
"description": "{thead, columns}.",
"type": "Object"
},
{
"name": "isFirst",
"description": "Is first row.",
"type": "Boolean"
},
{
"name": "isFirst",
"description": "Is last row.",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 563,
"description": "Creates header row element.",
"itemtype": "method",
"name": "_createTheadTrNode",
"params": [
{
"name": "o",
"description": "{thead, columns}.",
"type": "Object"
},
{
"name": "isFirst",
"description": "Is first row.",
"type": "Boolean"
},
{
"name": "isLast",
"description": "Is last row.",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 597,
"description": "Attaches header row element.",
"itemtype": "method",
"name": "_attachTheadTrNode",
"params": [
{
"name": "o",
"description": "{thead, columns, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 608,
"description": "Creates and attaches header cell element.",
"itemtype": "method",
"name": "_addTheadThNode",
"params": [
{
"name": "o",
"description": "{value, column, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 622,
"description": "Creates header cell element.",
"itemtype": "method",
"name": "_createTheadThNode",
"params": [
{
"name": "o",
"description": "{value, column, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 651,
"description": "Attaches header cell element.",
"itemtype": "method",
"name": "_attachTheadThNode",
"params": [
{
"name": "o",
"description": "{value, column, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 667,
"description": "Updates TBODY.",
"itemtype": "method",
"name": "_uiSetRecordset",
"params": [
{
"name": "rs",
"description": "New Recordset.",
"type": "Recordset"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 754,
"description": "Creates and attaches data row element.",
"itemtype": "method",
"name": "_addTbodyTrNode",
"params": [
{
"name": "o",
"description": "{tbody, record}",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 769,
"description": "Creates data row element.",
"itemtype": "method",
"name": "_createTbodyTrNode",
"params": [
{
"name": "o",
"description": "{tbody, record}",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 797,
"description": "Attaches data row element.",
"itemtype": "method",
"name": "_attachTbodyTrNode",
"params": [
{
"name": "o",
"description": "{tbody, record, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 820,
"description": "Creates and attaches data cell element.",
"itemtype": "method",
"name": "_addTbodyTdNode",
"params": [
{
"name": "o",
"description": "{record, column, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 833,
"description": "Creates a TD Node from the tdTemplate property using the input object as\ntemplate {placeholder} values. The created Node is also assigned to the\n`td` property on the input object.\n\nIf the input object already has a `td` property, it is returned an no new\nNode is created.",
"itemtype": "method",
"name": "createCell",
"params": [
{
"name": "data",
"description": "Template values",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 850,
"description": "Creates data cell element.",
"itemtype": "method",
"name": "_createTbodyTdNode",
"params": [
{
"name": "o",
"description": "{record, column, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Node"
},
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 865,
"description": "Attaches data cell element.",
"itemtype": "method",
"name": "_attachTbodyTdNode",
"params": [
{
"name": "o",
"description": "{record, column, tr, headers, classnames, value}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-base.js",
"line": 876,
"description": "Returns markup to insert into data cell element.",
"itemtype": "method",
"name": "formatDataCell",
"params": [
{
"name": "@param",
"description": "o {record, column, tr, headers, classnames}.",
"type": "Object"
}
],
"class": "DataTable.Base",
"module": "datatable",
"submodule": "datatable-base"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 23,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"datasource\"",
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 35,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataTableDataSource\"",
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 52,
"itemtype": "attribute",
"name": "datasource",
"description": "Pointer to DataSource instance.",
"type": "{DataSource}",
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 61,
"itemtype": "attribute",
"name": "initialRequest",
"description": "Request sent to DataSource immediately upon initialization.",
"type": "Object",
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 83,
"itemtype": "method",
"name": "_setDataSource",
"description": "Creates new DataSource instance if one is not provided.",
"params": [
{
"name": "ds",
"description": "",
"type": "Object | Y.DataSource"
}
],
"return": {
"description": "",
"type": "DataSource"
},
"access": "private",
"tagname": "",
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 94,
"itemtype": "method",
"name": "_setInitialRequest",
"description": "Sends request to DataSource.",
"params": [
{
"name": "request",
"description": "DataSource request.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 108,
"description": "Initializer.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 127,
"description": "Load data by calling DataSource's sendRequest() method under the hood.",
"itemtype": "method",
"name": "load",
"params": [
{
"name": "config",
"description": "Optional configuration parameters:\n\n
\n- request
- Pass in a new request, or initialRequest is used.
\n- callback
- Pass in DataSource callback object, or the following default is used:\n
\n - success
- datatable.onDataReturnInitializeTable
\n - failure
- datatable.onDataReturnInitializeTable
\n - scope
- datatable
\n - argument
- datatable.getState()
\n
\n \n- datasource
- Pass in a new DataSource instance to override the current DataSource for this transaction.
\n
",
"type": "Object"
}
],
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-datasource.js",
"line": 161,
"description": "Callback function passed to DataSource's sendRequest() method populates\nan entire DataTable with new data, clearing previous data, if any.",
"itemtype": "method",
"name": "onDataReturnInitializeTable",
"params": [
{
"name": "e",
"description": "DataSource Event Facade object.",
"type": "Event.Facade"
}
],
"class": "DataTableDataSource",
"module": "datatable",
"submodule": "datatable-datasource"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 46,
"description": "The width for the table. Set to a string (ex: \"200px\", \"20em\") if you want the table to scroll in the x direction.",
"itemtype": "attribute",
"name": "width",
"access": "public",
"tagname": "",
"type": "string",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 58,
"description": "The height for the table. Set to a string (ex: \"200px\", \"20em\") if you want the table to scroll in the y-direction.",
"itemtype": "attribute",
"name": "height",
"access": "public",
"tagname": "",
"type": "string",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 71,
"description": "The scrolling direction for the table.",
"itemtype": "attribute",
"name": "scroll",
"access": "private",
"tagname": "",
"type": "string",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 100,
"description": "The hexadecimal colour value to set on the top-right of the table if a scrollbar exists.",
"itemtype": "attribute",
"name": "COLOR_COLUMNFILLER",
"access": "public",
"tagname": "",
"type": "string",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 121,
"description": "The table node created in datatable-base",
"itemtype": "property",
"name": "_parentTableNode",
"access": "private",
"tagname": "",
"type": "{Node}",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 131,
"description": "The THEAD node which resides within the table node created in datatable-base",
"itemtype": "property",
"name": "_parentTheadNode",
"access": "private",
"tagname": "",
"type": "{Node}",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 141,
"description": "The TBODY node which resides within the table node created in datatable-base",
"itemtype": "property",
"name": "_parentTbodyNode",
"access": "private",
"tagname": "",
"type": "{Node}",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 151,
"description": "The TBODY Message node which resides within the table node created in datatable-base",
"itemtype": "property",
"name": "_parentMsgNode",
"access": "private",
"tagname": "",
"type": "{Node}",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 161,
"description": "The contentBox specified for the datatable in datatable-base",
"itemtype": "property",
"name": "_parentContainer",
"access": "private",
"tagname": "",
"type": "{Node}",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 171,
"description": "The DIV node that contains all the scrollable elements (a table with a tbody on it)",
"itemtype": "property",
"name": "_bodyContainerNode",
"access": "private",
"tagname": "",
"type": "{Node}",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 181,
"description": "The DIV node that contains a table with a THEAD in it (which syncs its horizontal scroll with the _bodyContainerNode above)",
"itemtype": "property",
"name": "_headerContainerNode",
"access": "private",
"tagname": "",
"type": "{Node}",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 210,
"description": "Set up methods to fire after host methods execute",
"itemtype": "method",
"name": "_setUpNodes",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 234,
"description": "Stores the main <table> node provided by the host as a private property",
"itemtype": "method",
"name": "_setUpParentTableNode",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 245,
"description": "Stores the main <thead> node provided by the host as a private property",
"itemtype": "method",
"name": "_setUpParentTheadNode",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 255,
"description": "Stores the main <tbody> node provided by the host as a private property",
"itemtype": "method",
"name": "_setUpParentTbodyNode",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 266,
"description": "Stores the main <tbody> message node provided by the host as a private property",
"itemtype": "method",
"name": "_setUpParentMessageNode",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 282,
"description": "Primary rendering method that takes the datatable rendered in\n the host, and splits it up into two separate <divs> each containing two \n separate tables (one containing the head and one containing the body). \n This method fires after renderUI is called on datatable-base.",
"itemtype": "method",
"name": "renderUI",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 299,
"description": "Binds event subscriptions to keep the state and UI in sync",
"itemtype": "method",
"name": "bindUI",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 313,
"description": "Post rendering method that is responsible for creating a column\n filler, and performing width and scroll synchronization between the <th> \n elements and the <td> elements.\n This method fires after syncUI is called on datatable-base",
"itemtype": "method",
"name": "syncUI",
"access": "public",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 332,
"description": "Remove the caption created in base. Scrolling datatables dont support captions.",
"itemtype": "method",
"name": "_removeCaptionNode",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 344,
"description": "Adjusts the width of the TH and the TDs to make sure that the two are in sync\n \n Implementation Details: \n Compares the width of the TH liner div to the the width of the TD node.\n The TD liner width is not actually used because the TD often stretches\n past the liner if the parent DIV is very large. Measuring the TD width\n is more accurate.\n \n Instead of measuring via .get('width'), 'clientWidth' is used, as it\n returns a number, whereas 'width' returns a string, In IE6,\n 'clientWidth' is not supported, so 'offsetWidth' is used. 'offsetWidth'\n is not as accurate on Chrome,FF as 'clientWidth' - thus the need for\n the fork.",
"itemtype": "method",
"name": "_syncWidths",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 448,
"description": "Adds the approriate width to the liner divs of the TH nodes before they are appended to DOM",
"itemtype": "method",
"name": "_attachTheadThNode",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 466,
"description": "Adds the appropriate width to the liner divs of the TD nodes before they are appended to DOM",
"itemtype": "method",
"name": "_attachTbodyTdNode",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 484,
"description": "Creates the body DIV that contains all the data.",
"itemtype": "method",
"name": "_createBodyContainer",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 500,
"description": "Creates the DIV that contains a <table> with all the headers.",
"itemtype": "method",
"name": "_createHeaderContainer",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 520,
"description": "Creates styles for the TBODY based on what type of table it is.",
"itemtype": "method",
"name": "_setStylesForTbody",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 554,
"description": "Creates styles for the THEAD based on what type of datatable it is.",
"itemtype": "method",
"name": "_setStylesForThead",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 569,
"description": "Sets an auto width on the content box if it doesn't exist or if its a y-datatable.",
"itemtype": "method",
"name": "_setContentBoxDimensions",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 589,
"description": "Ensures that scrolling is synced across the two tables",
"itemtype": "method",
"name": "_onScroll",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 599,
"description": "Syncs padding around scrollable tables, including Column header right-padding\n and container width and height.",
"itemtype": "method",
"name": "_syncScroll",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 621,
"description": "Snaps container width for y-scrolling tables.",
"itemtype": "method",
"name": "_syncScrollY",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 643,
"description": "Snaps container height for x-scrolling tables in IE. Syncs message TBODY width. \n Taken from YUI2 ScrollingDataTable.js",
"itemtype": "method",
"name": "_syncScrollX",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 674,
"description": "Adds/removes Column header overhang as necesary.\n Taken from YUI2 ScrollingDataTable.js",
"itemtype": "method",
"name": "_syncScrollOverhang",
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-scroll.js",
"line": 706,
"description": "Sets Column header overhang to given width.\n Taken from YUI2 ScrollingDataTable.js with minor modifications",
"itemtype": "method",
"name": "_setOverhangValue",
"params": [
{
"name": "nBorderWidth",
"description": "Value of new border for overhang.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "DataTableScroll",
"module": "datatable",
"submodule": "datatable-scroll"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 34,
"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"final": 1,
"value": "\"sort\"",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 46,
"description": "Class name.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"final": 1,
"value": "\"dataTableSort\"",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 63,
"itemtype": "attribute",
"name": "trigger",
"description": "Defines the trigger that causes a column to be sorted:\n{event, selector}, where \"event\" is an event type and \"selector\" is\nis a node query selector.",
"type": "Object",
"default": "{event:\"click\", selector:\"th\"}",
"writeonce": "\"initOnly\"",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 77,
"itemtype": "attribute",
"name": "lastSortedBy",
"description": "Describes last known sort state: {key,dir}, where\n\"key\" is column key and \"dir\" is either \"asc\" or \"desc\".",
"type": "Object",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 88,
"itemtype": "attribute",
"name": "template",
"description": "Tokenized markup template for TH sort element.",
"type": "String",
"default": "'
{value}'",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 98,
"description": "Strings used in the UI elements.\n\nThe strings used are defaulted from the datatable-sort language pack\nfor the language identified in the YUI \"lang\" configuration (which\ndefaults to \"en\").\n\nConfigurable strings are \"sortBy\" and \"reverseSortBy\", which are\nassigned to the sort link's title attribute.",
"itemtype": "attribute",
"name": "strings",
"type": "{Object}",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 129,
"description": "Initializer.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Config object.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 174,
"itemtype": "method",
"name": "_setLastSortedBy",
"description": "Normalizes lastSortedBy",
"params": [
{
"name": "val",
"description": "{key, dir} or \"key\"",
"type": "String | Object"
}
],
"return": {
"description": "",
"type": "Key, dir, notdir"
},
"access": "private",
"tagname": "",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 195,
"description": "Updates sort UI.",
"itemtype": "method",
"name": "_uiSetLastSortedBy",
"params": [
{
"name": "val",
"description": "New lastSortedBy object {key,dir}.",
"type": "Object"
},
{
"name": "dt",
"description": "Host.",
"type": "Y.DataTable.Base"
}
],
"access": "protected",
"tagname": "",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 252,
"description": "Before header cell element is created, inserts link markup around {value}.",
"itemtype": "method",
"name": "_beforeCreateTheadThNode",
"params": [
{
"name": "o",
"description": "{value, column, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 280,
"description": "Before header cell element is attached, sets applicable class names.",
"itemtype": "method",
"name": "_beforeAttachTheadThNode",
"params": [
{
"name": "o",
"description": "{value, column, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 303,
"description": "Before header cell element is attached, sets applicable class names.",
"itemtype": "method",
"name": "_beforeAttachTbodyTdNode",
"params": [
{
"name": "o",
"description": "{record, column, tr, headers, classnames, value}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatable/js/datatable-sort.js",
"line": 325,
"description": "In response to the \"trigger\" event, sorts the underlying Recordset and\nupdates the lastSortedBy attribute.",
"itemtype": "method",
"name": "_onEventSortColumn",
"params": [
{
"name": "o",
"description": "{value, column, tr}.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "DataTableSort",
"module": "datatable",
"submodule": "datatable-sort"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-format.js",
"line": 33,
"description": "Pad a number with leading spaces, zeroes or something else",
"itemtype": "method",
"name": "xPad",
"params": [
{
"name": "x",
"description": "The number to be padded",
"type": "Number"
},
{
"name": "pad",
"description": "The character to pad the number with",
"type": "String"
},
{
"name": "r",
"description": "(optional) The base of the pad, eg, 10 implies to two digits, 100 implies to 3 digits.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-format"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-format.js",
"line": 161,
"description": "Takes a native JavaScript Date and formats it as a string for display to user.",
"itemtype": "method",
"name": "format",
"params": [
{
"name": "oDate",
"description": "Date.",
"type": "Date"
},
{
"name": "oConfig",
"description": "(Optional) Object literal of configuration values:\n
\n - format {HTML} (Optional)
\n - \n
\n Any strftime string is supported, such as \"%I:%M:%S %p\". strftime has several format specifiers defined by the Open group at \n http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html\n PHP added a few of its own, defined at http://www.php.net/strftime\n
\n \n This javascript implementation supports all the PHP specifiers and a few more. The full list is below.\n
\n \n If not specified, it defaults to the ISO 8601 standard date format: %Y-%m-%d.\n This may be overridden by the deprecated Y.config.dateFormat property.\n
\n \n\t- %a
- abbreviated weekday name according to the current locale
\n\t- %A
- full weekday name according to the current locale
\n\t- %b
- abbreviated month name according to the current locale
\n\t- %B
- full month name according to the current locale
\n\t- %c
- preferred date and time representation for the current locale
\n\t- %C
- century number (the year divided by 100 and truncated to an integer, range 00 to 99)
\n\t- %d
- day of the month as a decimal number (range 01 to 31)
\n\t- %D
- same as %m/%d/%y
\n\t- %e
- day of the month as a decimal number, a single digit is preceded by a space (range \" 1\" to \"31\")
\n\t- %F
- same as %Y-%m-%d (ISO 8601 date format)
\n\t- %g
- like %G, but without the century
\n\t- %G
- The 4-digit year corresponding to the ISO week number
\n\t- %h
- same as %b
\n\t- %H
- hour as a decimal number using a 24-hour clock (range 00 to 23)
\n\t- %I
- hour as a decimal number using a 12-hour clock (range 01 to 12)
\n\t- %j
- day of the year as a decimal number (range 001 to 366)
\n\t- %k
- hour as a decimal number using a 24-hour clock (range 0 to 23); single digits are preceded by a blank. (See also %H.)
\n\t- %l
- hour as a decimal number using a 12-hour clock (range 1 to 12); single digits are preceded by a blank. (See also %I.)
\n\t- %m
- month as a decimal number (range 01 to 12)
\n\t- %M
- minute as a decimal number
\n\t- %n
- newline character
\n\t- %p
- either \"AM\" or \"PM\" according to the given time value, or the corresponding strings for the current locale
\n\t- %P
- like %p, but lower case
\n\t- %r
- time in a.m. and p.m. notation equal to %I:%M:%S %p
\n\t- %R
- time in 24 hour notation equal to %H:%M
\n\t- %s
- number of seconds since the Epoch, ie, since 1970-01-01 00:00:00 UTC
\n\t- %S
- second as a decimal number
\n\t- %t
- tab character
\n\t- %T
- current time, equal to %H:%M:%S
\n\t- %u
- weekday as a decimal number [1,7], with 1 representing Monday
\n\t- %U
- week number of the current year as a decimal number, starting with the\n\t\t\tfirst Sunday as the first day of the first week
\n\t- %V
- The ISO 8601:1988 week number of the current year as a decimal number,\n\t\t\trange 01 to 53, where week 1 is the first week that has at least 4 days\n\t\t\tin the current year, and with Monday as the first day of the week.
\n\t- %w
- day of the week as a decimal, Sunday being 0
\n\t- %W
- week number of the current year as a decimal number, starting with the\n\t\t\tfirst Monday as the first day of the first week
\n\t- %x
- preferred date representation for the current locale without the time
\n\t- %X
- preferred time representation for the current locale without the date
\n\t- %y
- year as a decimal number without a century (range 00 to 99)
\n\t- %Y
- year as a decimal number including the century
\n\t- %z
- numerical time zone representation
\n\t- %Z
- time zone name or abbreviation
\n\t- %%
- a literal \"%\" character
\n
\n \n - locale {String} (Deprecated, optional)
\n - \n Deprecated - use Y.config.lang instead, which provides access to a much larger set of built-in languages.\n The locale to use when displaying days of week, months of the year, and other locale specific\n strings. If not specified, this defaults to \"en\" (though this may be overridden by the deprecated Y.config.locale).\n The following locales are built in:\n
\n - en
\n - English
\n - en-US
\n - US English
\n - en-GB
\n - British English
\n - en-AU
\n - Australian English (identical to British English)
\n
\n More locales may be added by subclassing of the deprecated Y.DataType.Date.Locale[\"en\"].\n See Y.DataType.Date.Locale for more information.\n \n
",
"type": "Object"
}
],
"return": {
"description": "Formatted date for display.",
"type": "HTML"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-format"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-math.js",
"line": 12,
"description": "Checks whether a native JavaScript Date contains a valid value.",
"itemtype": "method",
"name": "isValidDate",
"params": [
{
"name": "oDate",
"description": "Date in the month for which the number of days is desired.",
"type": "Date"
}
],
"return": {
"description": "True if the date argument contains a valid value.",
"type": "Boolean"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-math"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-math.js",
"line": 29,
"description": "Checks whether two dates correspond to the same date and time.",
"itemtype": "method",
"name": "areEqual",
"params": [
{
"name": "aDate",
"description": "The first date to compare.",
"type": "Date"
},
{
"name": "bDate",
"description": "The second date to compare.",
"type": "Date"
}
],
"return": {
"description": "True if the two dates correspond to the same\ndate and time.",
"type": "Boolean"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-math"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-math.js",
"line": 42,
"description": "Checks whether the first date comes later than the second.",
"itemtype": "method",
"name": "isGreater",
"params": [
{
"name": "aDate",
"description": "The first date to compare.",
"type": "Date"
},
{
"name": "bDate",
"description": "The second date to compare.",
"type": "Date"
}
],
"return": {
"description": "True if the first date is later than the second.",
"type": "Boolean"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-math"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-math.js",
"line": 54,
"description": "Checks whether the first date comes later than or is the same as\nthe second.",
"itemtype": "method",
"name": "isGreaterOrEqual",
"params": [
{
"name": "aDate",
"description": "The first date to compare.",
"type": "Date"
},
{
"name": "bDate",
"description": "The second date to compare.",
"type": "Date"
}
],
"return": {
"description": "True if the first date is later than or \nthe same as the second.",
"type": "Boolean"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-math"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-math.js",
"line": 68,
"description": "Adds a specified number of months to the given date.",
"itemtype": "method",
"name": "addMonths",
"params": [
{
"name": "oDate",
"description": "The date to add months to.",
"type": "Date"
},
{
"name": "numMonths",
"description": "The number of months to add (can be negative)",
"type": "Number"
}
],
"return": {
"description": "A new Date with the specified number of months\nadded to the original date.",
"type": "Date"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-math"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-math.js",
"line": 91,
"description": "Adds a specified number of years to the given date.",
"itemtype": "method",
"name": "addYears",
"params": [
{
"name": "oDate",
"description": "The date to add years to.",
"type": "Date"
},
{
"name": "numYears",
"description": "The number of years to add (can be negative)",
"type": "Number"
}
],
"return": {
"description": "A new Date with the specified number of years\nadded to the original date.",
"type": "Date"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-math"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-math.js",
"line": 108,
"description": "Lists all dates in a given month.",
"itemtype": "method",
"name": "listOfDatesInMonth",
"params": [
{
"name": "oDate",
"description": "The date corresponding to the month for\nwhich a list of dates is required.",
"type": "Date"
}
],
"return": {
"description": "An `Array` of `Date`s from a given month.",
"type": "Array"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-math"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-math.js",
"line": 133,
"description": "Takes a native JavaScript Date and returns the number of days\nin the month that the given date belongs to.",
"itemtype": "method",
"name": "daysInMonth",
"params": [
{
"name": "oDate",
"description": "Date in the month for which the number \nof days is desired.",
"type": "Date"
}
],
"return": {
"description": "A number (either 28, 29, 30 or 31) of days \nin the given month.",
"type": "Number"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-math"
},
{
"file": "lib/yui3/src/datatype/js/datatype-date-parse.js",
"line": 11,
"description": "Converts data to type Date.",
"itemtype": "method",
"name": "parse",
"params": [
{
"name": "data",
"description": "Data to convert. Values supported by the Date constructor are supported.",
"type": "String | Number"
}
],
"return": {
"description": "A Date, or null.",
"type": "Date"
},
"class": "DataType.Date",
"module": "datatype",
"submodule": "datatype-date-parse"
},
{
"file": "lib/yui3/src/datatype/js/datatype-number-format.js",
"line": 24,
"description": "Takes a Number and formats to string for display to user.",
"itemtype": "method",
"name": "format",
"params": [
{
"name": "data",
"description": "Number.",
"type": "Number"
},
{
"name": "config",
"description": "(Optional) Optional configuration values:\n
\n - prefix {HTML}\n
- String prepended before each number, like a currency designator \"$\"
\n - decimalPlaces {Number}\n
- Number of decimal places to round. Must be a number 0 to 20.
\n - decimalSeparator {HTML}\n
- Decimal separator
\n - thousandsSeparator {HTML}\n
- Thousands separator
\n - suffix {HTML}\n
- String appended after each number, like \" items\" (note the space)
\n
",
"type": "Object"
}
],
"return": {
"description": "Formatted number for display. Note, the following values\nreturn as \"\": null, undefined, NaN, \"\".",
"type": "HTML"
},
"class": "DataType.Number",
"module": "datatype",
"submodule": "datatype-number-format"
},
{
"file": "lib/yui3/src/datatype/js/datatype-number-parse.js",
"line": 12,
"description": "Converts data to type Number.",
"itemtype": "method",
"name": "parse",
"params": [
{
"name": "data",
"description": "Data to convert. The following\nvalues return as null: null, undefined, NaN, \"\".",
"type": "String | Number | Boolean"
}
],
"return": {
"description": "A number, or null.",
"type": "Number"
},
"class": "DataType.Number",
"module": "datatype",
"submodule": "datatype-number-parse"
},
{
"file": "lib/yui3/src/datatype/js/datatype-xml-format.js",
"line": 24,
"description": "Converts data to type XMLDocument.",
"itemtype": "method",
"name": "format",
"params": [
{
"name": "data",
"description": "Data to convert.",
"type": "XMLDoc"
}
],
"return": {
"description": "String.",
"type": "String"
},
"class": "DataType.XML",
"module": "datatype",
"submodule": "datatype-xml"
},
{
"file": "lib/yui3/src/datatype/js/datatype-xml-parse.js",
"line": 12,
"description": "Converts data to type XMLDocument.",
"itemtype": "method",
"name": "parse",
"params": [
{
"name": "data",
"description": "Data to convert.",
"type": "String"
}
],
"return": {
"description": "XML Document.",
"type": "XMLDoc"
},
"class": "DataType.XML",
"module": "datatype",
"submodule": "datatype-xml-parse"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 30,
"itemtype": "event",
"name": "drag:tickAlignX",
"description": "Fires when this node is aligned with the tickX value.",
"params": [
{
"name": "event",
"description": "An Event Facade object",
"type": "EventFacade"
}
],
"type": "{CustomEvent}",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 38,
"itemtype": "event",
"name": "drag:tickAlignY",
"description": "Fires when this node is aligned with the tickY value.",
"params": [
{
"name": "event",
"description": "An Event Facade object",
"type": "EventFacade"
}
],
"type": "{CustomEvent}",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 52,
"itemtype": "property",
"name": "NS",
"default": "con",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"description": "The Constrained instance will be placed on the Drag instance under the con namespace.",
"type": "{String}",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 66,
"itemtype": "attribute",
"name": "stickX",
"description": "Stick the drag movement to the X-Axis. Default: false",
"type": "Boolean",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 74,
"itemtype": "attribute",
"name": "stickY",
"description": "Stick the drag movement to the Y-Axis",
"type": "Boolean",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 82,
"itemtype": "attribute",
"name": "tickX",
"description": "The X tick offset the drag node should snap to on each drag move. False for no ticks. Default: false",
"type": "Number/false",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 90,
"itemtype": "attribute",
"name": "tickY",
"description": "The Y tick offset the drag node should snap to on each drag move. False for no ticks. Default: false",
"type": "Number/false",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 98,
"itemtype": "attribute",
"name": "tickXArray",
"description": "An array of page coordinates to use as X ticks for drag movement.",
"type": "Array",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 106,
"itemtype": "attribute",
"name": "tickYArray",
"description": "An array of page coordinates to use as Y ticks for drag movement.",
"type": "Array",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 114,
"itemtype": "attribute",
"name": "gutter",
"description": "CSS style string for the gutter of a region (supports negative values): '5 0' (sets top and bottom to 5px, left and right to 0px), '1 2 3 4' (top 1px, right 2px, bottom 3px, left 4px)",
"type": "String",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 125,
"itemtype": "attribute",
"name": "constrain",
"description": "Will attempt to constrain the drag node to the boundaries. Arguments:
\n'view': Contrain to Viewport
\n'#selector_string': Constrain to this node
\n'{Region Object}': An Object Literal containing a valid region (top, right, bottom, left) of page positions",
"type": "{String/Object/Node}",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 143,
"deprecated": true,
"itemtype": "attribute",
"name": "constrain2region",
"description": "An Object Literal containing a valid region (top, right, bottom, left) of page positions to constrain the drag node to.",
"type": "Object",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 154,
"deprecated": true,
"itemtype": "attribute",
"name": "constrain2node",
"description": "Will attempt to constrain the drag node to the boundaries of this node.",
"type": "Object",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 165,
"deprecated": true,
"itemtype": "attribute",
"name": "constrain2view",
"description": "Will attempt to constrain the drag node to the boundaries of the viewport region.",
"type": "Object",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 176,
"itemtype": "attribute",
"name": "cacheRegion",
"description": "Should the region be cached for performace. Default: true",
"type": "Boolean",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 198,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_createEvents",
"description": "This method creates all the events for this Event Target and publishes them so we get Event Bubbling.",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 221,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleEnd",
"description": "Fires on drag:end",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 230,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleStart",
"description": "Fires on drag:start and clears the _regionCache",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 238,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_regionCache",
"description": "Store a cache of the region that we are constraining to",
"type": "Object",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 245,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_cacheRegion",
"description": "Get's the region and caches it, called from window.resize and when the cache is null",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 253,
"itemtype": "method",
"name": "resetCache",
"description": "Reset the internal region cache.",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 260,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getConstraint",
"description": "Standardizes the 'constraint' attribute",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 301,
"itemtype": "method",
"name": "getRegion",
"description": "Get the active region: viewport, node, custom region",
"params": [
{
"name": "inc",
"description": "Include the node's height and width",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 321,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_checkRegion",
"description": "Check if xy is inside a given region, if not change to it be inside.",
"params": [
{
"name": "_xy",
"description": "The XY to check if it's in the current region, if it isn't inside the region, it will reset the xy array to be inside the region.",
"type": "Array"
}
],
"return": {
"description": "The new XY that is inside the region",
"type": "Array"
},
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 351,
"itemtype": "method",
"name": "inRegion",
"description": "Checks if the XY passed or the dragNode is inside the active region.",
"params": [
{
"name": "xy",
"description": "Optional XY to check, if not supplied this.get('dragNode').getXY() is used.",
"type": "Array"
}
],
"return": {
"description": "True if the XY is inside the region, false otherwise.",
"type": "Boolean"
},
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 367,
"itemtype": "method",
"name": "align",
"description": "Modifies the Drag.actXY method from the after drag:align event. This is where the constraining happens.",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 391,
"itemtype": "method",
"name": "drag",
"description": "Fires after drag:drag. Handle the tickX and tickX align events.",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 411,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_checkTicks",
"description": "This method delegates the proper helper method for tick calculations",
"params": [
{
"name": "xy",
"description": "The XY coords for the Drag",
"type": "Array"
},
{
"name": "r",
"description": "The optional region that we are bound to.",
"type": "Object"
}
],
"return": {
"description": "The calced XY coords",
"type": "Array"
},
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 440,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_tickAlignX",
"description": "Fires when the actXY[0] reach a new value respecting the tickX gap.",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 448,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_tickAlignY",
"description": "Fires when the actXY[1] reach a new value respecting the tickY gap.",
"class": "Plugin.DDConstrained",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 463,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_calcTicks",
"description": "Helper method to calculate the tick offsets for a given position",
"params": [
{
"name": "pos",
"description": "The current X or Y position",
"type": "Number"
},
{
"name": "start",
"description": "The start X or Y position",
"type": "Number"
},
{
"name": "tick",
"description": "The X or Y tick increment",
"type": "Number"
},
{
"name": "off1",
"description": "The min offset that we can't pass (region)",
"type": "Number"
},
{
"name": "off2",
"description": "The max offset that we can't pass (region)",
"type": "Number"
}
],
"return": {
"description": "The new position based on the tick calculation",
"type": "Number"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/constrain.js",
"line": 495,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_calcTickArray",
"description": "This method is used with the tickXArray and tickYArray config options",
"params": [
{
"name": "pos",
"description": "The current X or Y position",
"type": "Number"
},
{
"name": "ticks",
"description": "The array containing our custom tick positions.",
"type": "Number"
},
{
"name": "off1",
"description": "The min offset that we can't pass (region)",
"type": "Number"
},
{
"name": "off2",
"description": "The max offset that we can't pass (region)",
"type": "Number"
}
],
"return": {
"description": "The tick position"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-constrain",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/dd-drop-plugin.js",
"line": 21,
"itemtype": "property",
"name": "NAME",
"description": "dd-drop-plugin",
"type": "{String}",
"class": "Plugin.Drop",
"module": "dd",
"submodule": "dd-drop-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-drop-plugin.js",
"line": 27,
"itemtype": "property",
"name": "NS",
"description": "The Drop instance will be placed on the Node instance under the drop namespace. It can be accessed via Node.drop;",
"type": "{String}",
"class": "Plugin.Drop",
"module": "dd",
"submodule": "dd-drop-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-plugin.js",
"line": 30,
"itemtype": "property",
"name": "NAME",
"description": "dd-plugin",
"type": "{String}",
"class": "Plugin.Drag",
"module": "dd",
"submodule": "dd-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-plugin.js",
"line": 37,
"itemtype": "property",
"name": "NS",
"description": "The Drag instance will be placed on the Node instance under the dd namespace. It can be accessed via Node.dd;",
"type": "{String}",
"class": "Plugin.Drag",
"module": "dd",
"submodule": "dd-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-plugin.js",
"line": 47,
"description": "refers to a Y.Widget if its the host, otherwise = false.",
"itemtype": "attribute",
"name": "_widget",
"access": "private",
"tagname": "",
"class": "Plugin.Drag",
"module": "dd",
"submodule": "dd-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-plugin.js",
"line": 56,
"description": "refers to the [x,y] coordinate where the drag was stopped last",
"itemtype": "attribute",
"name": "_stoppedPosition",
"access": "private",
"tagname": "",
"class": "Plugin.Drag",
"module": "dd",
"submodule": "dd-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-plugin.js",
"line": 65,
"description": "Returns true if widget uses widgetPosition, otherwise returns false",
"itemtype": "method",
"name": "_usesWidgetPosition",
"access": "private",
"tagname": "",
"class": "Plugin.Drag",
"module": "dd",
"submodule": "dd-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-plugin.js",
"line": 80,
"description": "Sets up event listeners on drag events if interacting with a widget",
"itemtype": "method",
"name": "initializer",
"access": "protected",
"tagname": "",
"class": "Plugin.Drag",
"module": "dd",
"submodule": "dd-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-plugin.js",
"line": 104,
"description": "Updates x,y or xy attributes on widget based on where the widget is dragged",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "e",
"description": "Event Facade",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Drag",
"module": "dd",
"submodule": "dd-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/dd-plugin.js",
"line": 136,
"description": "Updates the last position where the widget was stopped.",
"itemtype": "method",
"name": "updateStopPosition",
"params": [
{
"name": "e",
"description": "Event Facade",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Drag",
"module": "dd",
"submodule": "dd-plugin",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 22,
"itemtype": "attribute",
"name": "dragCursor",
"description": "The cursor to apply when dragging, if shimmed the shim will get the cursor.",
"type": "String",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 30,
"itemtype": "attribute",
"name": "clickPixelThresh",
"description": "The number of pixels to move to start a drag operation, default is 3.",
"type": "Number",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 38,
"itemtype": "attribute",
"name": "clickTimeThresh",
"description": "The number of milliseconds a mousedown has to pass to start a drag operation, default is 1000.",
"type": "Number",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 46,
"itemtype": "attribute",
"name": "throttleTime",
"description": "The number of milliseconds to throttle the mousemove event. Default: 150",
"type": "Number",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 55,
"itemtype": "attribute",
"name": "dragMode",
"description": "This attribute only works if the dd-drop module is active. It will set the dragMode (point, intersect, strict) of all future Drag instances.",
"type": "String",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 72,
"itemtype": "property",
"name": "_active",
"description": "flag set when we activate our first drag, so DDM can start listening for events.",
"type": "{Boolean}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 78,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setDragMode",
"description": "Handler for dragMode attribute setter.",
"params": [
{
"name": "String/Number",
"description": "The Number value or the String for the DragMode to default all future drag instances to."
}
],
"return": {
"description": "Number The Mode to be set"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 102,
"itemtype": "property",
"name": "CSS_PREFIX",
"description": "The PREFIX to attach to all DD CSS class names",
"type": "{String}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 109,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_drags",
"description": "Holder for all registered drag elements.",
"type": "{Array}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 116,
"itemtype": "property",
"name": "activeDrag",
"description": "A reference to the currently active draggable object.",
"type": "{Drag}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 122,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_regDrag",
"description": "Adds a reference to the drag object to the DDM._drags array, called in the constructor of Drag.",
"params": [
{
"name": "d",
"description": "The Drag object",
"type": "Drag"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 139,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_unregDrag",
"description": "Remove this drag object from the DDM._drags array.",
"params": [
{
"name": "d",
"description": "The drag object.",
"type": "Drag"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 154,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setupListeners",
"description": "Add the document listeners.",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 167,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_start",
"description": "Internal method used by Drag to signal the start of a drag operation",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 176,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_startDrag",
"description": "Factory method to be overwritten by other DDM's",
"params": [
{
"name": "x",
"description": "The x position of the drag element",
"type": "Number"
},
{
"name": "y",
"description": "The y position of the drag element",
"type": "Number"
},
{
"name": "w",
"description": "The width of the drag element",
"type": "Number"
},
{
"name": "h",
"description": "The height of the drag element",
"type": "Number"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 186,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_endDrag",
"description": "Factory method to be overwritten by other DDM's",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 193,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_end",
"description": "Internal method used by Drag to signal the end of a drag operation",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 206,
"itemtype": "method",
"name": "stopDrag",
"description": "Method will forcefully stop a drag operation. For example calling this from inside an ESC keypress handler will stop this drag.",
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 218,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_move",
"description": "Internal listener for the mousemove DOM event to pass to the Drag's move method.",
"params": [
{
"name": "ev",
"description": "The Dom mousemove Event",
"type": "Event.Facade"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 230,
"description": "Helper method to use to set the gutter from the attribute setter.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "cssSizestoObject",
"params": [
{
"name": "gutter",
"description": "CSS style string for gutter: '5 0' (sets top and bottom to 5px, left and right to 0px), '1 2 3 4' (top 1px, right 2px, bottom 3px, left 4px)",
"type": "String"
}
],
"return": {
"description": "The gutter Object Literal.",
"type": "Object"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 254,
"itemtype": "method",
"name": "getDrag",
"description": "Get a valid Drag instance back from a Node or a selector string, false otherwise",
"params": [
{
"name": "node",
"description": "The Node instance or Selector string to check for a valid Drag Object",
"type": "String/Object"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 272,
"itemtype": "method",
"name": "swapPosition",
"description": "Swap the position of 2 nodes based on their CSS positioning.",
"params": [
{
"name": "n1",
"description": "The first node to swap",
"type": "Node"
},
{
"name": "n2",
"description": "The first node to swap",
"type": "Node"
}
],
"return": {
"description": "",
"type": "Node"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 289,
"itemtype": "method",
"name": "getNode",
"description": "Return a node instance from the given node, selector string or Y.Base extended object.",
"params": [
{
"name": "n",
"description": "The node to resolve.",
"type": "Node/Object/String"
}
],
"return": {
"description": "",
"type": "Node"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 307,
"itemtype": "method",
"name": "swapNode",
"description": "Swap the position of 2 nodes based on their DOM location.",
"params": [
{
"name": "n1",
"description": "The first node to swap",
"type": "Node"
},
{
"name": "n2",
"description": "The first node to swap",
"type": "Node"
}
],
"return": {
"description": "",
"type": "Node"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 335,
"itemtype": "event",
"name": "ddm:start",
"description": "Fires from the DDM before all drag events fire.",
"type": "{CustomEvent}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-base.js",
"line": 340,
"itemtype": "event",
"name": "ddm:end",
"description": "Fires from the DDM after the DDM finishes, before the drag end events.",
"type": "{CustomEvent}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-base",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 12,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_noShim",
"description": "This flag turns off the use of the mouseover/mouseout shim. It should not be used unless you know what you are doing.",
"type": "{Boolean}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 19,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_activeShims",
"description": "Placeholder for all active shims on the page",
"type": "{Array}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 26,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_hasActiveShim",
"description": "This method checks the _activeShims Object to see if there is a shim active.",
"return": {
"description": "",
"type": "Boolean"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 38,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_addActiveShim",
"description": "Adds a Drop Target to the list of active shims",
"params": [
{
"name": "d",
"description": "The Drop instance to add to the list.",
"type": "Object"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 47,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_removeActiveShim",
"description": "Removes a Drop Target to the list of active shims",
"params": [
{
"name": "d",
"description": "The Drop instance to remove from the list.",
"type": "Object"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 63,
"itemtype": "method",
"name": "syncActiveShims",
"description": "This method will sync the position of the shims on the Drop Targets that are currently active.",
"params": [
{
"name": "force",
"description": "Resize/sync all Targets.",
"type": "Boolean"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 76,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "mode",
"description": "The mode that the drag operations will run in 0 for Point, 1 for Intersect, 2 for Strict",
"type": "Number",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 83,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "POINT",
"description": "In point mode, a Drop is targeted by the cursor being over the Target",
"type": "Number",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 90,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "INTERSECT",
"description": "In intersect mode, a Drop is targeted by \"part\" of the drag node being over the Target",
"type": "Number",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 97,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "STRICT",
"description": "In strict mode, a Drop is targeted by the \"entire\" drag node being over the Target",
"type": "Number",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 104,
"itemtype": "property",
"name": "useHash",
"description": "Should we only check targets that are in the viewport on drags (for performance), default: true",
"type": "{Boolean}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 110,
"itemtype": "property",
"name": "activeDrop",
"description": "A reference to the active Drop Target",
"type": "{Object}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 116,
"itemtype": "property",
"name": "validDrops",
"description": "An array of the valid Drop Targets for this interaction.",
"type": "{Array}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 123,
"itemtype": "property",
"name": "otherDrops",
"description": "An object literal of Other Drop Targets that we encountered during this interaction (in the case of overlapping Drop Targets)",
"type": "{Object}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 129,
"itemtype": "property",
"name": "targets",
"description": "All of the Targets",
"type": "{Array}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 135,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_addValid",
"description": "Add a Drop Target to the list of Valid Targets. This list get's regenerated on each new drag operation.",
"params": [
{
"name": "drop",
"description": "",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 147,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_removeValid",
"description": "Removes a Drop Target from the list of Valid Targets. This list get's regenerated on each new drag operation.",
"params": [
{
"name": "drop",
"description": "",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 166,
"itemtype": "method",
"name": "isOverTarget",
"description": "Check to see if the Drag element is over the target, method varies on current mode",
"params": [
{
"name": "drop",
"description": "The drop to check against",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 207,
"itemtype": "method",
"name": "clearCache",
"description": "Clears the cache data used for this interaction.",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 216,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_activateTargets",
"description": "Clear the cache and activate the shims of all the targets",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 233,
"itemtype": "method",
"name": "getBestMatch",
"description": "This method will gather the area for all potential targets and see which has the hightest covered area and return it.",
"params": [
{
"name": "drops",
"description": "An Array of drops to scan for the best match.",
"type": "Array"
},
{
"name": "all",
"description": "If present, it returns an Array. First item is best match, second is an Array of the other items in the original Array.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Object or Array"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 267,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_deactivateTargets",
"description": "This method fires the drop:hit, drag:drophit, drag:dropmiss methods and deactivates the shims..",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 305,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_dropMove",
"description": "This method is called when the move method is called on the Drag Object.",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 319,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_lookup",
"description": "Filters the list of Drops down to those in the viewport.",
"return": {
"description": "The valid Drop Targets that are in the viewport.",
"type": "Array"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 339,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleTargetOver",
"description": "This method execs _handleTargetOver on all valid Drop Targets",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 350,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_regTarget",
"description": "Add the passed in Target to the targets collection",
"params": [
{
"name": "t",
"description": "The Target to add to the targets collection",
"type": "Object"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 359,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_unregTarget",
"description": "Remove the passed in Target from the targets collection",
"params": [
{
"name": "drop",
"description": "The Target to remove from the targets collection",
"type": "Object"
}
],
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm-drop.js",
"line": 383,
"itemtype": "method",
"name": "getDrop",
"description": "Get a valid Drop instance back from a Node or a selector string, false otherwise",
"params": [
{
"name": "node",
"description": "The Node instance or Selector string to check for a valid Drop Object",
"type": "String/Object"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm.js",
"line": 11,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_pg",
"description": "The shim placed over the screen to track the mousemove event.",
"type": "{Node}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm.js",
"line": 18,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_debugShim",
"description": "Set this to true to set the shims opacity to .5 for debugging it, default: false.",
"type": "{Boolean}",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm.js",
"line": 37,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_pg_deactivate",
"description": "Deactivates the shim",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm.js",
"line": 45,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_pg_activate",
"description": "Activates the shim",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm.js",
"line": 68,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_pg_size",
"description": "Sizes the shim on: activatation, window:scroll, window:resize",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/ddm.js",
"line": 84,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_createPG",
"description": "Creates the shim and adds it's listeners to it.",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-ddm",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 25,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_bubbleTargets",
"description": "The default bubbleTarget for this object. Default: Y.DD.DDM",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 31,
"itemtype": "property",
"name": "dd",
"description": "A reference to the temporary dd instance used under the hood.",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 36,
"itemtype": "property",
"name": "_shimState",
"access": "private",
"tagname": "",
"description": "The state of the Y.DD.DDM._noShim property to it can be reset.",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 42,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_handles",
"description": "Array of event handles to be destroyed",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 48,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onNodeChange",
"description": "Listens to the nodeChange event and sets the dragNode on the temp dd instance.",
"params": [
{
"name": "e",
"description": "The Event.",
"type": "Event"
}
],
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 57,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_afterDragEnd",
"description": "Listens for the drag:end event and updates the temp dd instance.",
"params": [
{
"name": "e",
"description": "The Event.",
"type": "Event"
}
],
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 71,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_delMouseDown",
"description": "The callback for the Y.DD.Delegate instance used",
"params": [
{
"name": "e",
"description": "The MouseDown Event.",
"type": "Event"
}
],
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 96,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onMouseEnter",
"description": "Sets the target shim state",
"params": [
{
"name": "e",
"description": "The MouseEnter Event",
"type": "Event"
}
],
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 106,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onMouseLeave",
"description": "Resets the target shim state",
"params": [
{
"name": "e",
"description": "The MouseLeave Event",
"type": "Event"
}
],
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 148,
"itemtype": "method",
"name": "syncTargets",
"description": "Applies the Y.Plugin.Drop to all nodes matching the cont + nodes selector query.",
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 175,
"itemtype": "method",
"name": "createDrop",
"description": "Apply the Drop plugin to this node",
"params": [
{
"name": "node",
"description": "The Node to apply the plugin to",
"type": "Node"
},
{
"name": "groups",
"description": "The default groups to assign this target to.",
"type": "Array"
}
],
"return": {
"description": "Node"
},
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 209,
"itemtype": "attribute",
"name": "container",
"description": "A selector query to get the container to listen for mousedown events on. All \"nodes\" should be a child of this container.",
"type": "String",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 217,
"itemtype": "attribute",
"name": "nodes",
"description": "A selector query to get the children of the \"container\" to make draggable elements from.",
"type": "String",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 225,
"itemtype": "attribute",
"name": "invalid",
"description": "A selector query to test a node to see if it's an invalid item.",
"type": "String",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 233,
"itemtype": "attribute",
"name": "lastNode",
"description": "Y.Node instance of the last item dragged.",
"type": "Node",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 241,
"itemtype": "attribute",
"name": "currentNode",
"description": "Y.Node instance of the dd node.",
"type": "Node",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 249,
"itemtype": "attribute",
"name": "dragNode",
"description": "Y.Node instance of the dd dragNode.",
"type": "Node",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 257,
"itemtype": "attribute",
"name": "over",
"description": "Is the mouse currently over the container",
"type": "Boolean",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 265,
"itemtype": "attribute",
"name": "target",
"description": "Should the items also be a drop target.",
"type": "Boolean",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 273,
"itemtype": "attribute",
"name": "dragConfig",
"description": "The default config to be used when creating the DD instance.",
"type": "Object",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 281,
"itemtype": "attribute",
"name": "handles",
"description": "The handles config option added to the temp DD instance.",
"type": "Array",
"class": "DD.Delegate",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 293,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_delegates",
"description": "Holder for all Y.DD.Delegate instances",
"type": "Array",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 301,
"itemtype": "method",
"name": "regDelegate",
"description": "Register a Delegate with the DDM",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/delegate.js",
"line": 309,
"itemtype": "method",
"name": "getDelegate",
"description": "Get a delegate instance from a container node",
"return": {
"description": "Y.DD.Delegate"
},
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-delegate",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 21,
"itemtype": "event",
"name": "drag:mouseup",
"description": "Handles the mouseup DOM event, does nothing internally just fires.",
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 27,
"itemtype": "event",
"name": "drag:mouseDown",
"description": "Handles the mousedown DOM event, checks to see if you have a valid handle then starts the drag timers.",
"preventable": "_defMouseDownFn",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
- ev
- The original mousedown event.
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 37,
"itemtype": "event",
"name": "drag:afterMouseDown",
"description": "Fires after the mousedown event has been cleared.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
- ev
- The original mousedown event.
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 46,
"itemtype": "event",
"name": "drag:removeHandle",
"description": "Fires after a handle is removed.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
- handle
- The handle that was removed.
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 55,
"itemtype": "event",
"name": "drag:addHandle",
"description": "Fires after a handle is added.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
- handle
- The handle that was added.
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 64,
"itemtype": "event",
"name": "drag:removeInvalid",
"description": "Fires after an invalid selector is removed.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
- handle
- The handle that was removed.
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 73,
"itemtype": "event",
"name": "drag:addInvalid",
"description": "Fires after an invalid selector is added.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
- handle
- The handle that was added.
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 82,
"itemtype": "event",
"name": "drag:start",
"description": "Fires at the start of a drag operation.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- pageX
- The original node position X.
\n- pageY
- The original node position Y.
\n- startTime
- The startTime of the event. getTime on the current Date object.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 95,
"itemtype": "event",
"name": "drag:end",
"description": "Fires at the end of a drag operation.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- pageX
- The current node position X.
\n- pageY
- The current node position Y.
\n- startTime
- The startTime of the event, from the start event.
\n- endTime
- The endTime of the event. getTime on the current Date object.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 109,
"itemtype": "event",
"name": "drag:drag",
"description": "Fires every mousemove during a drag operation.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- pageX
- The current node position X.
\n- pageY
- The current node position Y.
\n- scroll
- Should a scroll action occur.
\n- info
- Object hash containing calculated XY arrays: start, xy, delta, offset
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 123,
"itemtype": "event",
"name": "drag:align",
"preventable": "_defAlignFn",
"description": "Fires when this node is aligned.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- pageX
- The current node position X.
\n- pageY
- The current node position Y.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 136,
"itemtype": "event",
"name": "drag:over",
"description": "Fires when this node is over a Drop Target. (Fired from dd-drop)",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- drop
- The drop object at the time of the event.
\n- drag
- The drag object at the time of the event.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 147,
"itemtype": "event",
"name": "drag:enter",
"description": "Fires when this node enters a Drop Target. (Fired from dd-drop)",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- drop
- The drop object at the time of the event.
\n- drag
- The drag object at the time of the event.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 158,
"itemtype": "event",
"name": "drag:exit",
"description": "Fires when this node exits a Drop Target. (Fired from dd-drop)",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- drop
- The drop object at the time of the event.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 168,
"itemtype": "event",
"name": "drag:drophit",
"description": "Fires when this node is dropped on a valid Drop Target. (Fired from dd-ddm-drop)",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- drop
- The best guess on what was dropped on.
\n- drag
- The drag object at the time of the event.
\n- others
- An array of all the other drop targets that was dropped on.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 180,
"itemtype": "event",
"name": "drag:dropmiss",
"description": "Fires when this node is dropped on an invalid Drop Target. (Fired from dd-ddm-drop)",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- pageX
- The current node position X.
\n- pageY
- The current node position Y.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 204,
"description": "This property defaults to \"mousedown\", but when drag-gestures is loaded, it is changed to \"gesturemovestart\"",
"static": 1,
"itemtype": "property",
"name": "START_EVENT",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 212,
"itemtype": "attribute",
"name": "node",
"description": "Y.Node instance to use as the element to initiate a drag operation",
"type": "Node",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 229,
"itemtype": "attribute",
"name": "dragNode",
"description": "Y.Node instance to use as the draggable element, defaults to node",
"type": "Node",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 246,
"itemtype": "attribute",
"name": "offsetNode",
"description": "Offset the drag element by the difference in cursor position: default true",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 254,
"itemtype": "attribute",
"name": "startCentered",
"description": "Center the dragNode to the mouse position on drag:start: default false",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 262,
"itemtype": "attribute",
"name": "clickPixelThresh",
"description": "The number of pixels to move to start a drag operation, default is 3.",
"type": "Number",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 270,
"itemtype": "attribute",
"name": "clickTimeThresh",
"description": "The number of milliseconds a mousedown has to pass to start a drag operation, default is 1000.",
"type": "Number",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 278,
"itemtype": "attribute",
"name": "lock",
"description": "Set to lock this drag element so that it can't be dragged: default false.",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 294,
"itemtype": "attribute",
"name": "data",
"description": "A payload holder to store arbitrary data about this drag object, can be used to store any value.",
"type": "Mixed",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 302,
"itemtype": "attribute",
"name": "move",
"description": "If this is false, the drag element will not move with the cursor: default true. Can be used to \"resize\" the element.",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 310,
"itemtype": "attribute",
"name": "useShim",
"description": "Use the protective shim on all drag operations: default true. Only works with dd-ddm, not dd-ddm-base.",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 318,
"itemtype": "attribute",
"name": "activeHandle",
"description": "This config option is set by Drag to inform you of which handle fired the drag event (in the case that there are several handles): default false.",
"type": "Node",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 326,
"itemtype": "attribute",
"name": "primaryButtonOnly",
"description": "By default a drag operation will only begin if the mousedown occurred with the primary mouse button. Setting this to false will allow for all mousedown events to trigger a drag.",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 334,
"itemtype": "attribute",
"name": "dragging",
"description": "This attribute is not meant to be used by the implementor, it is meant to be used as an Event tracker so you can listen for it to change.",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 345,
"itemtype": "attribute",
"name": "target",
"description": "This attribute only works if the dd-drop module has been loaded. It will make this node a drop target as well as draggable.",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 357,
"itemtype": "attribute",
"name": "dragMode",
"description": "This attribute only works if the dd-drop module is active. It will set the dragMode (point, intersect, strict) of this Drag instance.",
"type": "String",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 368,
"itemtype": "attribute",
"name": "groups",
"description": "Array of groups to add this drag into.",
"type": "Array",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 393,
"itemtype": "attribute",
"name": "handles",
"description": "Array of valid handles to add. Adding something here will set all handles, even if previously added with addHandle",
"type": "Array",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 416,
"deprecated": true,
"itemtype": "attribute",
"name": "bubbles",
"description": "Controls the default bubble parent for this Drag instance. Default: Y.DD.DDM. Set to false to disable bubbling. Use bubbleTargets in config",
"type": "Object",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 429,
"itemtype": "attribute",
"name": "haltDown",
"description": "Should the mousedown event be halted. Default: true",
"type": "Boolean",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 440,
"description": "Checks the object for the methods needed to drag the object around. \nNormally this would be a node instance, but in the case of Graphics, it\nmay be an SVG node or something similar.",
"itemtype": "method",
"name": "_canDrag",
"access": "private",
"tagname": "",
"params": [
{
"name": "n",
"description": "The object to check",
"type": "Object"
}
],
"return": {
"description": "True or false if the Object contains the methods needed to Drag",
"type": "Boolean"
},
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 455,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_bubbleTargets",
"description": "The default bubbleTarget for this object. Default: Y.DD.DDM",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 461,
"itemtype": "method",
"name": "addToGroup",
"description": "Add this Drag instance to a group, this should be used for on-the-fly group additions.",
"params": [
{
"name": "g",
"description": "The group to add this Drag Instance to.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 473,
"itemtype": "method",
"name": "removeFromGroup",
"description": "Remove this Drag instance from a group, this should be used for on-the-fly group removals.",
"params": [
{
"name": "g",
"description": "The group to remove this Drag Instance from.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 485,
"itemtype": "property",
"name": "target",
"description": "This will be a reference to the Drop instance associated with this drag if the target: true config attribute is set..",
"type": "{Object}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 491,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleTarget",
"description": "Attribute handler for the target config attribute.",
"params": [
{
"name": "config",
"description": "The Config",
"type": "Boolean/Object"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 518,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_groups",
"description": "Storage Array for the groups this drag belongs to.",
"type": "{Array}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 525,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_createEvents",
"description": "This method creates all the events for this Event Target and publishes them so we get Event Bubbling.",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 590,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_ev_md",
"description": "A private reference to the mousedown DOM event",
"type": "{EventFacade}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 597,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_startTime",
"description": "The getTime of the mousedown event. Not used, just here in case someone wants/needs to use it.",
"type": "Date",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 604,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_endTime",
"description": "The getTime of the mouseup event. Not used, just here in case someone wants/needs to use it.",
"type": "Date",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 611,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_handles",
"description": "A private hash of the valid drag handles",
"type": "{Object}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 618,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_invalids",
"description": "A private hash of the invalid selector strings",
"type": "{Object}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 625,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_invalidsDefault",
"description": "A private hash of the default invalid selector strings: {'textarea': true, 'input': true, 'a': true, 'button': true, 'select': true}",
"type": "{Object}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 632,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_dragThreshMet",
"description": "Private flag to see if the drag threshhold was met",
"type": "{Boolean}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 639,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_fromTimeout",
"description": "Flag to determine if the drag operation came from a timeout",
"type": "{Boolean}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 646,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_clickTimeout",
"description": "Holder for the setTimeout call",
"type": "{Boolean}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 653,
"itemtype": "property",
"name": "deltaXY",
"description": "The offset of the mouse position to the element's position",
"type": "{Array}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 659,
"itemtype": "property",
"name": "startXY",
"description": "The initial mouse position",
"type": "{Array}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 665,
"itemtype": "property",
"name": "nodeXY",
"description": "The initial element position",
"type": "{Array}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 671,
"itemtype": "property",
"name": "lastXY",
"description": "The position of the element as it's moving (for offset calculations)",
"type": "{Array}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 677,
"itemtype": "property",
"name": "actXY",
"description": "The xy that the node will be set to. Changing this will alter the position as it's dragged.",
"type": "{Array}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 683,
"itemtype": "property",
"name": "realXY",
"description": "The real xy position of the node.",
"type": "{Array}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 689,
"itemtype": "property",
"name": "mouseXY",
"description": "The XY coords of the mousemove",
"type": "{Array}",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 695,
"itemtype": "property",
"name": "region",
"description": "A region object associated with this drag, used for checking regions while dragging.",
"type": "Object",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 701,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleMouseUp",
"description": "Handler for the mouseup DOM event",
"params": [
{
"name": "ev",
"description": "The Event",
"type": "EventFacade"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 714,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_fixDragStart",
"description": "The function we use as the ondragstart handler when we start a drag in Internet Explorer. This keeps IE from blowing up on images as drag handles.",
"params": [
{
"name": "e",
"description": "The Event",
"type": "Event"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 723,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_ieSelectFix",
"description": "The function we use as the onselectstart handler when we start a drag in Internet Explorer",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 731,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_ieSelectBack",
"description": "We will hold a copy of the current \"onselectstart\" method on this property, and reset it after we are done using it.",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 737,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_fixIEMouseDown",
"description": "This method copies the onselectstart listner on the document to the _ieSelectFix property",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 748,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_fixIEMouseUp",
"description": "This method copies the _ieSelectFix property back to the onselectstart listner on the document.",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 758,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleMouseDownEvent",
"description": "Handler for the mousedown DOM event",
"params": [
{
"name": "ev",
"description": "The Event",
"type": "EventFacade"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 767,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_defMouseDownFn",
"description": "Handler for the mousedown DOM event",
"params": [
{
"name": "e",
"description": "The Event",
"type": "EventFacade"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 800,
"itemtype": "method",
"name": "validClick",
"description": "Method first checks to see if we have handles, if so it validates the click against the handle. Then if it finds a valid handle, it checks it against the invalid handles list. Returns true if a good handle was used, false otherwise.",
"params": [
{
"name": "ev",
"description": "The Event",
"type": "EventFacade"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 869,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setStartPosition",
"description": "Sets the current position of the Element and calculates the offset",
"params": [
{
"name": "xy",
"description": "The XY coords to set the position to.",
"type": "Array"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 886,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_timeoutCheck",
"description": "The method passed to setTimeout to determine if the clickTimeThreshold was met.",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 898,
"itemtype": "method",
"name": "removeHandle",
"description": "Remove a Selector added by addHandle",
"params": [
{
"name": "str",
"description": "The selector for the handle to be removed.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 916,
"itemtype": "method",
"name": "addHandle",
"description": "Add a handle to a drag element. Drag only initiates when a mousedown happens on this element.",
"params": [
{
"name": "str",
"description": "The selector to test for a valid handle. Must be a child of the element.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 935,
"itemtype": "method",
"name": "removeInvalid",
"description": "Remove an invalid handle added by addInvalid",
"params": [
{
"name": "str",
"description": "The invalid handle to remove from the internal list.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 950,
"itemtype": "method",
"name": "addInvalid",
"description": "Add a selector string to test the handle against. If the test passes the drag operation will not continue.",
"params": [
{
"name": "str",
"description": "The selector to test against to determine if this is an invalid drag handle.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 964,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "initializer",
"description": "Internal init handler",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 994,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_prep",
"description": "Attach event listners and add classname",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1007,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_unprep",
"description": "Detach event listeners and remove classname",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1017,
"itemtype": "method",
"name": "start",
"description": "Starts the drag operation",
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1059,
"itemtype": "method",
"name": "end",
"description": "Ends the drag operation",
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1086,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_defEndFn",
"description": "Handler for fixing the selection in IE",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1095,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_prevEndFn",
"description": "Handler for preventing the drag:end event. It will reset the node back to it's start position",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1107,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_align",
"description": "Calculates the offsets and set's the XY that the element will move to.",
"params": [
{
"name": "xy",
"description": "The xy coords to align with.",
"type": "Array"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1116,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_defAlignFn",
"description": "Calculates the offsets and set's the XY that the element will move to.",
"params": [
{
"name": "e",
"description": "The drag:align event.",
"type": "EventFacade"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1125,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_alignNode",
"description": "This method performs the alignment before the element move.",
"params": [
{
"name": "eXY",
"description": "The XY to move the element to, usually comes from the mousemove DOM event.",
"type": "Array"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1135,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_moveNode",
"description": "This method performs the actual element move.",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1177,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_defDragFn",
"description": "Default function for drag:drag. Fired from _moveNode.",
"params": [
{
"name": "ev",
"description": "The drag:drag event",
"type": "EventFacade"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1193,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_move",
"description": "Fired from DragDropMgr (DDM) on mousemove.",
"params": [
{
"name": "ev",
"description": "The mousemove DOM event",
"type": "EventFacade"
}
],
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1220,
"itemtype": "method",
"name": "stopDrag",
"description": "Method will forcefully stop a drag operation. For example calling this from inside an ESC keypress handler will stop this drag.",
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drag.js",
"line": 1232,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "destructor",
"description": "Lifecycle destructor, unreg the drag from the DDM and remove listeners",
"class": "DD.Drag",
"module": "dd",
"submodule": "dd-drag",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 19,
"itemtype": "event",
"name": "drop:over",
"description": "Fires when a drag element is over this target.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- drop
- The drop object at the time of the event.
\n- drag
- The drag object at the time of the event.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 31,
"itemtype": "event",
"name": "drop:enter",
"description": "Fires when a drag element enters this target.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- drop
- The drop object at the time of the event.
\n- drag
- The drag object at the time of the event.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 43,
"itemtype": "event",
"name": "drop:exit",
"description": "Fires when a drag element exits this target.",
"params": [
{
"name": "event",
"description": "An Event Facade object",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 52,
"itemtype": "event",
"name": "drop:hit",
"description": "Fires when a draggable node is dropped on this Drop Target. (Fired from dd-ddm-drop)",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific property added:\n
\n- drop
- The best guess on what was dropped on.
\n- drag
- The drag object at the time of the event.
\n- others
- An array of all the other drop targets that was dropped on.
\n
",
"type": "EventFacade"
}
],
"bubbles": "DDM",
"type": "{CustomEvent}",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 89,
"itemtype": "attribute",
"name": "node",
"description": "Y.Node instanace to use as the element to make a Drop Target",
"type": "Node",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 103,
"itemtype": "attribute",
"name": "groups",
"description": "Array of groups to add this drop into.",
"type": "Array",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 118,
"itemtype": "attribute",
"name": "padding",
"description": "CSS style padding to make the Drop Target bigger than the node.",
"type": "String",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 129,
"itemtype": "attribute",
"name": "lock",
"description": "Set to lock this drop element.",
"type": "Boolean",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 145,
"deprecated": true,
"itemtype": "attribute",
"name": "bubbles",
"description": "Controls the default bubble parent for this Drop instance. Default: Y.DD.DDM. Set to false to disable bubbling. Use bubbleTargets in config.",
"type": "Object",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 158,
"deprecated": true,
"itemtype": "attribute",
"name": "useShim",
"description": "Use the Drop shim. Default: true",
"type": "Boolean",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 174,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_bubbleTargets",
"description": "The default bubbleTarget for this object. Default: Y.DD.DDM",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 180,
"itemtype": "method",
"name": "addToGroup",
"description": "Add this Drop instance to a group, this should be used for on-the-fly group additions.",
"params": [
{
"name": "g",
"description": "The group to add this Drop Instance to.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 191,
"itemtype": "method",
"name": "removeFromGroup",
"description": "Remove this Drop instance from a group, this should be used for on-the-fly group removals.",
"params": [
{
"name": "g",
"description": "The group to remove this Drop Instance from.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Self"
},
"chainable": 1,
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 202,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_createEvents",
"description": "This method creates all the events for this Event Target and publishes them so we get Event Bubbling.",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 227,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_valid",
"description": "Flag for determining if the target is valid in this operation.",
"type": "Boolean",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 234,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_groups",
"description": "The groups this target belongs to.",
"type": "Array",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 241,
"itemtype": "property",
"name": "shim",
"description": "Node reference to the targets shim",
"type": "{Object}",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 247,
"itemtype": "property",
"name": "region",
"description": "A region object associated with this target, used for checking regions while dragging.",
"type": "Object",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 253,
"itemtype": "property",
"name": "overTarget",
"description": "This flag is tripped when a drag element is over this target.",
"type": "Boolean",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 259,
"itemtype": "method",
"name": "inGroup",
"description": "Check if this target is in one of the supplied groups.",
"params": [
{
"name": "groups",
"description": "The groups to check against",
"type": "Array"
}
],
"return": {
"description": "Boolean"
},
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 276,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "initializer",
"description": "Private lifecycle method",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 293,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "destructor",
"description": "Lifecycle destructor, unreg the drag from the DDM and remove listeners",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 308,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_deactivateShim",
"description": "Removes classes from the target, resets some flags and sets the shims deactive position [-999, -999]",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 330,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_activateShim",
"description": "Activates the shim and adds some interaction CSS classes",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 363,
"itemtype": "method",
"name": "sizeShim",
"description": "Positions and sizes the shim with the raw data from the node, this can be used to programatically adjust the Targets shim for Animation..",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 431,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_createShim",
"description": "Creates the Target shim and adds it to the DDM's playground..",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 471,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleOverTarget",
"description": "This handles the over target call made from this object or from the DDM",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 499,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleOverEvent",
"description": "Handles the mouseover DOM event on the Target Shim",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 508,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleOutEvent",
"description": "Handles the mouseout DOM event on the Target Shim",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/drop.js",
"line": 517,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleOut",
"description": "Handles out of target calls/checks",
"class": "DD.Drop",
"module": "dd",
"submodule": "dd-drop",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 24,
"itemtype": "property",
"name": "NS",
"default": "con",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"description": "The Proxy instance will be placed on the Drag instance under the proxy namespace.",
"type": "{String}",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 38,
"itemtype": "attribute",
"name": "moveOnEnd",
"description": "Move the original node at the end of the drag. Default: true",
"type": "Boolean",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 46,
"itemtype": "attribute",
"name": "hideOnEnd",
"description": "Hide the drag node at the end of the drag. Default: true",
"type": "Boolean",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 54,
"itemtype": "attribute",
"name": "resizeFrame",
"description": "Make the Proxy node assume the size of the original node. Default: true",
"type": "Boolean",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 62,
"itemtype": "attribute",
"name": "positionProxy",
"description": "Make the Proxy node appear in the same place as the original node. Default: true",
"type": "Boolean",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 70,
"itemtype": "attribute",
"name": "borderStyle",
"description": "The default border style for the border of the proxy. Default: 1px solid #808080",
"type": "Boolean",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 78,
"itemtype": "attribute",
"name": "cloneNode",
"description": "Should the node be cloned into the proxy for you. Default: false",
"type": "Boolean",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 89,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_hands",
"description": "Holds the event handles for setting the proxy",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 95,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_init",
"description": "Handler for the proxy config attribute",
"class": "Plugin.DDProxy",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 169,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_createFrame",
"description": "Create the proxy element if it doesn't already exist and set the DD.DDM._proxy value",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/proxy.js",
"line": 197,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setFrame",
"description": "If resizeProxy is set to true (default) it will resize the proxy element to match the size of the Drag Element.\nIf positionProxy is set to true (default) it will position the proxy element in the same location as the Drag Element.",
"class": "DD.DDM",
"module": "dd",
"submodule": "dd-proxy",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 33,
"itemtype": "attribute",
"name": "parentScroll",
"description": "Internal config option to hold the node that we are scrolling. Should not be set by the developer.",
"type": "Node",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 47,
"itemtype": "attribute",
"name": "buffer",
"description": "The number of pixels from the edge of the screen to turn on scrolling. Default: 30",
"type": "Number",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 56,
"itemtype": "attribute",
"name": "scrollDelay",
"description": "The number of milliseconds delay to pass to the auto scroller. Default: 235",
"type": "Number",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 65,
"itemtype": "attribute",
"name": "host",
"description": "The host we are plugged into.",
"type": "Object",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 73,
"itemtype": "attribute",
"name": "windowScroll",
"description": "Turn on window scroll support, default: false",
"type": "Boolean",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 82,
"itemtype": "attribute",
"name": "vertical",
"description": "Allow vertical scrolling, default: true.",
"type": "Boolean",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 91,
"itemtype": "attribute",
"name": "horizontal",
"description": "Allow horizontal scrolling, default: true.",
"type": "Boolean",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 103,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_scrolling",
"description": "Tells if we are actively scrolling or not.",
"type": "Boolean",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 110,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_vpRegionCache",
"description": "Cache of the Viewport dims.",
"type": "Object",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 117,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_dimCache",
"description": "Cache of the dragNode dims.",
"type": "Object",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 124,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_scrollTimer",
"description": "Holder for the Timer object returned from Y.later.",
"type": "{Y.later}",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 131,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getVPRegion",
"description": "Sets the _vpRegionCache property with an Object containing the dims from the viewport.",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 167,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_checkWinScroll",
"description": "Check to see if we need to fire the scroll timer. If scroll timer is running this will scroll the window.",
"params": [
{
"name": "move",
"description": "Should we move the window. From Y.later",
"type": "Boolean"
}
],
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 250,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_initScroll",
"description": "Cancel a previous scroll timer and init a new one.",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 260,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_cancelScroll",
"description": "Cancel a currently running scroll timer.",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 272,
"itemtype": "method",
"name": "align",
"description": "Called from the drag:align event to determine if we need to scroll.",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 285,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setDimCache",
"description": "Set the cache of the dragNode dims.",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 297,
"itemtype": "method",
"name": "start",
"description": "Called from the drag:start event",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 304,
"itemtype": "method",
"name": "end",
"description": "Called from the drag:end event",
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 312,
"itemtype": "method",
"name": "toString",
"description": "General toString method for logging",
"return": {
"description": "String name for the object"
},
"class": "DD.Scroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "DD"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 336,
"itemtype": "attribute",
"name": "windowScroll",
"description": "Turn on window scroll support, default: true",
"type": "Boolean",
"class": "Plugin.DDWindowScroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 357,
"itemtype": "property",
"name": "NS",
"default": "winscroll",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"description": "The Scroll instance will be placed on the Drag instance under the winscroll namespace.",
"type": "{String}",
"class": "Plugin.DDWindowScroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 382,
"itemtype": "attribute",
"name": "node",
"description": "The node we want to scroll. Used to set the internal parentScroll attribute.",
"type": "Node",
"class": "Plugin.DDNodeScroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dd/js/scroll.js",
"line": 408,
"itemtype": "property",
"name": "NS",
"default": "nodescroll",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"description": "The NodeScroll instance will be placed on the Drag instance under the nodescroll namespace.",
"type": "{String}",
"class": "Plugin.DDNodeScroll",
"module": "dd",
"submodule": "dd-scroll",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 35,
"description": "The identity of the widget.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"default": "'dial'",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 47,
"description": "Static property used to define the default attribute configuration of\nthe Widget.",
"itemtype": "property",
"name": "ATTRS",
"type": "{Object}",
"access": "protected",
"tagname": "",
"static": 1,
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 58,
"description": "minimum value allowed",
"itemtype": "attribute",
"name": "min",
"type": "{Number}",
"default": "-220",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 69,
"description": "maximum value allowed",
"itemtype": "attribute",
"name": "max",
"type": "{Number}",
"default": "220",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 80,
"description": "diameter of the circular background object.\nOther objects scale accordingly.\nSet this only before rendering.",
"itemtype": "attribute",
"name": "diameter",
"type": "{Number} the number of px in diameter",
"default": "100",
"writeonce": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 94,
"description": "diameter of the handle object which users drag to change the value.\nDial sets the pixel dimension of the handle equal to handleDiameter * diameter.\nSet this only before rendering.",
"itemtype": "attribute",
"name": "handleDiameter",
"type": "{Number}",
"default": "0.2",
"writeonce": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 108,
"description": "diameter of the marker object which follows the angle of the handle during value changes.\nDial sets the pixel dimension of the marker equal to markerDiameter * diameter.\nSet this only before rendering.",
"itemtype": "attribute",
"name": "markerDiameter",
"type": "{Number}",
"default": "0.1",
"writeonce": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 122,
"description": "diameter of the center button object.\nDial sets the pixel dimension of the centerButton equal to centerButtonDiameter * diameter.\nSet this only before rendering.",
"itemtype": "attribute",
"name": "centerButtonDiameter",
"type": "{Number}",
"default": "0.1",
"writeonce": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 136,
"description": "initial value of the Dial",
"itemtype": "attribute",
"name": "value",
"type": "{Number}",
"default": "0",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 150,
"description": "amount to increment/decrement the dial value\nwhen the arrow up/down/left/right keys are pressed",
"itemtype": "attribute",
"name": "minorStep",
"type": "{Number}",
"default": "1",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 162,
"description": "amount to increment/decrement the dial value\nwhen the page up/down keys are pressed",
"itemtype": "attribute",
"name": "majorStep",
"type": "{Number}",
"default": "10",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 174,
"description": "number of value increments in one 360 degree revolution \nof the handle around the dial",
"itemtype": "attribute",
"name": "stepsPerRevolution",
"type": "{Number}",
"default": "100",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 186,
"description": "number of decimal places of accuracy in the value",
"itemtype": "attribute",
"name": "decimalPlaces",
"type": "{Number}",
"default": "0",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 197,
"description": "visible strings for the dial UI. This attribute is \ndefined by the base Widget class but has an empty value. The\nDial is simply providing a default value for the attribute.\nGets localized strings in the current language",
"itemtype": "attribute",
"name": "strings",
"type": "{Object} the values are HTML strings",
"default": "{label: 'My label', resetStr: 'Reset', tooltipHandle: 'Drag to set value'}",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 213,
"description": "distance from the center of the dial to the \ncenter of the marker and handle, when at rest. \nThe value is a percent of the radius of the dial.",
"itemtype": "attribute",
"name": "handleDistance",
"type": "{number}",
"default": "0.75",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 228,
"description": "returns a properly formed yui class name",
"itemtype": "method",
"name": "",
"params": [
{
"name": "string",
"description": "to be appended at the end of class name",
"type": "String"
}
],
"return": {
"description": ""
},
"access": "private",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 240,
"itemtype": "property",
"name": "CSS_CLASSES",
"type": "{Array}",
"access": "private",
"tagname": "",
"static": 1,
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 270,
"description": "template that will contain the Dial's label.",
"itemtype": "property",
"name": "LABEL_TEMPLATE",
"type": "{HTML}",
"default": "<div id=\"' + labelId + '\" class=\"[...-label]\"><span class=\"[...-label-string]\">{label}</span><span class=\"[...-value-string]\"></span></div>",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 282,
"description": "template that will contain the Dial's background ring.",
"itemtype": "property",
"name": "RING_TEMPLATE",
"type": "{HTML}",
"default": "<div class=\"[...-ring]\"><div class=\"[...-northMark]\"></div></div>",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 292,
"description": "template that will contain the Dial's current angle marker.",
"itemtype": "property",
"name": "MARKER_TEMPLATE",
"type": "{HTML}",
"default": "<div class=\"[...-marker] [...-marker-hidden]\"><div class=\"[...-markerUser]\"></div></div>",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 302,
"description": "template that will contain the Dial's center button.",
"itemtype": "property",
"name": "CENTER_BUTTON_TEMPLATE",
"type": "{HTML}",
"default": "<div class=\"[...-centerButton]\"><div class=\"[...-resetString]\">' + Y.substitute('{resetStr}', Dial.ATTRS.strings.value) + '</div></div>",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 312,
"description": "template that will contain the Dial's handle.",
"itemtype": "property",
"name": "HANDLE_TEMPLATE",
"type": "{HTML}",
"default": "<div class=\"[...-handle]\"><div class=\"[...-handleUser]\" aria-labelledby=\"' + labelId + '\" aria-valuetext=\"\" aria-valuemax=\"\" aria-valuemin=\"\" aria-valuenow=\"\" role=\"slider\" tabindex=\"0\"></div></div>';// title=\"{tooltipHandle}\"",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 353,
"description": "creates the DOM structure for the Dial.",
"itemtype": "method",
"name": "renderUI",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 388,
"description": "Sets -webkit-border-radius to 50% of width/height of the ring, handle, marker, and center-button.\nThis is needed for iOS 3.x.\nThe objects render square if the radius is > 50% of the width/height",
"itemtype": "method",
"name": "_setBorderRadius",
"access": "private",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 414,
"description": "Creates the Y.DD.Drag instance used for the handle movement and\nbinds Dial interaction to the configured value model.",
"itemtype": "method",
"name": "bindUI",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 456,
"description": "Sets _timesWrapped based on Dial value\nto net integer revolutions the user dragged the handle around the Dial",
"itemtype": "method",
"name": "_setTimesWrappedFromValue",
"params": [
{
"name": "val",
"description": "current value of the Dial",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 472,
"description": "gets the angle of the line from the center of the Dial to the center of the handle",
"itemtype": "method",
"name": "_getAngleFromHandleCenter",
"params": [
{
"name": "handleCenterX",
"description": "",
"type": "Number"
},
{
"name": "handleCenterY",
"description": "",
"type": "Number"
}
],
"return": {
"description": "ang the angle",
"type": "Number"
},
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 487,
"description": "recalculates the XY of the center of the dial. \nThis is needed for calculating the angle of the handle",
"itemtype": "method",
"name": "_recalculateDialCenter",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 499,
"description": "handles the user dragging the handle around the Dial, gets the angle, \nchecks for wrapping around top center.\nSets the new value of the Dial",
"itemtype": "method",
"name": "_handleDrag",
"params": [
{
"name": "e",
"description": "the drag event object",
"type": "DOMEvent"
}
],
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 548,
"description": "handles a mousedown or gesturemovestart event on the ringNode",
"itemtype": "method",
"name": "_handleMousedown",
"params": [
{
"name": "e",
"description": "the event object",
"type": "DOMEvent"
}
],
"access": "private",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 665,
"description": "handles the case where the value is less than min or greater than max",
"itemtype": "method",
"name": "_handleValuesBeyondMinMax",
"params": [
{
"name": "e",
"description": "the event object",
"type": "DOMEvent"
},
{
"name": "newValue",
"description": "current value of the dial",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 696,
"description": "handles the user starting to drag the handle around the Dial",
"itemtype": "method",
"name": "_handleDragStart",
"params": [
{
"name": "e",
"description": "the drag event object",
"type": "DOMEvent"
}
],
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 712,
"description": "handles the end of a user dragging the handle, animates the handle returning to\nresting position.",
"itemtype": "method",
"name": "_handleDragEnd",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 740,
"description": "returns the XY of the fixed position, handleDistance, from the center of the Dial (resting position).\nThe XY also represents the angle related to the current value.\nIf typeArray is true, [X,Y] is returned.\nIf typeArray is false, the XY of the obj node passed in is set.",
"itemtype": "method",
"name": "_setNodeToFixedRadius",
"params": [
{
"name": "obj",
"description": "",
"type": "Node"
},
{
"name": "typeArray",
"description": "true returns an array [X,Y]",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"return": {
"description": "an array of [XY] is optionally returned",
"type": "Array"
},
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 769,
"description": "Synchronizes the DOM state with the attribute settings.",
"itemtype": "method",
"name": "syncUI",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 786,
"description": "sets the sizes of ring, center-button, marker, handle, and VML ovals in pixels.\nNeeded only because some IE versions \nignore CSS percent sizes/offsets.\nso these must be set in pixels.\nNormally these are set in % of the ring.",
"itemtype": "method",
"name": "_setSizes",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 834,
"description": "renders the DOM object for the Dial's label",
"itemtype": "method",
"name": "_renderLabel",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 851,
"description": "renders the DOM object for the Dial's background ring",
"itemtype": "method",
"name": "_renderRing",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 867,
"description": "renders the DOM object for the Dial's background marker which \ntracks the angle of the user dragging the handle",
"itemtype": "method",
"name": "_renderMarker",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 883,
"description": "renders the DOM object for the Dial's center",
"itemtype": "method",
"name": "_renderCenterButton",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 900,
"description": "renders the DOM object for the Dial's user draggable handle",
"itemtype": "method",
"name": "_renderHandle",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 916,
"description": "sets the visible UI label HTML string",
"itemtype": "method",
"name": "_setLabelString",
"params": [
{
"name": "str",
"description": "",
"type": "HTML"
}
],
"access": "protected",
"tagname": "",
"deprecated": true,
"deprecationMessage": "Use DialObjName.set('strings',{'label':'My new label'}); before DialObjName.render();",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 929,
"description": "sets the visible UI label HTML string",
"itemtype": "method",
"name": "_setResetString",
"params": [
{
"name": "str",
"description": "",
"type": "HTML"
}
],
"access": "protected",
"tagname": "",
"deprecated": true,
"deprecationMessage": "Use DialObjName.set('strings',{'resetStr':'My new reset string'}); before DialObjName.render();",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 943,
"description": "sets the tooltip HTML string in the Dial's handle",
"itemtype": "method",
"name": "_setTooltipString",
"params": [
{
"name": "str",
"description": "",
"type": "HTML"
}
],
"access": "protected",
"tagname": "",
"deprecated": true,
"deprecationMessage": "Use DialObjName.set('strings',{'tooltipHandle':'My new tooltip'}); before DialObjName.render();",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 955,
"description": "sets the Dial's value in response to key events.\nLeft and right keys are in a separate method \nin case an implementation wants to increment values\nbut needs left and right arrow keys for other purposes.",
"itemtype": "method",
"name": "_onDirectionKey",
"params": [
{
"name": "e",
"description": "the key event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 989,
"description": "sets the Dial's value in response to left or right key events",
"itemtype": "method",
"name": "_onLeftRightKey",
"params": [
{
"name": "e",
"description": "the key event",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1008,
"description": "increments Dial value by a minor increment",
"itemtype": "method",
"name": "_incrMinor",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1024,
"description": "decrements Dial value by a minor increment",
"itemtype": "method",
"name": "_decrMinor",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1036,
"description": "increments Dial value by a major increment",
"itemtype": "method",
"name": "_incrMajor",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1048,
"description": "decrements Dial value by a major increment",
"itemtype": "method",
"name": "_decrMajor",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1060,
"description": "sets Dial value to dial's max attr",
"itemtype": "method",
"name": "_setToMax",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1070,
"description": "sets Dial value to dial's min attr",
"itemtype": "method",
"name": "_setToMin",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1080,
"description": "resets Dial value to the orignal initial value.",
"itemtype": "method",
"name": "_resetDial",
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1095,
"description": "returns the handle angle associated with the current value of the Dial. \nReturns a number between 0 and 360.",
"itemtype": "method",
"name": "_getAngleFromValue",
"params": [
{
"name": "newVal",
"description": "the current value of the Dial",
"type": "Number"
}
],
"return": {
"description": "the angle associated with the current Dial value",
"type": "Number"
},
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1110,
"description": "returns the value of the Dial calculated from the current handle angle",
"itemtype": "method",
"name": "_getValueFromAngle",
"params": [
{
"name": "angle",
"description": "the current angle of the Dial's handle",
"type": "Number"
}
],
"return": {
"description": "the current Dial value corresponding to the handle position",
"type": "Number"
},
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1130,
"description": "calls the method to update the UI whenever the Dial value changes",
"itemtype": "method",
"name": "_afterValueChange",
"params": [
{
"name": "e",
"description": "",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1141,
"description": "Changes a value to have the correct decimal places per the attribute decimalPlaces",
"itemtype": "method",
"name": "_valueToDecimalPlaces",
"params": [
{
"name": "val",
"description": "a raw value to set to the Dial",
"type": "Number"
}
],
"return": {
"description": "the input val changed to have the correct decimal places",
"type": "Number"
},
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1153,
"description": "Updates the UI display value of the Dial to reflect \nthe value passed in.\nMakes all other needed UI display changes",
"itemtype": "method",
"name": "_uiSetValue",
"params": [
{
"name": "val",
"description": "value of the Dial",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dial/js/Dial.js",
"line": 1190,
"description": "value attribute default validator. Verifies that\nthe value being set lies between the min/max value",
"itemtype": "method",
"name": "_validateValue",
"params": [
{
"name": "val",
"description": "value of the Dial",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "Dial",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-attrs.js",
"line": 10,
"description": "Returns the text content of the HTMLElement.",
"itemtype": "method",
"name": "getText",
"params": [
{
"name": "element",
"description": "The html element.",
"type": "HTMLElement"
}
],
"return": {
"description": "The text content of the element (includes text of any descending elements).",
"type": "String"
},
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-attrs.js",
"line": 31,
"description": "Sets the text content of the HTMLElement.",
"itemtype": "method",
"name": "setText",
"params": [
{
"name": "element",
"description": "The html element.",
"type": "HTMLElement"
},
{
"name": "content",
"description": "The content to add.",
"type": "String"
}
],
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-attrs.js",
"line": 58,
"description": "Provides a normalized attribute interface.",
"itemtype": "method",
"name": "setAttribute",
"params": [
{
"name": "el",
"description": "The target element for the attribute.",
"type": "HTMLElement"
},
{
"name": "attr",
"description": "The attribute to set.",
"type": "String"
},
{
"name": "val",
"description": "The value of the attribute.",
"type": "String"
}
],
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-attrs.js",
"line": 74,
"description": "Provides a normalized attribute interface.",
"itemtype": "method",
"name": "getAttibute",
"params": [
{
"name": "el",
"description": "The target element for the attribute.",
"type": "HTMLElement"
},
{
"name": "attr",
"description": "The attribute to get.",
"type": "String"
}
],
"return": {
"description": "The current value of the attribute.",
"type": "String"
},
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-class.js",
"line": 4,
"description": "Determines whether a DOM element has the given className.",
"itemtype": "method",
"name": "hasClass",
"params": [
{
"name": "element",
"description": "The DOM element.",
"type": "HTMLElement"
},
{
"name": "className",
"description": "the class name to search for",
"type": "String"
}
],
"return": {
"description": "Whether or not the element has the given class.",
"type": "Boolean"
},
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-class.js",
"line": 17,
"description": "Adds a class name to a given DOM element.",
"itemtype": "method",
"name": "addClass",
"params": [
{
"name": "element",
"description": "The DOM element.",
"type": "HTMLElement"
},
{
"name": "className",
"description": "the class name to add to the class attribute",
"type": "String"
}
],
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-class.js",
"line": 30,
"description": "Removes a class name from a given element.",
"itemtype": "method",
"name": "removeClass",
"params": [
{
"name": "element",
"description": "The DOM element.",
"type": "HTMLElement"
},
{
"name": "className",
"description": "the class name to remove from the class attribute",
"type": "String"
}
],
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-class.js",
"line": 48,
"description": "Replace a class with another class for a given element.\nIf no oldClassName is present, the newClassName is simply added.",
"itemtype": "method",
"name": "replaceClass",
"params": [
{
"name": "element",
"description": "The DOM element",
"type": "HTMLElement"
},
{
"name": "oldClassName",
"description": "the class name to be replaced",
"type": "String"
},
{
"name": "newClassName",
"description": "the class name that will be replacing the old class name",
"type": "String"
}
],
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-class.js",
"line": 63,
"description": "If the className exists on the node it is removed, if it doesn't exist it is added.",
"itemtype": "method",
"name": "toggleClass",
"params": [
{
"name": "element",
"description": "The DOM element",
"type": "HTMLElement"
},
{
"name": "className",
"description": "the class name to be toggled",
"type": "String"
},
{
"name": "addClass",
"description": "optional boolean to indicate whether class\nshould be added or removed regardless of current state",
"type": "Boolean"
}
],
"class": "DOM",
"module": "dial"
},
{
"file": "lib/yui3/src/dom/js/dom-core.js",
"line": 32,
"description": "Returns the HTMLElement with the given ID (Wrapper for document.getElementById).",
"itemtype": "method",
"name": "byId",
"params": [
{
"name": "id",
"description": "the id attribute",
"type": "String"
},
{
"name": "doc",
"description": "optional The document to search. Defaults to current document",
"type": "Object"
}
],
"return": {
"description": "The HTMLElement with the id, or null if none found.",
"type": "HTMLElement | null"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-base"
},
{
"file": "lib/yui3/src/dom/js/dom-core.js",
"line": 91,
"description": "Searches the element by the given axis for the first matching element.",
"itemtype": "method",
"name": "elementByAxis",
"params": [
{
"name": "element",
"description": "The html element.",
"type": "HTMLElement"
},
{
"name": "axis",
"description": "The axis to search (parentNode, nextSibling, previousSibling).",
"type": "String"
},
{
"name": "fn",
"description": "optional An optional boolean test to apply.",
"type": "Function"
},
{
"name": "all",
"description": "optional Whether all node types should be returned, or just element nodes.\nThe optional function is passed the current HTMLElement being tested as its only argument.\nIf no function is given, the first element is returned.",
"type": "Boolean"
}
],
"return": {
"description": "The matching element or null if none found.",
"type": "HTMLElement | null"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-base"
},
{
"file": "lib/yui3/src/dom/js/dom-core.js",
"line": 115,
"description": "Determines whether or not one HTMLElement is or contains another HTMLElement.",
"itemtype": "method",
"name": "contains",
"params": [
{
"name": "element",
"description": "The containing html element.",
"type": "HTMLElement"
},
{
"name": "needle",
"description": "The html element that may be contained.",
"type": "HTMLElement"
}
],
"return": {
"description": "Whether or not the element is or contains the needle.",
"type": "Boolean"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-base"
},
{
"file": "lib/yui3/src/dom/js/dom-core.js",
"line": 142,
"description": "Determines whether or not the HTMLElement is part of the document.",
"itemtype": "method",
"name": "inDoc",
"params": [
{
"name": "element",
"description": "The containing html element.",
"type": "HTMLElement"
},
{
"name": "doc",
"description": "optional The document to check.",
"type": "HTMLElement"
}
],
"return": {
"description": "Whether or not the element is attached to the document.",
"type": "Boolean"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-base"
},
{
"file": "lib/yui3/src/dom/js/dom-core.js",
"line": 244,
"description": "Brute force version of contains.\nUsed for browsers without contains support for non-HTMLElement Nodes (textNodes, etc).",
"itemtype": "method",
"name": "_bruteContains",
"access": "private",
"tagname": "",
"params": [
{
"name": "element",
"description": "The containing html element.",
"type": "HTMLElement"
},
{
"name": "needle",
"description": "The html element that may be contained.",
"type": "HTMLElement"
}
],
"return": {
"description": "Whether or not the element is or contains the needle.",
"type": "Boolean"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-base"
},
{
"file": "lib/yui3/src/dom/js/dom-core.js",
"line": 264,
"description": "Memoizes dynamic regular expressions to boost runtime performance.",
"itemtype": "method",
"name": "_getRegExp",
"access": "private",
"tagname": "",
"params": [
{
"name": "str",
"description": "The string to convert to a regular expression.",
"type": "String"
},
{
"name": "flags",
"description": "optional An optinal string of flags.",
"type": "String"
}
],
"return": {
"description": "An instance of RegExp",
"type": "RegExp"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-base"
},
{
"file": "lib/yui3/src/dom/js/dom-core.js",
"line": 282,
"description": "returns the appropriate document.",
"itemtype": "method",
"name": "_getDoc",
"access": "private",
"tagname": "",
"params": [
{
"name": "element",
"description": "optional Target element.",
"type": "HTMLElement"
}
],
"return": {
"description": "The document for the given element or the default document.",
"type": "Object"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-base"
},
{
"file": "lib/yui3/src/dom/js/dom-core.js",
"line": 301,
"description": "returns the appropriate window.",
"itemtype": "method",
"name": "_getWin",
"access": "private",
"tagname": "",
"params": [
{
"name": "element",
"description": "optional Target element.",
"type": "HTMLElement"
}
],
"return": {
"description": "The window for the given element or the default window.",
"type": "Object"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-base"
},
{
"file": "lib/yui3/src/dom/js/dom-create.js",
"line": 43,
"description": "Creates a new dom node using the provided markup string.",
"itemtype": "method",
"name": "create",
"params": [
{
"name": "html",
"description": "The markup used to create the element",
"type": "String"
},
{
"name": "doc",
"description": "An optional document context",
"type": "HTMLDocument"
}
],
"return": {
"description": "returns a single HTMLElement \nwhen creating one node, and a documentFragment when creating\nmultiple nodes.",
"type": "HTMLElement|DocumentFragment"
},
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-create.js",
"line": 115,
"description": "Inserts content in a node at the given location",
"itemtype": "method",
"name": "addHTML",
"params": [
{
"name": "node",
"description": "The node to insert into",
"type": "HTMLElement"
},
{
"name": "content",
"description": "The content to be inserted",
"type": "HTMLElement | Array | HTMLCollection"
},
{
"name": "where",
"description": "Where to insert the content\nIf no \"where\" is given, content is appended to the node\nPossible values for \"where\"\n
\n- HTMLElement
\n- The element to insert before
\n- \"replace\"
\n- Replaces the existing HTML
\n- \"before\"
\n- Inserts before the existing HTML
\n- \"before\"
\n- Inserts content before the node
\n- \"after\"
\n- Inserts content after the node
\n
",
"type": "HTMLElement"
}
],
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-region.js",
"line": 24,
"description": "Returns an Object literal containing the following about this element: (top, right, bottom, left)",
"itemtype": "method",
"name": "region",
"params": [
{
"name": "element",
"description": "The DOM element.",
"type": "HTMLElement"
}
],
"return": {
"description": "Object literal containing the following about this element: (top, right, bottom, left)",
"type": "Object"
},
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-region.js",
"line": 47,
"description": "Find the intersect information for the passes nodes.",
"itemtype": "method",
"name": "intersect",
"params": [
{
"name": "element",
"description": "The first element",
"type": "HTMLElement"
},
{
"name": "element2",
"description": "The element or region to check the interect with",
"type": "HTMLElement | Object"
},
{
"name": "altRegion",
"description": "An object literal containing the region for the first element if we already have the data (for performance i.e. DragDrop)",
"type": "Object"
}
],
"return": {
"description": "Object literal containing the following intersection data: (top, right, bottom, left, area, yoff, xoff, inRegion)",
"type": "Object"
},
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-region.js",
"line": 82,
"description": "Check if any part of this node is in the passed region",
"itemtype": "method",
"name": "inRegion",
"params": [
{
"name": "node2",
"description": "The node to get the region from or an Object literal of the region\n$param {Boolean} all Should all of the node be inside the region",
"type": "Object"
},
{
"name": "altRegion",
"description": "An object literal containing the region for this node if we already have the data (for performance i.e. DragDrop)",
"type": "Object"
}
],
"return": {
"description": "True if in region, false if not.",
"type": "Boolean"
},
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-region.js",
"line": 122,
"description": "Check if any part of this element is in the viewport",
"itemtype": "method",
"name": "inViewportRegion",
"params": [
{
"name": "element",
"description": "The DOM element.",
"type": "HTMLElement"
},
{
"name": "all",
"description": "Should all of the node be inside the region",
"type": "Boolean"
},
{
"name": "altRegion",
"description": "An object literal containing the region for this node if we already have the data (for performance i.e. DragDrop)",
"type": "Object"
}
],
"return": {
"description": "True if in region, false if not.",
"type": "Boolean"
},
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-region.js",
"line": 149,
"description": "Returns an Object literal containing the following about the visible region of viewport: (top, right, bottom, left)",
"itemtype": "method",
"name": "viewportRegion",
"return": {
"description": "Object literal containing the following about the visible region of the viewport: (top, right, bottom, left)",
"type": "Object"
},
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 41,
"description": "Returns the inner height of the viewport (exludes scrollbar).",
"itemtype": "method",
"name": "winHeight",
"return": {
"description": "The current height of the viewport.",
"type": "Number"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 52,
"description": "Returns the inner width of the viewport (exludes scrollbar).",
"itemtype": "method",
"name": "winWidth",
"return": {
"description": "The current width of the viewport.",
"type": "Number"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 63,
"description": "Document height",
"itemtype": "method",
"name": "docHeight",
"return": {
"description": "The current height of the document.",
"type": "Number"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 74,
"description": "Document width",
"itemtype": "method",
"name": "docWidth",
"return": {
"description": "The current width of the document.",
"type": "Number"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 85,
"description": "Amount page has been scroll horizontally",
"itemtype": "method",
"name": "docScrollX",
"return": {
"description": "The current amount the screen is scrolled horizontally.",
"type": "Number"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 97,
"description": "Amount page has been scroll vertically",
"itemtype": "method",
"name": "docScrollY",
"return": {
"description": "The current amount the screen is scrolled vertically.",
"type": "Number"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 109,
"description": "Gets the current position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).",
"itemtype": "method",
"name": "getXY",
"params": [
{
"name": "element",
"description": "The target element"
}
],
"return": {
"description": "The XY position of the element\n\n TODO: test inDocument/display?",
"type": "Array"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 255,
"description": "Gets the current X position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).",
"itemtype": "method",
"name": "getX",
"params": [
{
"name": "element",
"description": "The target element"
}
],
"return": {
"description": "The X position of the element",
"type": "Int"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 268,
"description": "Gets the current Y position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).",
"itemtype": "method",
"name": "getY",
"params": [
{
"name": "element",
"description": "The target element"
}
],
"return": {
"description": "The Y position of the element",
"type": "Int"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 281,
"description": "Set the position of an html element in page coordinates.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
"itemtype": "method",
"name": "setXY",
"params": [
{
"name": "element",
"description": "The target element"
},
{
"name": "xy",
"description": "Contains X & Y values for new position (coordinates are page-based)",
"type": "Array"
},
{
"name": "noRetry",
"description": "By default we try and set the position a second time if the first fails",
"type": "Boolean"
}
],
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 327,
"description": "Set the X position of an html element in page coordinates, regardless of how the element is positioned.\nThe element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
"itemtype": "method",
"name": "setX",
"params": [
{
"name": "element",
"description": "The target element"
},
{
"name": "x",
"description": "The X values for new position (coordinates are page-based)",
"type": "Int"
}
],
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 338,
"description": "Set the Y position of an html element in page coordinates, regardless of how the element is positioned.\nThe element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).",
"itemtype": "method",
"name": "setY",
"params": [
{
"name": "element",
"description": "The target element"
},
{
"name": "y",
"description": "The Y values for new position (coordinates are page-based)",
"type": "Int"
}
],
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-screen.js",
"line": 349,
"itemtype": "method",
"name": "swapXY",
"description": "Swap the xy position with another node",
"params": [
{
"name": "node",
"description": "The node to swap with",
"type": "Node"
},
{
"name": "otherNode",
"description": "The other node to swap with",
"type": "Node"
}
],
"return": {
"description": "",
"type": "Node"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-screen"
},
{
"file": "lib/yui3/src/dom/js/dom-size.js",
"line": 2,
"description": "Sets the width of the element to the given size, regardless\nof box model, border, padding, etc.",
"itemtype": "method",
"name": "setWidth",
"params": [
{
"name": "element",
"description": "The DOM element.",
"type": "HTMLElement"
},
{
"name": "size",
"description": "The pixel height to size to",
"type": "String|Int"
}
],
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-size.js",
"line": 14,
"description": "Sets the height of the element to the given size, regardless\nof box model, border, padding, etc.",
"itemtype": "method",
"name": "setHeight",
"params": [
{
"name": "element",
"description": "The DOM element.",
"type": "HTMLElement"
},
{
"name": "size",
"description": "The pixel height to size to",
"type": "String|Int"
}
],
"class": "DOM",
"module": "dom"
},
{
"file": "lib/yui3/src/dom/js/dom-style.js",
"line": 49,
"description": "Sets a style property for a given element.",
"itemtype": "method",
"name": "setStyle",
"params": [
{
"name": "An",
"description": "HTMLElement to apply the style to.",
"type": "HTMLElement"
},
{
"name": "att",
"description": "The style property to set.",
"type": "String"
},
{
"name": "val",
"description": "The value.",
"type": "String|Number"
}
],
"class": "DOM",
"module": "dom",
"submodule": "dom-style"
},
{
"file": "lib/yui3/src/dom/js/dom-style.js",
"line": 82,
"description": "Returns the current style value for the given property.",
"itemtype": "method",
"name": "getStyle",
"params": [
{
"name": "An",
"description": "HTMLElement to get the style from.",
"type": "HTMLElement"
},
{
"name": "att",
"description": "The style property to get.",
"type": "String"
}
],
"class": "DOM",
"module": "dom",
"submodule": "dom-style"
},
{
"file": "lib/yui3/src/dom/js/dom-style.js",
"line": 110,
"description": "Sets multiple style properties.",
"itemtype": "method",
"name": "setStyles",
"params": [
{
"name": "node",
"description": "An HTMLElement to apply the styles to.",
"type": "HTMLElement"
},
{
"name": "hash",
"description": "An object literal of property:value pairs.",
"type": "Object"
}
],
"class": "DOM",
"module": "dom",
"submodule": "dom-style"
},
{
"file": "lib/yui3/src/dom/js/dom-style.js",
"line": 123,
"description": "Returns the computed style for the given node.",
"itemtype": "method",
"name": "getComputedStyle",
"params": [
{
"name": "An",
"description": "HTMLElement to get the style from.",
"type": "HTMLElement"
},
{
"name": "att",
"description": "The style property to get.",
"type": "String"
}
],
"return": {
"description": "The computed value of the style property.",
"type": "String"
},
"class": "DOM",
"module": "dom",
"submodule": "dom-style"
},
{
"file": "lib/yui3/src/dom/js/selector-css2.js",
"line": 53,
"description": "Mapping of shorthand tokens to corresponding attribute selector",
"itemtype": "property",
"name": "shorthand",
"type": "object",
"class": "Selector",
"module": "dom",
"submodule": "selector-css2"
},
{
"file": "lib/yui3/src/dom/js/selector-css2.js",
"line": 63,
"description": "List of operators and corresponding boolean functions. \nThese functions are passed the attribute and the current node's value of the attribute.",
"itemtype": "property",
"name": "operators",
"type": "object",
"class": "Selector",
"module": "dom",
"submodule": "selector-css2"
},
{
"file": "lib/yui3/src/dom/js/selector-native.js",
"line": 91,
"description": "Retrieves a set of nodes based on a given CSS selector.",
"itemtype": "method",
"name": "query",
"params": [
{
"name": "selector",
"description": "The CSS Selector to test the node against.",
"type": "String"
},
{
"name": "root",
"description": "optional An HTMLElement to start the query from. Defaults to Y.config.doc",
"type": "HTMLElement"
},
{
"name": "firstOnly",
"description": "optional Whether or not to return only the first match.",
"type": "Boolean"
}
],
"return": {
"description": "An array of nodes that match the given selector.",
"type": "Array"
},
"static": 1,
"class": "Selector",
"module": "dom",
"submodule": "selector-native"
},
{
"file": "lib/yui3/src/dom/js/selector-native.js",
"line": 251,
"description": "A convenience function to emulate Y.Node's aNode.ancestor(selector).",
"params": [
{
"name": "element",
"description": "An HTMLElement to start the query from.",
"type": "HTMLElement"
},
{
"name": "selector",
"description": "The CSS selector to test the node against.",
"type": "String"
},
{
"name": "testSelf",
"description": "optional Whether or not to include the element in the scan",
"type": "Boolean"
}
],
"return": {
"description": "The ancestor node matching the selector, or null.",
"type": "HTMLElement"
},
"static": 1,
"itemtype": "method",
"name": "ancestor",
"class": "Selector",
"module": "dom",
"submodule": "selector-native"
},
{
"file": "lib/yui3/src/dump/js/dump.js",
"line": 18,
"description": "Returns a simple string representation of the object or array.\nOther types of objects will be returned unprocessed. Arrays\nare expected to be indexed.",
"itemtype": "method",
"name": "dump",
"params": [
{
"name": "o",
"description": "The object to dump.",
"type": "Object"
},
{
"name": "d",
"description": "How deep to recurse child objects, default 3.",
"type": "Number"
}
],
"return": {
"description": "the dump result.",
"type": "String"
},
"class": "YUI",
"module": "dump"
},
{
"file": "lib/yui3/src/editor/js/createlink-base.js",
"line": 11,
"description": "Strings used by the plugin",
"itemtype": "property",
"name": "STRINGS",
"static": 1,
"class": "Plugin.CreateLinkBase",
"module": "editor"
},
{
"file": "lib/yui3/src/editor/js/createlink-base.js",
"line": 17,
"description": "String used for the Prompt",
"itemtype": "property",
"name": "PROMPT",
"static": 1,
"class": "Plugin.CreateLinkBase",
"module": "editor"
},
{
"file": "lib/yui3/src/editor/js/createlink-base.js",
"line": 23,
"description": "String used as the default value of the Prompt",
"itemtype": "property",
"name": "DEFAULT",
"static": 1,
"class": "Plugin.CreateLinkBase",
"module": "editor"
},
{
"file": "lib/yui3/src/editor/js/createlink-base.js",
"line": 35,
"description": "Override for the createlink method from the
CreateLinkBase plugin.",
"itemtype": "method",
"name": "COMMANDS.createlink",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: createlink",
"type": "String"
}
],
"return": {
"description": "Node instance of the item touched by this command.",
"type": "Node"
},
"class": "ExecCommand",
"module": "editor"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 23,
"description": "Internal reference to the Y.Frame instance",
"itemtype": "property",
"name": "frame",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 59,
"description": "Copy certain styles from one node instance to another (used for new paragraph creation mainly)",
"itemtype": "method",
"name": "copyStyles",
"params": [
{
"name": "from",
"description": "The Node instance to copy the styles from",
"type": "Node"
},
{
"name": "to",
"description": "The Node instance to copy the styles to",
"type": "Node"
}
],
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 86,
"description": "Holder for the selection bookmark in IE.",
"itemtype": "property",
"name": "_lastBookmark",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 92,
"description": "Resolves the e.changedNode in the nodeChange event if it comes from the document. If\nthe event came from the document, it will get the last child of the last child of the document\nand return that instead.",
"itemtype": "method",
"name": "_resolveChangedNode",
"params": [
{
"name": "n",
"description": "The node to resolve",
"type": "Node"
}
],
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 135,
"description": "The default handler for the nodeChange event.",
"itemtype": "method",
"name": "_defNodeChangeFn",
"params": [
{
"name": "e",
"description": "The event",
"type": "Event"
}
],
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 306,
"description": "Walk the dom tree from this node up to body, returning a reversed array of parents.",
"itemtype": "method",
"name": "getDomPath",
"params": [
{
"name": "node",
"description": "The Node to start from",
"type": "Node"
}
],
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 378,
"description": "After frame ready, bind mousedown & keyup listeners",
"itemtype": "method",
"name": "_afterFrameReady",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 401,
"description": "Caches the current cursor position in IE.",
"itemtype": "method",
"name": "_beforeFrameDeactivate",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 417,
"description": "Moves the cached selection bookmark back so IE can place the cursor in the right place.",
"itemtype": "method",
"name": "_onFrameActivate",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 449,
"description": "Fires nodeChange event",
"itemtype": "method",
"name": "_onPaste",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 457,
"description": "Fires nodeChange event",
"itemtype": "method",
"name": "_onFrameMouseUp",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 465,
"description": "Fires nodeChange event",
"itemtype": "method",
"name": "_onFrameMouseDown",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 473,
"description": "Caches a copy of the selection for key events. Only creating the selection on keydown",
"itemtype": "property",
"name": "_currentSelection",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 479,
"description": "Holds the timer for selection clearing",
"itemtype": "property",
"name": "_currentSelectionTimer",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 485,
"description": "Flag to determine if we can clear the selection or not.",
"itemtype": "property",
"name": "_currentSelectionClear",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 491,
"description": "Fires nodeChange event",
"itemtype": "method",
"name": "_onFrameKeyDown",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 527,
"description": "Fires nodeChange event",
"itemtype": "method",
"name": "_onFrameKeyPress",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 542,
"description": "Fires nodeChange event for keyup on specific keys",
"itemtype": "method",
"name": "_onFrameKeyUp",
"access": "private",
"tagname": "",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 561,
"description": "Pass through to the frame.execCommand method",
"itemtype": "method",
"name": "execCommand",
"params": [
{
"name": "cmd",
"description": "The command to pass: inserthtml, insertimage, bold",
"type": "String"
},
{
"name": "val",
"description": "The optional value of the command: Helvetica",
"type": "String"
}
],
"return": {
"description": "The Node or Nodelist affected by the command. Only returns on override commands, not browser defined commands.",
"type": "Node/NodeList"
},
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 596,
"description": "Get the YUI instance of the frame",
"itemtype": "method",
"name": "getInstance",
"return": {
"description": "The YUI instance bound to the frame.",
"type": "YUI"
},
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 604,
"description": "Renders the Y.Frame to the passed node.",
"itemtype": "method",
"name": "render",
"params": [
{
"name": "node",
"description": "The node to append the Editor to",
"type": "Selector/HTMLElement/Node"
}
],
"return": {
"description": "",
"type": "EditorBase"
},
"chainable": 1,
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 616,
"description": "Focus the contentWindow of the iframe",
"itemtype": "method",
"name": "focus",
"params": [
{
"name": "fn",
"description": "Callback function to execute after focus happens",
"type": "Function"
}
],
"return": {
"description": "",
"type": "EditorBase"
},
"chainable": 1,
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 627,
"description": "Handles the showing of the Editor instance. Currently only handles the iframe",
"itemtype": "method",
"name": "show",
"return": {
"description": "",
"type": "EditorBase"
},
"chainable": 1,
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 637,
"description": "Handles the hiding of the Editor instance. Currently only handles the iframe",
"itemtype": "method",
"name": "hide",
"return": {
"description": "",
"type": "EditorBase"
},
"chainable": 1,
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 647,
"description": "(Un)Filters the content of the Editor, cleaning YUI related code. //TODO better filtering",
"itemtype": "method",
"name": "getContent",
"return": {
"description": "The filtered content of the Editor",
"type": "String"
},
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 662,
"static": 1,
"itemtype": "method",
"name": "NORMALIZE_FONTSIZE",
"description": "Pulls the fontSize from a node, then checks for string values (x-large, x-small)\nand converts them to pixel sizes. If the parsed size is different from the original, it calls\nnode.setStyle to update the node with a pixel size for normalization.",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 700,
"static": 1,
"itemtype": "property",
"name": "TABKEY",
"description": "The HTML markup to use for the tabkey",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 706,
"static": 1,
"itemtype": "method",
"name": "FILTER_RGB",
"params": [
{
"name": "String",
"description": "css The CSS string containing rgb(#,#,#);"
}
],
"description": "Converts an RGB color string to a hex color, example: rgb(0, 255, 0) converts to #00ff00",
"return": {
"description": "String"
},
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 732,
"static": 1,
"itemtype": "property",
"name": "TAG2CMD",
"description": "A hash table of tags to their execcomand's",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 750,
"description": "Hash table of keys to fire a nodeChange event for.",
"static": 1,
"itemtype": "property",
"name": "NC_KEYS",
"type": "Object",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 771,
"description": "The default modules to use inside the Frame",
"static": 1,
"itemtype": "property",
"name": "USE",
"type": "Array",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 778,
"description": "The Class Name: editorBase",
"static": 1,
"itemtype": "property",
"name": "NAME",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 784,
"description": "Editor Strings. By default contains only the `title` property for the\nTitle of frame document (default \"Rich Text Editor\").",
"static": 1,
"itemtype": "property",
"name": "STRINGS",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 795,
"description": "The content to load into the Editor Frame",
"itemtype": "attribute",
"name": "content",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 820,
"description": "The value of the dir attribute on the HTML element of the frame. Default: ltr",
"itemtype": "attribute",
"name": "dir",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 828,
"itemtype": "attribute",
"name": "linkedcss",
"description": "An array of url's to external linked style sheets",
"type": "String",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 842,
"itemtype": "attribute",
"name": "extracss",
"description": "A string of CSS to add to the Head of the Editor",
"type": "String",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 856,
"itemtype": "attribute",
"name": "defaultblock",
"description": "The default tag to use for block level items, defaults to: p",
"type": "String",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 869,
"itemtype": "event",
"name": "nodeChange",
"description": "Fired from several mouse/key/paste event points.",
"params": [
{
"name": "event",
"description": "An Event Facade object with the following specific properties added:\n
\n - changedEvent
- The event that caused the nodeChange
\n - changedNode
- The node that was interacted with
\n - changedType
- The type of change: mousedown, mouseup, right, left, backspace, tab, enter, etc..
\n - commands
- The list of execCommands that belong to this change and the dompath that's associated with the changedNode
\n - classNames
- An array of classNames that are applied to the changedNode and all of it's parents
\n - dompath
- A sorted array of node instances that make up the DOM path from the changedNode to body.
\n - backgroundColor
- The cascaded backgroundColor of the changedNode
\n - fontColor
- The cascaded fontColor of the changedNode
\n - fontFamily
- The cascaded fontFamily of the changedNode
\n - fontSize
- The cascaded fontSize of the changedNode
\n
",
"type": "Event.Facade"
}
],
"type": "{Event.Custom}",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-base.js",
"line": 888,
"itemtype": "event",
"name": "ready",
"description": "Fired after the frame is ready.",
"params": [
{
"name": "event",
"description": "An Event Facade object.",
"type": "Event.Facade"
}
],
"type": "{Event.Custom}",
"class": "EditorBase",
"module": "editor",
"submodule": "editor-base"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 18,
"description": "Place holder for the last direction when checking for a switch",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "lastDirection",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 24,
"description": "Tells us that an initial bidi check has already been performed",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "firstEvent",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 31,
"description": "Method checks to see if the direction of the text has changed based on a nodeChange event.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_checkForChange",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 57,
"description": "Checked for a change after a specific nodeChange event has been fired.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_afterNodeChange",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 70,
"description": "Checks for a direction change after a mouseup occurs.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_afterMouseUp",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 88,
"description": "The events to check for a direction change on",
"itemtype": "property",
"name": "EVENTS",
"static": 1,
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 106,
"description": "More elements may be needed. BODY *must* be in the list to take care of the special case.\n\nblockParent could be changed to use inst.Selection.BLOCKS\ninstead, but that would make Y.Plugin.EditorBidi.blockParent\nunusable in non-RTE contexts (it being usable is a nice\nside-effect).",
"itemtype": "property",
"name": "BLOCKS",
"static": 1,
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 118,
"description": "Template for creating a block element",
"static": 1,
"itemtype": "property",
"name": "DIV_WRAPPER",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 124,
"description": "Returns a block parent for a given element",
"static": 1,
"itemtype": "method",
"name": "blockParent",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 160,
"description": "The data key to store on the node.",
"static": 1,
"itemtype": "property",
"name": "_NODE_SELECTED",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 166,
"description": "Generates a list of all the block parents of the current NodeList",
"static": 1,
"itemtype": "method",
"name": "addParents",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 212,
"description": "editorBidi",
"static": 1,
"itemtype": "property",
"name": "NAME",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 218,
"description": "editorBidi",
"static": 1,
"itemtype": "property",
"name": "NS",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 229,
"description": "Regex for testing/removing text-align style from an element",
"static": 1,
"itemtype": "property",
"name": "RE_TEXT_ALIGN",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 235,
"description": "Method to test a node's style attribute for text-align and removing it.",
"static": 1,
"itemtype": "method",
"name": "removeTextAlign",
"class": "Plugin.EditorBidi",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-bidi.js",
"line": 257,
"description": "bidi execCommand override for setting the text direction of a node.\nThis property is added to the `Y.Plugin.ExecCommands.COMMANDS`\ncollection.",
"itemtype": "property",
"name": "bidi",
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "editor-bidi"
},
{
"file": "lib/yui3/src/editor/js/editor-br.js",
"line": 19,
"description": "Frame keyDown handler that normalizes BR's when pressing ENTER.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onKeyDown",
"class": "Plugin.EditorBR",
"module": "editor",
"submodule": "editor-br"
},
{
"file": "lib/yui3/src/editor/js/editor-br.js",
"line": 52,
"description": "Adds listeners for keydown in IE and Webkit. Also fires insertbeonreturn for supporting browsers.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_afterEditorReady",
"class": "Plugin.EditorBR",
"module": "editor",
"submodule": "editor-br"
},
{
"file": "lib/yui3/src/editor/js/editor-br.js",
"line": 67,
"description": "Adds a nodeChange listener only for FF, in the event of a backspace or delete, it creates an empy textNode\ninserts it into the DOM after the e.changedNode, then removes it. Causing FF to redraw the content.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onNodeChange",
"params": [
{
"name": "e",
"description": "The nodeChange event.",
"type": "Event"
}
],
"class": "Plugin.EditorBR",
"module": "editor",
"submodule": "editor-br"
},
{
"file": "lib/yui3/src/editor/js/editor-br.js",
"line": 105,
"description": "editorBR",
"static": 1,
"itemtype": "property",
"name": "NAME",
"class": "Plugin.EditorBR",
"module": "editor",
"submodule": "editor-br"
},
{
"file": "lib/yui3/src/editor/js/editor-br.js",
"line": 111,
"description": "editorBR",
"static": 1,
"itemtype": "property",
"name": "NS",
"class": "Plugin.EditorBR",
"module": "editor",
"submodule": "editor-br"
},
{
"file": "lib/yui3/src/editor/js/editor-para.js",
"line": 19,
"description": "Utility method to create an empty paragraph when the document is empty.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_fixFirstPara",
"class": "Plugin.EditorPara",
"module": "editor",
"submodule": "editor-para"
},
{
"file": "lib/yui3/src/editor/js/editor-para.js",
"line": 43,
"description": "nodeChange handler to handle fixing an empty document.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onNodeChange",
"class": "Plugin.EditorPara",
"module": "editor",
"submodule": "editor-para"
},
{
"file": "lib/yui3/src/editor/js/editor-para.js",
"line": 294,
"description": "Performs a block element filter when the Editor is first ready",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_afterEditorReady",
"class": "Plugin.EditorPara",
"module": "editor",
"submodule": "editor-para"
},
{
"file": "lib/yui3/src/editor/js/editor-para.js",
"line": 308,
"description": "Performs a block element filter when the Editor after an content change",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_afterContentChange",
"class": "Plugin.EditorPara",
"module": "editor",
"submodule": "editor-para"
},
{
"file": "lib/yui3/src/editor/js/editor-para.js",
"line": 319,
"description": "Performs block/paste filtering after paste.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_afterPaste",
"class": "Plugin.EditorPara",
"module": "editor",
"submodule": "editor-para"
},
{
"file": "lib/yui3/src/editor/js/editor-para.js",
"line": 348,
"description": "editorPara",
"static": 1,
"itemtype": "property",
"name": "NAME",
"class": "Plugin.EditorPara",
"module": "editor",
"submodule": "editor-para"
},
{
"file": "lib/yui3/src/editor/js/editor-para.js",
"line": 354,
"description": "editorPara",
"static": 1,
"itemtype": "property",
"name": "NS",
"class": "Plugin.EditorPara",
"module": "editor",
"submodule": "editor-para"
},
{
"file": "lib/yui3/src/editor/js/editor-tab.js",
"line": 16,
"description": "Listener for host's nodeChange event and captures the tabkey interaction.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onNodeChange",
"params": [
{
"name": "e",
"description": "The Event facade passed from the host.",
"type": "Event"
}
],
"class": "Plugin.EditorTab",
"module": "editor",
"submodule": "editor-tab"
},
{
"file": "lib/yui3/src/editor/js/editor-tab.js",
"line": 42,
"description": "editorTab",
"itemtype": "property",
"name": "NAME",
"static": 1,
"class": "Plugin.EditorTab",
"module": "editor",
"submodule": "editor-tab"
},
{
"file": "lib/yui3/src/editor/js/editor-tab.js",
"line": 48,
"description": "tab",
"itemtype": "property",
"name": "NS",
"static": 1,
"class": "Plugin.EditorTab",
"module": "editor",
"submodule": "editor-tab"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 15,
"description": "An internal reference to the keyCode of the last key that was pressed.",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_lastKey",
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 21,
"description": "An internal reference to the instance of the frame plugged into.",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_inst",
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 27,
"description": "Execute a command on the frame's document.",
"itemtype": "method",
"name": "command",
"params": [
{
"name": "action",
"description": "The action to perform (bold, italic, fontname)",
"type": "String"
},
{
"name": "value",
"description": "The optional value (helvetica)",
"type": "String"
}
],
"return": {
"description": "Should return the Node/Nodelist affected",
"type": "Node/NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 45,
"description": "The private version of execCommand that doesn't filter for overrides.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_command",
"params": [
{
"name": "action",
"description": "The action to perform (bold, italic, fontname)",
"type": "String"
},
{
"name": "value",
"description": "The optional value (helvetica)",
"type": "String"
}
],
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 69,
"description": "Get's the instance of YUI bound to the parent frame",
"itemtype": "method",
"name": "getInstance",
"return": {
"description": "The YUI instance bound to the parent frame",
"type": "YUI"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 95,
"description": "execCommand",
"itemtype": "property",
"name": "NAME",
"static": 1,
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 101,
"description": "exec",
"itemtype": "property",
"name": "NS",
"static": 1,
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 112,
"description": "Static object literal of execCommand overrides",
"itemtype": "property",
"name": "COMMANDS",
"static": 1,
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 118,
"description": "Wraps the content with a new element of type (tag)",
"itemtype": "method",
"name": "COMMANDS.wrap",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: wrap",
"type": "String"
},
{
"name": "tag",
"description": "The tag to wrap the selection with",
"type": "String"
}
],
"return": {
"description": "NodeList of the items touched by this command.",
"type": "NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 130,
"description": "Inserts the provided HTML at the cursor, should be a single element.",
"itemtype": "method",
"name": "COMMANDS.inserthtml",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: inserthtml",
"type": "String"
},
{
"name": "html",
"description": "The html to insert",
"type": "String"
}
],
"return": {
"description": "Node instance of the item touched by this command.",
"type": "Node"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 146,
"description": "Inserts the provided HTML at the cursor, and focuses the cursor afterwards.",
"itemtype": "method",
"name": "COMMANDS.insertandfocus",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: insertandfocus",
"type": "String"
},
{
"name": "html",
"description": "The html to insert",
"type": "String"
}
],
"return": {
"description": "Node instance of the item touched by this command.",
"type": "Node"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 166,
"description": "Inserts a BR at the current cursor position",
"itemtype": "method",
"name": "COMMANDS.insertbr",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: insertbr",
"type": "String"
}
],
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 213,
"description": "Inserts an image at the cursor position",
"itemtype": "method",
"name": "COMMANDS.insertimage",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: insertimage",
"type": "String"
},
{
"name": "img",
"description": "The url of the image to be inserted",
"type": "String"
}
],
"return": {
"description": "Node instance of the item touched by this command.",
"type": "Node"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 224,
"description": "Add a class to all of the elements in the selection",
"itemtype": "method",
"name": "COMMANDS.addclass",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: addclass",
"type": "String"
},
{
"name": "cls",
"description": "The className to add",
"type": "String"
}
],
"return": {
"description": "NodeList of the items touched by this command.",
"type": "NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 236,
"description": "Remove a class from all of the elements in the selection",
"itemtype": "method",
"name": "COMMANDS.removeclass",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: removeclass",
"type": "String"
},
{
"name": "cls",
"description": "The className to remove",
"type": "String"
}
],
"return": {
"description": "NodeList of the items touched by this command.",
"type": "NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 248,
"description": "Adds a forecolor to the current selection, or creates a new element and applies it",
"itemtype": "method",
"name": "COMMANDS.forecolor",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: forecolor",
"type": "String"
},
{
"name": "val",
"description": "The color value to apply",
"type": "String"
}
],
"return": {
"description": "NodeList of the items touched by this command.",
"type": "NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 280,
"description": "Adds a background color to the current selection, or creates a new element and applies it",
"itemtype": "method",
"name": "COMMANDS.backcolor",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: backcolor",
"type": "String"
},
{
"name": "val",
"description": "The color value to apply",
"type": "String"
}
],
"return": {
"description": "NodeList of the items touched by this command.",
"type": "NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 315,
"description": "Sugar method, calles backcolor",
"itemtype": "method",
"name": "COMMANDS.hilitecolor",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: backcolor",
"type": "String"
},
{
"name": "val",
"description": "The color value to apply",
"type": "String"
}
],
"return": {
"description": "NodeList of the items touched by this command.",
"type": "NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 326,
"description": "Adds a font name to the current selection, or creates a new element and applies it",
"itemtype": "method",
"name": "COMMANDS.fontname2",
"deprecated": true,
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: fontname",
"type": "String"
},
{
"name": "val",
"description": "The font name to apply",
"type": "String"
}
],
"return": {
"description": "NodeList of the items touched by this command.",
"type": "NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 346,
"description": "Adds a fontsize to the current selection, or creates a new element and applies it",
"itemtype": "method",
"name": "COMMANDS.fontsize2",
"deprecated": true,
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: fontsize",
"type": "String"
},
{
"name": "val",
"description": "The font size to apply",
"type": "String"
}
],
"return": {
"description": "NodeList of the items touched by this command.",
"type": "NodeList"
},
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 377,
"description": "Overload for COMMANDS.list",
"itemtype": "method",
"name": "COMMANDS.insertorderedlist",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: list, ul",
"type": "String"
}
],
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 386,
"description": "Overload for COMMANDS.list",
"itemtype": "method",
"name": "COMMANDS.insertunorderedlist",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: list, ol",
"type": "String"
}
],
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 395,
"description": "Noramlizes lists creation/destruction for IE. All others pass through to native calls",
"itemtype": "method",
"name": "COMMANDS.list",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: list (not used)",
"type": "String"
},
{
"name": "tag",
"description": "The tag to deal with",
"type": "String"
}
],
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 577,
"description": "Noramlizes alignment for Webkit Browsers",
"itemtype": "method",
"name": "COMMANDS.justify",
"static": 1,
"params": [
{
"name": "cmd",
"description": "The command executed: justify (not used)",
"type": "String"
},
{
"name": "val",
"description": "The actual command from the justify{center,all,left,right} stubs",
"type": "String"
}
],
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 603,
"description": "Override method for COMMANDS.justify",
"itemtype": "method",
"name": "COMMANDS.justifycenter",
"static": 1,
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 611,
"description": "Override method for COMMANDS.justify",
"itemtype": "method",
"name": "COMMANDS.justifyleft",
"static": 1,
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 619,
"description": "Override method for COMMANDS.justify",
"itemtype": "method",
"name": "COMMANDS.justifyright",
"static": 1,
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 627,
"description": "Override method for COMMANDS.justify",
"itemtype": "method",
"name": "COMMANDS.justifyfull",
"static": 1,
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/exec-command.js",
"line": 638,
"description": "This method is meant to normalize IE's in ability to exec the proper command on elements with CSS styling.",
"itemtype": "method",
"name": "fixIETags",
"access": "protected",
"tagname": "",
"params": [
{
"name": "cmd",
"description": "The command to execute",
"type": "String"
},
{
"name": "tag",
"description": "The tag to create",
"type": "String"
},
{
"name": "rule",
"description": "The rule that we are looking for.",
"type": "String"
}
],
"class": "Plugin.ExecCommand",
"module": "editor",
"submodule": "exec-command"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 19,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_ready",
"description": "Internal reference set when the content is ready.",
"type": "Boolean",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 26,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_rendered",
"description": "Internal reference set when render is called.",
"type": "Boolean",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 33,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_iframe",
"description": "Internal Node reference to the iFrame or the window",
"type": "Node",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 40,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_instance",
"description": "Internal reference to the YUI instance bound to the iFrame or window",
"type": "YUI",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 47,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_create",
"description": "Create the iframe or Window and get references to the Document & Window",
"return": {
"description": "Hash table containing references to the new Document & Window",
"type": "Object"
},
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 111,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_resolveWinDoc",
"description": "Resolves the document and window from an iframe or window instance",
"params": [
{
"name": "c",
"description": "The YUI Config to add the window and document to",
"type": "Object"
}
],
"return": {
"description": "Object hash of window and document references, if a YUI config was passed, it is returned.",
"type": "Object"
},
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 130,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onDomEvent",
"description": "Generic handler for all DOM events fired by the iframe or window. This handler\ntakes the current EventFacade and augments it to fire on the Frame host. It adds two new properties\nto the EventFacade called frameX and frameY which adds the scroll and xy position of the iframe\nto the original pageX and pageY of the event so external nodes can be positioned over the frame.",
"params": [
{
"name": "e",
"description": "",
"type": "Event.Facade"
}
],
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 178,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_DOMPaste",
"description": "Simple pass thru handler for the paste event so we can do content cleanup",
"params": [
{
"name": "e",
"description": "",
"type": "Event.Facade"
}
],
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 224,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_defReadyFn",
"description": "Binds DOM events, sets the iframe to visible and fires the ready event",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 270,
"description": "It appears that having a BR tag anywhere in the source \"below\" a table with a percentage width (in IE 7 & 8)\nif there is any TEXTINPUT's outside the iframe, the cursor will rapidly flickr and the CPU would occasionally \nspike. This method finds all
's below the sourceIndex of the first table. Does some checks to see if they\ncan be modified and replaces then with a
so the layout will remain in tact, but the flickering will\nno longer happen.",
"itemtype": "method",
"name": "_fixIECursors",
"access": "private",
"tagname": "",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 310,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onContentReady",
"description": "Called once the content is available in the frame/window and calls the final use call\non the internal instance so that the modules are loaded properly.",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 353,
"description": "Internal method to set the height of the body to the height of the document in IE.\nWith contenteditable being set, the document becomes unresponsive to clicks, this \nmethod expands the body to be the height of the document so that doesn't happen.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_ieSetBodyHeight",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 400,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_resolveBaseHref",
"description": "Resolves the basehref of the page the frame is created on. Only applies to dynamic content.",
"params": [
{
"name": "href",
"description": "The new value to use, if empty it will be resolved from the current url.",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 417,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getHTML",
"description": "Get the content from the iframe",
"params": [
{
"name": "html",
"description": "The raw HTML from the body of the iframe.",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 431,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setHTML",
"description": "Set the content of the iframe",
"params": [
{
"name": "html",
"description": "The raw HTML to set the body of the iframe to.",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 451,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setLinkedCSS",
"description": "Set's the linked CSS on the instance..",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 472,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setLinkedCSS",
"description": "Set's the linked CSS on the instance..",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 484,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_setExtraCSS",
"description": "Set's the extra CSS on the instance..",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 499,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_instanceLoaded",
"description": "Called from the first YUI instance that sets up the internal instance.\nThis loads the content into the window/frame and attaches the contentready event.",
"params": [
{
"name": "inst",
"description": "The internal YUI instance bound to the frame/window",
"type": "YUI"
}
],
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 523,
"itemtype": "method",
"name": "use",
"description": "This is a scoped version of the normal YUI.use method & is bound to this frame/window.\nAt setup, the inst.use method is mapped to this method.",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 546,
"itemtype": "method",
"name": "delegate",
"description": "A delegate method passed to the instance's delegate method",
"params": [
{
"name": "type",
"description": "The type of event to listen for",
"type": "String"
},
{
"name": "fn",
"description": "The method to attach",
"type": "Function"
},
{
"name": "cont",
"description": "The container to act as a delegate, if no \"sel\" passed, the body is assumed as the container.",
"type": "String"
},
{
"name": "sel",
"description": "The selector to match in the event (optional)",
"type": "String"
}
],
"return": {
"description": "The Event handle returned from Y.delegate",
"type": "EventHandle"
},
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 567,
"itemtype": "method",
"name": "getInstance",
"description": "Get a reference to the internal YUI instance.",
"return": {
"description": "The internal YUI instance",
"type": "YUI"
},
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 575,
"itemtype": "method",
"name": "render",
"description": "Render the iframe into the container config option or open the window.",
"params": [
{
"name": "node",
"description": "The node to render to",
"type": "String/HTMLElement/Node"
}
],
"return": {
"description": "",
"type": "Frame"
},
"chainable": 1,
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 636,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_handleFocus",
"description": "Does some tricks on focus to set the proper cursor position.",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 683,
"itemtype": "method",
"name": "focus",
"description": "Set the focus to the iframe",
"params": [
{
"name": "fn",
"description": "Callback function to execute after focus happens",
"type": "Function"
}
],
"return": {
"description": "",
"type": "Frame"
},
"chainable": 1,
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 722,
"itemtype": "method",
"name": "show",
"description": "Show the iframe instance",
"return": {
"description": "",
"type": "Frame"
},
"chainable": 1,
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 741,
"itemtype": "method",
"name": "hide",
"description": "Hide the iframe instance",
"return": {
"description": "",
"type": "Frame"
},
"chainable": 1,
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 755,
"static": 1,
"itemtype": "property",
"name": "THROTTLE_TIME",
"description": "The throttle time for key events in IE",
"type": "Number",
"default": "100",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 763,
"static": 1,
"itemtype": "property",
"name": "DOM_EVENTS",
"description": "The DomEvents that the frame automatically attaches and bubbles",
"type": "Object",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 785,
"static": 1,
"itemtype": "property",
"name": "DEFAULT_CSS",
"description": "The default css used when creating the document.",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 793,
"static": 1,
"itemtype": "property",
"name": "HTML",
"description": "The template string used to create the iframe",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 801,
"static": 1,
"itemtype": "property",
"name": "PAGE_HTML",
"description": "The template used to create the page when created dynamically.",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 809,
"static": 1,
"itemtype": "method",
"name": "getDocType",
"description": "Parses document.doctype and generates a DocType to match the parent page, if supported.\nFor IE8, it grabs document.all[0].nodeValue and uses that. For IE < 8, it falls back to Frame.DOC_TYPE.",
"return": {
"description": "The normalized DocType to apply to the iframe",
"type": "String"
},
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 838,
"static": 1,
"itemtype": "property",
"name": "DOC_TYPE",
"description": "The DOCTYPE to prepend to the new document when created. Should match the one on the page being served.",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 845,
"static": 1,
"itemtype": "property",
"name": "META",
"description": "The meta-tag for Content-Type to add to the dynamic document",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 853,
"static": 1,
"itemtype": "property",
"name": "NAME",
"description": "The name of the class (frame)",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 861,
"itemtype": "attribute",
"name": "title",
"description": "The title to give the blank page.",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 869,
"itemtype": "attribute",
"name": "dir",
"description": "The default text direction for this new frame. Default: ltr",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 877,
"itemtype": "attribute",
"name": "lang",
"description": "The default language. Default: en-US",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 885,
"itemtype": "attribute",
"name": "src",
"description": "The src of the iframe/window. Defaults to javascript:;",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 894,
"itemtype": "attribute",
"name": "designMode",
"description": "Should designMode be turned on after creation.",
"writeonce": "",
"type": "Boolean",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 904,
"itemtype": "attribute",
"name": "content",
"description": "The string to inject into the body of the new frame/window.",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 914,
"itemtype": "attribute",
"name": "basehref",
"description": "The base href to use in the iframe.",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 923,
"itemtype": "attribute",
"name": "use",
"description": "Array of modules to include in the scoped YUI instance at render time. Default: ['none', 'selector-css2']",
"writeonce": "",
"type": "Array",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 933,
"itemtype": "attribute",
"name": "container",
"description": "The container to append the iFrame to on render.",
"type": "String/HTMLElement/Node",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 944,
"itemtype": "attribute",
"name": "node",
"description": "The Node instance of the iframe.",
"type": "Node",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 956,
"itemtype": "attribute",
"name": "id",
"description": "Set the id of the new Node. (optional)",
"type": "String",
"writeonce": "",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 971,
"itemtype": "attribute",
"name": "linkedcss",
"description": "An array of url's to external linked style sheets",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 981,
"itemtype": "attribute",
"name": "extracss",
"description": "A string of CSS to add to the Head of the Editor",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 990,
"itemtype": "attribute",
"name": "host",
"description": "A reference to the Editor instance",
"type": "Object",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/frame.js",
"line": 998,
"itemtype": "attribute",
"name": "defaultblock",
"description": "The default tag to use for block level items, defaults to: p",
"type": "String",
"class": "Frame",
"module": "editor",
"submodule": "frame"
},
{
"file": "lib/yui3/src/editor/js/lists.js",
"line": 16,
"description": "Listener for host's nodeChange event and captures the tabkey interaction only when inside a list node.",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_onNodeChange",
"params": [
{
"name": "e",
"description": "The Event facade passed from the host.",
"type": "Event"
}
],
"class": "Plugin.EditorLists",
"module": "editor",
"submodule": "editor-lists"
},
{
"file": "lib/yui3/src/editor/js/lists.js",
"line": 80,
"description": "The non element placeholder, used for positioning the cursor and filling empty items",
"itemtype": "property",
"name": "REMOVE",
"static": 1,
"class": "Plugin.EditorLists",
"module": "editor",
"submodule": "editor-lists"
},
{
"file": "lib/yui3/src/editor/js/lists.js",
"line": 86,
"description": "The selector query to get all non elements",
"itemtype": "property",
"name": "NONSEL",
"static": 1,
"class": "Plugin.EditorLists",
"module": "editor",
"submodule": "editor-lists"
},
{
"file": "lib/yui3/src/editor/js/lists.js",
"line": 92,
"description": "The items to removed from a list when a list item is moved, currently removes BR nodes",
"itemtype": "property",
"name": "REMOVE",
"static": 1,
"class": "Plugin.EditorLists",
"module": "editor",
"submodule": "editor-lists"
},
{
"file": "lib/yui3/src/editor/js/lists.js",
"line": 98,
"description": "editorLists",
"itemtype": "property",
"name": "NAME",
"static": 1,
"class": "Plugin.EditorLists",
"module": "editor",
"submodule": "editor-lists"
},
{
"file": "lib/yui3/src/editor/js/lists.js",
"line": 104,
"description": "lists",
"itemtype": "property",
"name": "NS",
"static": 1,
"class": "Plugin.EditorLists",
"module": "editor",
"submodule": "editor-lists"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 119,
"description": "Utility method to remove dead font-family styles from an element.",
"static": 1,
"itemtype": "method",
"name": "removeFontFamily",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 136,
"description": "Performs a prefilter on all nodes in the editor. Looks for nodes with a style: fontFamily or font face\nIt then creates a dynamic class assigns it and removed the property. This is so that we don't lose\nthe fontFamily when selecting nodes.",
"static": 1,
"itemtype": "method",
"name": "filter",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 241,
"description": "Method attempts to replace all \"orphined\" text nodes in the main body by wrapping them with a . Called from filter.",
"static": 1,
"itemtype": "method",
"name": "filterBlocks",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 344,
"description": "Regular Expression used to find dead font-family styles",
"static": 1,
"itemtype": "property",
"name": "REG_FONTFAMILY",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 351,
"description": "Regular Expression to determine if a string has a character in it",
"static": 1,
"itemtype": "property",
"name": "REG_CHAR",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 358,
"description": "Regular Expression to determine if a string has a non-character in it",
"static": 1,
"itemtype": "property",
"name": "REG_NON",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 365,
"description": "Regular Expression to remove all HTML from a string",
"static": 1,
"itemtype": "property",
"name": "REG_NOHTML",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 373,
"description": "Wraps an array of elements in a Block level tag",
"static": 1,
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_wrapBlock",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 393,
"description": "Undoes what filter does enough to return the HTML from the Editor, then re-applies the filter.",
"static": 1,
"itemtype": "method",
"name": "unfilter",
"return": {
"description": "The filtered HTML",
"type": "String"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 452,
"description": "Resolve a node from the selection object and return a Node instance",
"static": 1,
"itemtype": "method",
"name": "resolve",
"params": [
{
"name": "n",
"description": "The HTMLElement to resolve. Might be a TextNode, gives parentNode.",
"type": "HTMLElement"
}
],
"return": {
"description": "The Resolved node",
"type": "Node"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 473,
"description": "Returns the innerHTML of a node with all HTML tags removed.",
"static": 1,
"itemtype": "method",
"name": "getText",
"params": [
{
"name": "node",
"description": "The Node instance to remove the HTML from",
"type": "Node"
}
],
"return": {
"description": "The string of text",
"type": "String"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 490,
"description": "The selector to use when looking for Nodes to cache the value of: [style],font[face]",
"static": 1,
"itemtype": "property",
"name": "ALL",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 497,
"description": "The selector to use when looking for block level items.",
"static": 1,
"itemtype": "property",
"name": "BLOCKS",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 503,
"description": "The temporary fontname applied to a selection to retrieve their values: yui-tmp",
"static": 1,
"itemtype": "property",
"name": "TMP",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 509,
"description": "The default tag to use when creating elements: span",
"static": 1,
"itemtype": "property",
"name": "DEFAULT_TAG",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 516,
"description": "The id of the outer cursor wrapper",
"static": 1,
"itemtype": "property",
"name": "DEFAULT_TAG",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 523,
"description": "The id used to wrap the inner space of the cursor position",
"static": 1,
"itemtype": "property",
"name": "CUR_WRAPID",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 530,
"description": "The default HTML used to focus the cursor..",
"static": 1,
"itemtype": "property",
"name": "CURSOR",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 543,
"description": "Called from Editor keydown to remove the \"extra\" space before the cursor.",
"static": 1,
"itemtype": "method",
"name": "cleanCursor",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 581,
"description": "Range text value",
"itemtype": "property",
"name": "text",
"type": "String",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 587,
"description": "Flag to show if the range is collapsed or not",
"itemtype": "property",
"name": "isCollapsed",
"type": "Boolean",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 593,
"description": "A Node instance of the parentNode of the anchorNode of the range",
"itemtype": "property",
"name": "anchorNode",
"type": "Node",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 599,
"description": "The offset from the range object",
"itemtype": "property",
"name": "anchorOffset",
"type": "Number",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 605,
"description": "A Node instance of the actual textNode of the range.",
"itemtype": "property",
"name": "anchorTextNode",
"type": "Node",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 611,
"description": "A Node instance of the parentNode of the focusNode of the range",
"itemtype": "property",
"name": "focusNode",
"type": "Node",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 617,
"description": "The offset from the range object",
"itemtype": "property",
"name": "focusOffset",
"type": "Number",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 623,
"description": "A Node instance of the actual textNode of the range.",
"itemtype": "property",
"name": "focusTextNode",
"type": "Node",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 629,
"description": "The actual Selection/Range object",
"itemtype": "property",
"name": "_selection",
"access": "private",
"tagname": "",
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 635,
"description": "Wrap an element, with another element",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_wrap",
"params": [
{
"name": "n",
"description": "The node to wrap",
"type": "HTMLElement"
},
{
"name": "tag",
"description": "The tag to use when creating the new element.",
"type": "String"
}
],
"return": {
"description": "The wrapped node",
"type": "HTMLElement"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 650,
"description": "Swap an element, with another element",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_swap",
"params": [
{
"name": "n",
"description": "The node to swap",
"type": "HTMLElement"
},
{
"name": "tag",
"description": "The tag to use when creating the new element.",
"type": "String"
}
],
"return": {
"description": "The new node",
"type": "HTMLElement"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 664,
"description": "Get all the nodes in the current selection. This method will actually perform a filter first.\nThen it calls doc.execCommand('fontname', null, 'yui-tmp') to touch all nodes in the selection.\nThe it compiles a list of all nodes affected by the execCommand and builds a NodeList to return.",
"itemtype": "method",
"name": "getSelected",
"return": {
"description": "A NodeList of all items in the selection.",
"type": "NodeList"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 688,
"description": "Insert HTML at the current cursor position and return a Node instance of the newly inserted element.",
"itemtype": "method",
"name": "insertContent",
"params": [
{
"name": "html",
"description": "The HTML to insert.",
"type": "String"
}
],
"return": {
"description": "The inserted Node.",
"type": "Node"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 697,
"description": "Insert HTML at the current cursor position, this method gives you control over the text node to insert into and the offset where to put it.",
"itemtype": "method",
"name": "insertAtCursor",
"params": [
{
"name": "html",
"description": "The HTML to insert.",
"type": "String"
},
{
"name": "node",
"description": "The text node to break when inserting.",
"type": "Node"
},
{
"name": "offset",
"description": "The left offset of the text node to break and insert the new content.",
"type": "Number"
},
{
"name": "collapse",
"description": "Should the range be collapsed after insertion. default: false",
"type": "Boolean"
}
],
"return": {
"description": "The inserted Node.",
"type": "Node"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 806,
"description": "Get all elements inside a selection and wrap them with a new element and return a NodeList of all elements touched.",
"itemtype": "method",
"name": "wrapContent",
"params": [
{
"name": "tag",
"description": "The tag to wrap all selected items with.",
"type": "String"
}
],
"return": {
"description": "A NodeList of all items in the selection.",
"type": "NodeList"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 857,
"description": "Find and replace a string inside a text node and replace it with HTML focusing the node after \nto allow you to continue to type.",
"itemtype": "method",
"name": "replace",
"params": [
{
"name": "se",
"description": "The string to search for.",
"type": "String"
},
{
"name": "re",
"description": "The string of HTML to replace it with.",
"type": "String"
}
],
"return": {
"description": "The node inserted.",
"type": "Node"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 886,
"description": "Destroy the range.",
"itemtype": "method",
"name": "remove",
"chainable": 1,
"return": {
"description": "",
"type": "Selection"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 896,
"description": "Wrapper for the different range creation methods.",
"itemtype": "method",
"name": "createRange",
"return": {
"description": "",
"type": "RangeObject"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 908,
"description": "Select a Node (hilighting it).",
"itemtype": "method",
"name": "selectNode",
"params": [
{
"name": "node",
"description": "The node to select",
"type": "Node"
},
{
"name": "collapse",
"description": "Should the range be collapsed after insertion. default: false",
"type": "Boolean"
}
],
"chainable": 1,
"return": {
"description": "",
"type": "Selection"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 949,
"description": "Put a placeholder in the DOM at the current cursor position.",
"itemtype": "method",
"name": "setCursor",
"return": {
"description": "",
"type": "Node"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 958,
"description": "Get the placeholder in the DOM at the current cursor position.",
"itemtype": "method",
"name": "getCursor",
"return": {
"description": "",
"type": "Node"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 966,
"description": "Remove the cursor placeholder from the DOM.",
"itemtype": "method",
"name": "removeCursor",
"params": [
{
"name": "keep",
"description": "Setting this to true will keep the node, but remove the unique parts that make it the cursor.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Node"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 984,
"description": "Gets a stored cursor and focuses it for editing, must be called sometime after setCursor",
"itemtype": "method",
"name": "focusCursor",
"return": {
"description": "",
"type": "Node"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/editor/js/selection.js",
"line": 1003,
"description": "Generic toString for logging.",
"itemtype": "method",
"name": "toString",
"return": {
"description": "",
"type": "String"
},
"class": "Selection",
"module": "editor",
"submodule": "selection"
},
{
"file": "lib/yui3/src/escape/js/escape.js",
"line": 23,
"description": "Returns a copy of the specified string with special HTML characters\nescaped. The following characters will be converted to their\ncorresponding character entities:\n\n & < > \" ' / `\n\nThis implementation is based on the [OWASP HTML escaping\nrecommendations][1]. In addition to the characters in the OWASP\nrecommendations, we also escape the ` character, since IE\ninterprets it as an attribute delimiter.\n\nIf _string_ is not already a string, it will be coerced to a string.\n\n[1]: http://www.owasp.org/index.php/XSS_(Cross_Site_Scripting)_Prevention_Cheat_Sheet",
"itemtype": "method",
"name": "html",
"params": [
{
"name": "string",
"description": "String to escape.",
"type": "String"
}
],
"return": {
"description": "Escaped string.",
"type": "String"
},
"static": 1,
"class": "Escape",
"module": "escape"
},
{
"file": "lib/yui3/src/escape/js/escape.js",
"line": 48,
"description": "Returns a copy of the specified string with special regular expression\ncharacters escaped, allowing the string to be used safely inside a regex.\nThe following characters, and all whitespace characters, are escaped:\n\n - # $ ^ * ( ) + [ ] { } | \\ , . ?\n\nIf _string_ is not already a string, it will be coerced to a string.",
"itemtype": "method",
"name": "regex",
"params": [
{
"name": "string",
"description": "String to escape.",
"type": "String"
}
],
"return": {
"description": "Escaped string.",
"type": "String"
},
"static": 1,
"class": "Escape",
"module": "escape"
},
{
"file": "lib/yui3/src/escape/js/escape.js",
"line": 68,
"description": "Regex replacer for HTML escaping.",
"itemtype": "method",
"name": "_htmlReplacer",
"params": [
{
"name": "match",
"description": "Matched character (must exist in HTML_CHARS).",
"type": "String"
}
],
"return": {
"description": "HTML entity.",
"type": "String"
},
"static": 1,
"access": "protected",
"tagname": "",
"class": "Escape",
"module": "escape"
},
{
"file": "lib/yui3/src/event/js/available.js",
"line": 8,
"description": "Executes the callback as soon as the specified element\nis detected in the DOM. This function expects a selector\nstring for the element(s) to detect. If you already have\nan element reference, you don't need this event.",
"itemtype": "event",
"name": "available",
"params": [
{
"name": "type",
"description": "'available'",
"type": "String"
},
{
"name": "fn",
"description": "the callback function to execute.",
"type": "Function"
},
{
"name": "el",
"description": "an selector for the element(s) to attach",
"type": "String"
},
{
"name": "context",
"description": "optional argument that specifies what 'this' refers to."
},
{
"name": "args",
"description": "0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object.",
"multiple": true
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/available.js",
"line": 30,
"description": "Executes the callback as soon as the specified element\nis detected in the DOM with a nextSibling property\n(indicating that the element's children are available).\nThis function expects a selector\nstring for the element(s) to detect. If you already have\nan element reference, you don't need this event.",
"itemtype": "event",
"name": "contentready",
"params": [
{
"name": "type",
"description": "'contentready'",
"type": "String"
},
{
"name": "fn",
"description": "the callback function to execute.",
"type": "Function"
},
{
"name": "el",
"description": "an selector for the element(s) to attach.",
"type": "String"
},
{
"name": "context",
"description": "optional argument that specifies what 'this' refers to."
},
{
"name": "args",
"description": "0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object.",
"multiple": true
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/delegate.js",
"line": 16,
"description": "
Sets up event delegation on a container element. The delegated event\nwill use a supplied selector or filtering function to test if the event\nreferences at least one node that should trigger the subscription\ncallback.
\n\nSelector string filters will trigger the callback if the event originated\nfrom a node that matches it or is contained in a node that matches it.\nFunction filters are called for each Node up the parent axis to the\nsubscribing container node, and receive at each level the Node and the event\nobject. The function should return true (or a truthy value) if that Node\nshould trigger the subscription callback. Note, it is possible for filters\nto match multiple Nodes for a single event. In this case, the delegate\ncallback will be executed for each matching Node.
\n\nFor each matching Node, the callback will be executed with its 'this'\nobject set to the Node matched by the filter (unless a specific context was\nprovided during subscription), and the provided event's\ncurrentTarget will also be set to the matching Node. The\ncontaining Node from which the subscription was originally made can be\nreferenced as e.container.",
"itemtype": "method",
"name": "delegate",
"params": [
{
"name": "type",
"description": "the event type to delegate",
"type": "String"
},
{
"name": "fn",
"description": "the callback function to execute. This function\n will be provided the event object for the delegated event.",
"type": "Function"
},
{
"name": "el",
"description": "the element that is the delegation container",
"type": "String|node"
},
{
"name": "spec",
"description": "a selector that must match the target of the\n event or a function to test target and its parents for a match",
"type": "String|Function"
},
{
"name": "context",
"description": "optional argument that specifies what 'this' refers to."
},
{
"name": "args",
"description": "0..n additional arguments to pass on to the callback function.\n These arguments will be added after the event object.",
"multiple": true
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event",
"submodule": "event-delegate"
},
{
"file": "lib/yui3/src/event/js/delegate.js",
"line": 128,
"description": "Overrides the _notify method on the normal DOM subscription to\ninject the filtering logic and only proceed in the case of a match.\n\nThis method is hosted as a private property of the `delegate` method\n(e.g. `Y.delegate.notifySub`)",
"itemtype": "method",
"name": "notifySub",
"params": [
{
"name": "thisObj",
"description": "default 'this' object for the callback",
"type": "Object"
},
{
"name": "args",
"description": "arguments passed to the event's fire()",
"type": "Array"
},
{
"name": "ce",
"description": "the custom event managing the DOM subscriptions for\n the subscribed event on the subscribing node.",
"type": "CustomEvent"
}
],
"return": {
"description": "false if the event was stopped",
"type": "Boolean"
},
"access": "private",
"tagname": "",
"static": 1,
"since": "3.2.0",
"class": "YUI",
"module": "event",
"submodule": "event-delegate"
},
{
"file": "lib/yui3/src/event/js/delegate.js",
"line": 182,
"description": "Compiles a selector string into a filter function to identify whether\nNodes along the parent axis of an event's target should trigger event\nnotification.\n\nThis function is memoized, so previously compiled filter functions are\nreturned if the same selector string is provided.\n\nThis function may be useful when defining synthetic events for delegate\nhandling.\n\nHosted as a property of the `delegate` method (e.g. `Y.delegate.compileFilter`).",
"itemtype": "method",
"name": "compileFilter",
"params": [
{
"name": "selector",
"description": "the selector string to base the filtration on",
"type": "String"
}
],
"return": {
"description": "",
"type": "Function"
},
"since": "3.2.0",
"static": 1,
"class": "YUI",
"module": "event",
"submodule": "event-delegate"
},
{
"file": "lib/yui3/src/event/js/delegate.js",
"line": 207,
"description": "Walks up the parent axis of an event's target, and tests each element\nagainst a supplied filter function. If any Nodes, including the container,\nsatisfy the filter, the delegated callback will be triggered for each.\n\nHosted as a protected property of the `delegate` method (e.g.\n`Y.delegate._applyFilter`).",
"itemtype": "method",
"name": "_applyFilter",
"params": [
{
"name": "filter",
"description": "boolean function to test for inclusion in event\n notification",
"type": "Function"
},
{
"name": "args",
"description": "the arguments that would be passed to subscribers",
"type": "Array"
},
{
"name": "ce",
"description": "the DOM event wrapper",
"type": "CustomEvent"
}
],
"return": {
"description": "The Node or Nodes that satisfy the filter",
"type": "Node|Node[]|undefined"
},
"access": "protected",
"tagname": "",
"class": "YUI",
"module": "event",
"submodule": "event-delegate"
},
{
"file": "lib/yui3/src/event/js/delegate.js",
"line": 284,
"description": "Sets up event delegation on a container element. The delegated event\nwill use a supplied filter to test if the callback should be executed.\nThis filter can be either a selector string or a function that returns\na Node to use as the currentTarget for the event.\n\nThe event object for the delegated event is supplied to the callback\nfunction. It is modified slightly in order to support all properties\nthat may be needed for event delegation. 'currentTarget' is set to\nthe element that matched the selector string filter or the Node returned\nfrom the filter function. 'container' is set to the element that the\nlistener is delegated from (this normally would be the 'currentTarget').\n\nFilter functions will be called with the arguments that would be passed to\nthe callback function, including the event object as the first parameter.\nThe function should return false (or a falsey value) if the success criteria\naren't met, and the Node to use as the event's currentTarget and 'this'\nobject if they are.",
"itemtype": "method",
"name": "delegate",
"params": [
{
"name": "type",
"description": "the event type to delegate",
"type": "String"
},
{
"name": "fn",
"description": "the callback function to execute. This function\nwill be provided the event object for the delegated event.",
"type": "Function"
},
{
"name": "el",
"description": "the element that is the delegation container",
"type": "String|node"
},
{
"name": "filter",
"description": "a selector that must match the target of the\nevent or a function that returns a Node or false.",
"type": "String|function"
},
{
"name": "context",
"description": "optional argument that specifies what 'this' refers to."
},
{
"name": "args",
"description": "0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object.",
"multiple": true
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event",
"submodule": "event-delegate"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 70,
"description": "True after the onload event has fired",
"itemtype": "property",
"name": "_loadComplete",
"type": "boolean",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 79,
"description": "The number of times to poll after window.onload. This number is\nincreased if additional late-bound handlers are requested after\nthe page load.",
"itemtype": "property",
"name": "_retryCount",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 89,
"description": "onAvailable listeners",
"itemtype": "property",
"name": "_avail",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 97,
"description": "Custom event wrappers for DOM events. Key is\n'event:' + Element uid stamp + event type",
"itemtype": "property",
"name": "_wrappers",
"type": "Y.Event.Custom",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 109,
"description": "Custom event wrapper map DOM events. Key is\nElement uid stamp. Each item is a hash of custom event\nwrappers as provided in the _wrappers collection. This\nprovides the infrastructure for getListeners.",
"itemtype": "property",
"name": "_el_events",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 122,
"description": "The number of times we should look for elements that are not\nin the DOM at the time the event is requested after the document\nhas been loaded. The default is 1000@amp;40 ms, so it will poll\nfor 40 seconds or until all outstanding handlers are bound\n(whichever comes first).",
"itemtype": "property",
"name": "POLL_RETRYS",
"type": "int",
"static": 1,
"final": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 135,
"description": "The poll interval in milliseconds",
"itemtype": "property",
"name": "POLL_INTERVAL",
"type": "int",
"static": 1,
"final": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 144,
"description": "addListener/removeListener can throw errors in unexpected scenarios.\nThese errors are suppressed, the method returns false, and this property\nis set",
"itemtype": "property",
"name": "lastError",
"static": 1,
"type": "Error",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 155,
"description": "poll handle",
"itemtype": "property",
"name": "_interval",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 163,
"description": "document readystate poll handle",
"itemtype": "property",
"name": "_dri",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 171,
"description": "True when the document is initially usable",
"itemtype": "property",
"name": "DOMReady",
"type": "boolean",
"static": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 179,
"itemtype": "method",
"name": "startInterval",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 190,
"description": "Executes the supplied callback when the item with the supplied\nid is found. This is meant to be used to execute behavior as\nsoon as possible as the page loads. If you use this after the\ninitial page load it will poll for a fixed time for the element.\nThe number of times it will poll and the frequency are\nconfigurable. By default it will poll for 10 seconds.\n\n
The callback is executed with a single parameter:\nthe custom object parameter, if provided.
",
"itemtype": "method",
"name": "onAvailable",
"params": [
{
"name": "id",
"description": "the id of the element, or an array\nof ids to look for.",
"type": "String||string[]"
},
{
"name": "fn",
"description": "what to execute when the element is found.",
"type": "Function"
},
{
"name": "p_obj",
"description": "an optional object to be passed back as\n a parameter to fn.",
"type": "Object"
},
{
"name": "p_override",
"description": "If set to true, fn will execute\n in the context of p_obj, if set to an object it\n will execute in the context of that object",
"type": "Boolean|object"
},
{
"name": "checkContent",
"description": "check child node readiness (onContentReady)",
"type": "Boolean"
}
],
"static": 1,
"deprecated": true,
"deprecationMessage": "Use Y.on(\"available\")",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 263,
"description": "Works the same way as onAvailable, but additionally checks the\nstate of sibling elements to determine if the content of the\navailable element is safe to modify.\n\nThe callback is executed with a single parameter:\nthe custom object parameter, if provided.
",
"itemtype": "method",
"name": "onContentReady",
"params": [
{
"name": "id",
"description": "the id of the element to look for.",
"type": "String"
},
{
"name": "fn",
"description": "what to execute when the element is ready.",
"type": "Function"
},
{
"name": "obj",
"description": "an optional object to be passed back as\n a parameter to fn.",
"type": "Object"
},
{
"name": "override",
"description": "If set to true, fn will execute\n in the context of p_obj. If an object, fn will\n exectute in the context of that object",
"type": "Boolean|object"
}
],
"static": 1,
"deprecated": true,
"deprecationMessage": "Use Y.on(\"contentready\")",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 289,
"description": "Adds an event listener",
"itemtype": "method",
"name": "attach",
"params": [
{
"name": "type",
"description": "The type of event to append",
"type": "String"
},
{
"name": "fn",
"description": "The method the event invokes",
"type": "Function"
},
{
"name": "el",
"description": "An id, an element\n reference, or a collection of ids and/or elements to assign the\n listener to.",
"type": "String|HTMLElement|Array|NodeList"
},
{
"name": "context",
"description": "optional context object",
"type": "Object"
},
{
"name": "args",
"description": "0..n arguments to pass to the callback",
"type": "Boolean|object"
}
],
"return": {
"description": "an object to that can be used to detach the listener",
"type": "EventHandle"
},
"static": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 498,
"description": "Removes an event listener. Supports the signature the event was bound\nwith, but the preferred way to remove listeners is using the handle\nthat is returned when using Y.on",
"itemtype": "method",
"name": "detach",
"params": [
{
"name": "type",
"description": "the type of event to remove.",
"type": "String"
},
{
"name": "fn",
"description": "the method the event invokes. If fn is\nundefined, then all event handlers for the type of event are\nremoved.",
"type": "Function"
},
{
"name": "el",
"description": "An\nevent handle, an id, an element reference, or a collection\nof ids and/or elements to remove the listener from.",
"type": "String|HTMLElement|Array|NodeList|EventHandle"
}
],
"return": {
"description": "true if the unbind was successful, false otherwise.",
"type": "Boolean"
},
"static": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 580,
"description": "Finds the event in the window object, the caller's arguments, or\nin the arguments of another method in the callstack. This is\nexecuted automatically for events registered through the event\nmanager, so the implementer should not normally need to execute\nthis function at all.",
"itemtype": "method",
"name": "getEvent",
"params": [
{
"name": "e",
"description": "the event parameter from the handler",
"type": "Event"
},
{
"name": "el",
"description": "the element the listener was attached to",
"type": "HTMLElement"
}
],
"return": {
"description": "the event",
"type": "Event"
},
"static": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 599,
"description": "Generates an unique ID for the element if it does not already\nhave one.",
"itemtype": "method",
"name": "generateId",
"params": [
{
"name": "el",
"description": "the element to create the id for"
}
],
"return": {
"description": "the resulting id of the element",
"type": "String"
},
"static": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 611,
"description": "We want to be able to use getElementsByTagName as a collection\nto attach a group of events to. Unfortunately, different\nbrowsers return different types of collections. This function\ntests to determine if the object is array-like. It will also\nfail if the object is an array, but is empty.",
"itemtype": "method",
"name": "_isValidCollection",
"params": [
{
"name": "o",
"description": "the object to test"
}
],
"return": {
"description": "true if the object is array-like and populated",
"type": "Boolean"
},
"deprecated": true,
"deprecationMessage": "was not meant to be used directly",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 626,
"description": "hook up any deferred listeners",
"itemtype": "method",
"name": "_load",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 651,
"description": "Polling function that runs before the onload event fires,\nattempting to attach to DOM Nodes as soon as they are\navailable",
"itemtype": "method",
"name": "_poll",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 764,
"description": "Removes all listeners attached to the given element via addListener.\nOptionally, the node's children can also be purged.\nOptionally, you can specify a specific type of event to remove.",
"itemtype": "method",
"name": "purgeElement",
"params": [
{
"name": "el",
"description": "the element to purge",
"type": "HTMLElement"
},
{
"name": "recurse",
"description": "recursively purge this element's children\nas well. Use with caution.",
"type": "Boolean"
},
{
"name": "type",
"description": "optional type of listener to purge. If\nleft out, all listeners will be removed",
"type": "String"
}
],
"static": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 802,
"description": "Removes all object references and the DOM proxy subscription for\na given event for a DOM node.",
"itemtype": "method",
"name": "_clean",
"params": [
{
"name": "wrapper",
"description": "Custom event proxy for the DOM\n subscription",
"type": "CustomEvent"
}
],
"access": "private",
"tagname": "",
"static": 1,
"since": "3.4.0",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 828,
"description": "Returns all listeners attached to the given element via addListener.\nOptionally, you can specify a specific type of event to return.",
"itemtype": "method",
"name": "getListeners",
"params": [
{
"name": "el",
"description": "the element or element id to inspect",
"type": "HTMLElement|string"
},
{
"name": "type",
"description": "optional type of listener to return. If\nleft out, all listeners will be returned",
"type": "String"
}
],
"return": {
"description": "the custom event wrapper for the DOM event(s)",
"type": "CustomEvent"
},
"static": 1,
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 872,
"description": "Removes all listeners registered by pe.event. Called\nautomatically during the unload event.",
"itemtype": "method",
"name": "_unload",
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 889,
"description": "Adds a DOM event directly without the caching, cleanup, context adj, etc",
"itemtype": "method",
"name": "nativeAdd",
"params": [
{
"name": "el",
"description": "the element to bind the handler to",
"type": "HTMLElement"
},
{
"name": "type",
"description": "the type of event handler",
"type": "String"
},
{
"name": "fn",
"description": "the callback to invoke",
"type": "Function"
},
{
"name": "capture",
"description": "capture or bubble phase",
"type": "Boolen"
}
],
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-dom.js",
"line": 902,
"description": "Basic remove listener",
"itemtype": "method",
"name": "nativeRemove",
"params": [
{
"name": "el",
"description": "the element to bind the handler to",
"type": "HTMLElement"
},
{
"name": "type",
"description": "the type of event handler",
"type": "String"
},
{
"name": "fn",
"description": "the callback to invoke",
"type": "Function"
},
{
"name": "capture",
"description": "capture or bubble phase",
"type": "Boolen"
}
],
"static": 1,
"access": "private",
"tagname": "",
"class": "Event",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom-ie.js",
"line": 227,
"description": "Wrapper function for Object.defineProperty that creates a property whose\nvalue will be calulated only when asked for. After calculating the value,\nthe getter wll be removed, so it will behave as a normal property beyond that\npoint. A setter is also assigned so assigning to the property will clear\nthe getter, so foo.prop = 'a'; foo.prop; won't trigger the getter,\noverwriting value 'a'.\n\nUsed only by the DOMEventFacades used by IE8 when the YUI configuration\nlazyEventFacade is set to true.",
"itemtype": "method",
"name": "_define",
"params": [
{
"name": "o",
"description": "A DOM object to add the property to",
"type": "DOMObject"
},
{
"name": "prop",
"description": "The name of the new property",
"type": "String"
},
{
"name": "valueFn",
"description": "The function that will return the initial, default\n value for the property.",
"type": "Function"
}
],
"static": 1,
"access": "private",
"tagname": "",
"class": "DOMEventFacade",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom-touch.js",
"line": 11,
"description": "Adds touch event facade normalization properties to the DOM event facade",
"itemtype": "method",
"name": "_touch",
"access": "private",
"tagname": "",
"params": [
{
"name": "ev",
"description": "the DOM event",
"type": "Event"
},
{
"name": "currentTarget",
"description": "the element the listener was attached to",
"type": "HTMLElement"
},
{
"name": "wrapper",
"description": "the custom event wrapper for this DOM event",
"type": "Event.Custom"
}
],
"class": "DOMEventFacade",
"module": "event-touch"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom-touch.js",
"line": 30,
"description": "Array of individual touch events for touch points that are still in\ncontact with the touch surface.",
"itemtype": "property",
"name": "touches",
"type": "{DOMEventFacade[]}",
"class": "DOMEventFacade",
"module": "event-touch"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom-touch.js",
"line": 49,
"description": "Array of individual touch events still in contact with the touch\nsurface and whose `touchstart` event occurred inside the same taregt\nelement as the current target element.",
"itemtype": "property",
"name": "targetTouches",
"type": "{DOMEventFacade[]}",
"class": "DOMEventFacade",
"module": "event-touch"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom-touch.js",
"line": 72,
"description": "An array of event-specific touch events.\n\nFor `touchstart`, the touch points that became active with the current\nevent.\n\nFor `touchmove`, the touch points that have changed since the last\nevent.\n\nFor `touchend`, the touch points that have been removed from the touch\nsurface.",
"itemtype": "property",
"name": "changedTouches",
"type": "{DOMEventFacade[]}",
"class": "DOMEventFacade",
"module": "event-touch"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 21,
"description": "webkit key remapping required for Safari < 3.1",
"itemtype": "property",
"name": "webkitKeymap",
"access": "private",
"tagname": "",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 40,
"description": "Returns a wrapped node. Intended to be used on event targets,\nso it will return the node's parent if the target is a text\nnode.\n\nIf accessing a property of the node throws an error, this is\nprobably the anonymous div wrapper Gecko adds inside text\nnodes. This likely will only occur when attempting to access\nthe relatedTarget. In this case, we now return null because\nthe anonymous div is completely useless and we do not know\nwhat the related target was because we can't even get to\nthe element's parent node.",
"itemtype": "method",
"name": "resolve",
"access": "private",
"tagname": "",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 168,
"description": "The native event",
"itemtype": "property",
"name": "_event",
"type": "{Native DOM Event}",
"access": "private",
"tagname": "",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 175,
"description": "The name of the event (e.g. \"click\")",
"itemtype": "property",
"name": "type",
"type": "{String}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 182,
"description": "`true` if the \"alt\" or \"option\" key is pressed.",
"itemtype": "property",
"name": "altKey",
"type": "{Boolean}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 189,
"description": "`true` if the shift key is pressed.",
"itemtype": "property",
"name": "shiftKey",
"type": "{Boolean}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 196,
"description": "`true` if the \"Windows\" key on a Windows keyboard, \"command\" key on an\nApple keyboard, or \"meta\" key on other keyboards is pressed.",
"itemtype": "property",
"name": "metaKey",
"type": "{Boolean}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 204,
"description": "`true` if the \"Ctrl\" or \"control\" key is pressed.",
"itemtype": "property",
"name": "ctrlKey",
"type": "{Boolean}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 211,
"description": "The X location of the event on the page (including scroll)",
"itemtype": "property",
"name": "pageX",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 217,
"description": "The Y location of the event on the page (including scroll)",
"itemtype": "property",
"name": "pageY",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 223,
"description": "The X location of the event in the viewport",
"itemtype": "property",
"name": "clientX",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 229,
"description": "The Y location of the event in the viewport",
"itemtype": "property",
"name": "clientY",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 235,
"description": "The keyCode for key events. Uses charCode if keyCode is not available",
"itemtype": "property",
"name": "keyCode",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 241,
"description": "The charCode for key events. Same as keyCode",
"itemtype": "property",
"name": "charCode",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 247,
"description": "The button that was pushed. 1 for left click, 2 for middle click, 3 for\nright click. This is only reliably populated on `mouseup` events.",
"itemtype": "property",
"name": "button",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 254,
"description": "The button that was pushed. Same as button.",
"itemtype": "property",
"name": "which",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 260,
"description": "Node reference for the targeted element",
"itemtype": "property",
"name": "target",
"type": "{Node}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 266,
"description": "Node reference for the element that the listener was attached to.",
"itemtype": "property",
"name": "currentTarget",
"type": "{Node}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 272,
"description": "Node reference to the relatedTarget",
"itemtype": "property",
"name": "relatedTarget",
"type": "{Node}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 278,
"description": "Number representing the direction and velocity of the movement of the mousewheel.\nNegative is down, the higher the number, the faster. Applies to the mousewheel event.",
"itemtype": "property",
"name": "wheelDelta",
"type": "{Number}",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 285,
"description": "Stops the propagation to the next bubble target",
"itemtype": "method",
"name": "stopPropagation",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 290,
"description": "Stops the propagation to the next bubble target and\nprevents any additional listeners from being exectued\non the current target.",
"itemtype": "method",
"name": "stopImmediatePropagation",
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 297,
"description": "Prevents the event's default behavior",
"itemtype": "method",
"name": "preventDefault",
"params": [
{
"name": "returnValue",
"description": "sets the returnValue of the event to this value\n(rather than the default false value). This can be used to add a customized\nconfirmation query to the beforeunload event).",
"type": "String"
}
],
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-facade-dom.js",
"line": 305,
"description": "Stops the event propagation and prevents the default\nevent behavior.",
"itemtype": "method",
"name": "halt",
"params": [
{
"name": "immediate",
"description": "if true additional listeners\non the current target will not be executed",
"type": "Boolean"
}
],
"class": "DOMEventFacade",
"module": "event",
"submodule": "event-base"
},
{
"file": "lib/yui3/src/event/js/event-ready.js",
"line": 7,
"description": "The domready event fires at the moment the browser's DOM is\nusable. In most cases, this is before images are fully\ndownloaded, allowing you to provide a more responsive user\ninterface.\n\nIn YUI 3, domready subscribers will be notified immediately if\nthat moment has already passed when the subscription is created.\n\nOne exception is if the yui.js file is dynamically injected into\nthe page. If this is done, you must tell the YUI instance that\nyou did this in order for DOMReady (and window load events) to\nfire normally. That configuration option is 'injected' -- set\nit to true if the yui.js script is not included inline.\n\nThis method is part of the 'event-ready' module, which is a\nsubmodule of 'event'.",
"itemtype": "event",
"name": "domready",
"class": "YUI",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/key.js",
"line": 124,
"description": "Add a key listener. The listener will only be notified if the\nkeystroke detected meets the supplied specification. The\nspecification is a string that is defined as:
\n\n\n - spec
\n [{type}:]{code}[,{code}]*- type
\n \"down\", \"up\", or \"press\"- code
\n {keyCode|character|keyName}[+{modifier}]*- modifier
\n \"shift\", \"ctrl\", \"alt\", or \"meta\"- keyName
\n \"enter\", \"backspace\", \"esc\", \"tab\", \"pageup\", or \"pagedown\"
\n\nExamples:
\n\n Y.on(\"key\", callback, \"press:12,65+shift+ctrl\", \"#my-input\");Y.delegate(\"key\", preventSubmit, \"enter\", \"#forms\", \"input[type=text]\");Y.one(\"doc\").on(\"key\", viNav, \"j,k,l,;\");
",
"itemtype": "event",
"name": "key",
"params": [
{
"name": "type",
"description": "'key'",
"type": "String"
},
{
"name": "fn",
"description": "the function to execute",
"type": "Function"
},
{
"name": "id",
"description": "the element(s) to bind",
"type": "String|HTMLElement|collection"
},
{
"name": "spec",
"description": "the keyCode and modifier specification",
"type": "String"
},
{
"name": "o",
"description": "optional context object"
},
{
"name": "args",
"description": "0..n additional arguments to provide to the listener."
}
],
"return": {
"description": "the detach handle",
"type": "Event.Handle"
},
"class": "YUI",
"module": "event",
"submodule": "event-key"
},
{
"file": "lib/yui3/src/event/js/mousewheel.js",
"line": 25,
"description": "Mousewheel event. This listener is automatically attached to the\ncorrect target, so one should not be supplied. Mouse wheel \ndirection and velocity is stored in the 'wheelDelta' field.",
"itemtype": "event",
"name": "mousewheel",
"params": [
{
"name": "type",
"description": "'mousewheel'",
"type": "String"
},
{
"name": "fn",
"description": "the callback to execute",
"type": "Function"
},
{
"name": "context",
"description": "optional context object"
},
{
"name": "args",
"description": "0..n additional arguments to provide to the listener."
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event",
"submodule": "event-mousewheel"
},
{
"file": "lib/yui3/src/event/js/outside.js",
"line": 48,
"description": "Defines a new outside event to correspond with the given DOM event.\n\nBy default, the created synthetic event name will be the name of the event\nwith \"outside\" appended (e.g. \"click\" becomes \"clickoutside\"). If you want\na different name for the created Event, pass it as a second argument like so:\nY.Event.defineOutside(eventType, \"yonderclick\").",
"itemtype": "method",
"name": "defineOutside",
"params": [
{
"name": "event",
"description": "DOM event",
"type": "String"
},
{
"name": "name",
"description": "(optional) custom outside event name",
"type": "String"
}
],
"static": 1,
"class": "Event",
"module": "event",
"submodule": "event-outside"
},
{
"file": "lib/yui3/src/event/js/resize-window.js",
"line": 9,
"description": "Old firefox fires the window resize event once when the resize action\nfinishes, other browsers fire the event periodically during the\nresize. This code uses timeout logic to simulate the Firefox \nbehavior in other browsers.",
"itemtype": "event",
"name": "windowresize",
"class": "YUI",
"module": "event",
"submodule": "event-resize"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 37,
"description": "Executes the subscription callback, passing the firing arguments as the\nfirst parameters to that callback. For events that are configured with\nemitFacade=true, it is common practice to pass the triggering DOMEventFacade\nas the first parameter. Barring a proper DOMEventFacade or EventFacade\n(from a CustomEvent), a new EventFacade will be generated. In that case, if\nfire() is called with a simple object, it will be mixed into the facade.\nOtherwise, the facade will be prepended to the callback parameters.
\n\nFor notifiers provided to delegate logic, the first argument should be an\nobject with a "currentTarget" property to identify what object to\ndefault as 'this' in the callback. Typically this is gleaned from the\nDOMEventFacade or EventFacade, but if configured with emitFacade=false, an\nobject must be provided. In that case, the object will be removed from the\ncallback parameters.
\n\nAdditional arguments passed during event subscription will be\nautomatically added after those passed to fire().
",
"itemtype": "method",
"name": "fire",
"params": [
{
"name": "e",
"description": "(see description)",
"type": "EventFacade|DOMEventFacade|Object|any"
},
{
"name": "arg",
"description": "additional arguments received by all subscriptions",
"type": "Any",
"multiple": true
}
],
"access": "private",
"tagname": "",
"class": "SyntheticEvent.Notifier",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 130,
"description": "Adds a subscription from the Notifier registry.",
"itemtype": "method",
"name": "register",
"params": [
{
"name": "handle",
"description": "the subscription",
"type": "EventHandle"
}
],
"since": "3.4.0",
"class": "SynthRegistry",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 142,
"description": "Removes the subscription from the Notifier registry.",
"itemtype": "method",
"name": "_unregisterSub",
"params": [
{
"name": "sub",
"description": "the subscription",
"type": "Subscription"
}
],
"since": "3.4.0",
"class": "SynthRegistry",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 170,
"description": "Used by the event system's unload cleanup process. When navigating\naway from the page, the event system iterates the global map of element\nsubscriptions and detaches everything using detachAll(). Normally,\nthe map is populated with custom events, so this object needs to\nat least support the detachAll method to duck type its way to\ncleanliness.",
"itemtype": "method",
"name": "detachAll",
"access": "private",
"tagname": "",
"since": "3.4.0",
"class": "SynthRegistry",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 214,
"description": "Returns the array of subscription handles for a node for the given event\ntype. Passing true as the third argument will create a registry entry\nin the event system's DOM map to host the array if one doesn't yet exist.",
"itemtype": "method",
"name": "getRegistry",
"params": [
{
"name": "node",
"description": "the node",
"type": "Node"
},
{
"name": "type",
"description": "the event",
"type": "String"
},
{
"name": "create",
"description": "create a registration entry to host a new array\n if one doesn't exist.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Array"
},
"static": 1,
"access": "protected",
"tagname": "",
"since": "3.2.0",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 247,
"description": "Alternate _delete() method for the CustomEvent object\ncreated to manage SyntheticEvent subscriptions.",
"itemtype": "method",
"name": "_deleteSub",
"params": [
{
"name": "sub",
"description": "the subscription to clean up",
"type": "Subscription"
}
],
"access": "private",
"tagname": "",
"since": "3.2.0",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 276,
"description": "Construction logic for the event.",
"itemtype": "method",
"name": "_init",
"access": "protected",
"tagname": "",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 292,
"description": "Implementers MAY provide this method definition.
\n\nImplement this function if the event supports a different\nsubscription signature. This function is used by both\non() and delegate(). The second parameter\nindicates that the event is being subscribed via\ndelegate().
\n\nImplementations must remove extra arguments from the args list\nbefore returning. The required args for on()\nsubscriptions are
\n[type, callback, target, context, argN...]
\n\nThe required args for delegate()\nsubscriptions are
\n\n[type, callback, target, filter, context, argN...]
\n\nThe return value from this function will be stored on the\nsubscription in the '_extra' property for reference elsewhere.
",
"itemtype": "method",
"name": "processArgs",
"params": [
{
"name": "args",
"description": "parmeters passed to Y.on(..) or Y.delegate(..)",
"type": "Array"
},
{
"name": "delegate",
"description": "true if the subscription is from Y.delegate",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Any"
},
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 321,
"description": "Implementers MAY override this property.
\n\nWhether to prevent multiple subscriptions to this event that are\nclassified as being the same. By default, this means the subscribed\ncallback is the same function. See the subMatch\nmethod. Setting this to true will impact performance for high volume\nevents.
",
"itemtype": "property",
"name": "preventDups",
"type": "{Boolean}",
"default": "false",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 336,
"description": "Implementers SHOULD provide this method definition.
\n\nImplementation logic for subscriptions done via node.on(type,\nfn) or Y.on(type, fn, target). This\nfunction should set up the monitor(s) that will eventually fire the\nevent. Typically this involves subscribing to at least one DOM\nevent. It is recommended to store detach handles from any DOM\nsubscriptions to make for easy cleanup in the detach\nmethod. Typically these handles are added to the sub\nobject. Also for SyntheticEvents that leverage a single DOM\nsubscription under the hood, it is recommended to pass the DOM event\nobject to notifier.fire(e). (The event name on the\nobject will be updated).",
"itemtype": "method",
"name": "on",
"params": [
{
"name": "node",
"description": "the node the subscription is being applied to",
"type": "Node"
},
{
"name": "sub",
"description": "the object to track this subscription",
"type": "Subscription"
},
{
"name": "notifier",
"description": "call notifier.fire(..) to\n trigger the execution of the subscribers",
"type": "SyntheticEvent.Notifier"
}
],
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 359,
"description": "Implementers SHOULD provide this method definition.
\n\nImplementation logic for detaching subscriptions done via\nnode.on(type, fn). This function should clean up any\nsubscriptions made in the on() phase.
",
"itemtype": "method",
"name": "detach",
"params": [
{
"name": "node",
"description": "the node the subscription was applied to",
"type": "Node"
},
{
"name": "sub",
"description": "the object tracking this subscription",
"type": "Subscription"
},
{
"name": "notifier",
"description": "the Notifier used to\n trigger the execution of the subscribers",
"type": "SyntheticEvent.Notifier"
}
],
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 374,
"description": "Implementers SHOULD provide this method definition.
\n\nImplementation logic for subscriptions done via\nnode.delegate(type, fn, filter) or\nY.delegate(type, fn, container, filter). Like with\non() above, this function should monitor the environment\nfor the event being fired, and trigger subscription execution by\ncalling notifier.fire(e).
\n\nThis function receives a fourth argument, which is the filter\nused to identify which Node's are of interest to the subscription.\nThe filter will be either a boolean function that accepts a target\nNode for each hierarchy level as the event bubbles, or a selector\nstring. To translate selector strings into filter functions, use\nY.delegate.compileFilter(filter).
",
"itemtype": "method",
"name": "delegate",
"params": [
{
"name": "node",
"description": "the node the subscription is being applied to",
"type": "Node"
},
{
"name": "sub",
"description": "the object to track this subscription",
"type": "Subscription"
},
{
"name": "notifier",
"description": "call notifier.fire(..) to\n trigger the execution of the subscribers",
"type": "SyntheticEvent.Notifier"
},
{
"name": "filter",
"description": "Selector string or function that\n accepts an event object and returns null, a Node, or an\n array of Nodes matching the criteria for processing.",
"type": "String|Function"
}
],
"since": "3.2.0",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 403,
"description": "Implementers SHOULD provide this method definition.
\n\nImplementation logic for detaching subscriptions done via\nnode.delegate(type, fn, filter) or\nY.delegate(type, fn, container, filter). This function\nshould clean up any subscriptions made in the\ndelegate() phase.
",
"itemtype": "method",
"name": "detachDelegate",
"params": [
{
"name": "node",
"description": "the node the subscription was applied to",
"type": "Node"
},
{
"name": "sub",
"description": "the object tracking this subscription",
"type": "Subscription"
},
{
"name": "notifier",
"description": "the Notifier used to\n trigger the execution of the subscribers",
"type": "SyntheticEvent.Notifier"
},
{
"name": "filter",
"description": "Selector string or function that\n accepts an event object and returns null, a Node, or an\n array of Nodes matching the criteria for processing.",
"type": "String|Function"
}
],
"since": "3.2.0",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 424,
"description": "Sets up the boilerplate for detaching the event and facilitating the\nexecution of subscriber callbacks.",
"itemtype": "method",
"name": "_on",
"params": [
{
"name": "args",
"description": "array of arguments passed to\n Y.on(...) or Y.delegate(...)",
"type": "Array"
},
{
"name": "delegate",
"description": "true if called from\nY.delegate(...)",
"type": "Boolean"
}
],
"return": {
"description": "the detach handle for this subscription",
"type": "EventHandle"
},
"access": "private",
"tagname": "since 3.2.0",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 485,
"description": "Creates a new Notifier object for use by this event's\non(...) or delegate(...) implementation\nand register the custom event proxy in the DOM system for cleanup.",
"itemtype": "method",
"name": "_subscribe",
"params": [
{
"name": "node",
"description": "the Node hosting the event",
"type": "Node"
},
{
"name": "method",
"description": "\"on\" or \"delegate\"",
"type": "String"
},
{
"name": "args",
"description": "the subscription arguments passed to either\n Y.on(...) or Y.delegate(...)\n after running through processArgs(args) to\n normalize the argument signature",
"type": "Array"
},
{
"name": "extra",
"description": "Extra data parsed from\n processArgs(args)",
"type": "Any"
},
{
"name": "filter",
"description": "the selector string or function\n filter passed to Y.delegate(...) (not\n present when called from Y.on(...))",
"type": "String|Function"
}
],
"return": {
"description": "",
"type": "EventHandle"
},
"access": "private",
"tagname": "",
"since": "3.2.0",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 540,
"description": "Implementers MAY provide this method definition.
\n\nImplement this function if you want extra data extracted during\nprocessArgs to be propagated to subscriptions on a per-node basis.\nThat is to say, if you call Y.on('xyz', fn, xtra, 'div')\nthe data returned from processArgs will be shared\nacross the subscription objects for all the divs. If you want each\nsubscription to receive unique information, do that processing\nhere.
\n\nThe default implementation adds the data extracted by processArgs\nto the subscription object as sub._extra.
",
"itemtype": "method",
"name": "applyArgExtras",
"params": [
{
"name": "extra",
"description": "Any extra data extracted from processArgs",
"type": "Any"
},
{
"name": "sub",
"description": "the individual subscription",
"type": "Subscription"
}
],
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 562,
"description": "Removes the subscription(s) from the internal subscription dispatch\nmechanism. See SyntheticEvent._deleteSub.",
"itemtype": "method",
"name": "_detach",
"params": [
{
"name": "args",
"description": "The arguments passed to\n node.detach(...)",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"since": "3.2.0",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 598,
"description": "Returns the detach handles of subscriptions on a node that satisfy a\nsearch/filter function. By default, the filter used is the\nsubMatch method.",
"itemtype": "method",
"name": "getSubs",
"params": [
{
"name": "node",
"description": "the node hosting the event",
"type": "Node"
},
{
"name": "args",
"description": "the array of original subscription args passed\n to Y.on(...) (before\n processArgs",
"type": "Array"
},
{
"name": "filter",
"description": "function used to identify a subscription\n for inclusion in the returned array",
"type": "Function"
},
{
"name": "first",
"description": "stop after the first match (used to check for\n duplicate subscriptions)",
"type": "Boolean"
}
],
"return": {
"description": "detach handles for the matching subscriptions",
"type": "EventHandle[]"
},
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 641,
"description": "Implementers MAY override this to define what constitutes a\n"same" subscription. Override implementations should\nconsider the lack of a comparator as a match, so calling\ngetSubs() with no arguments will return all subs.
\n\nCompares a set of subscription arguments against a Subscription\nobject to determine if they match. The default implementation\ncompares the callback function against the second argument passed to\nY.on(...) or node.detach(...) etc.
",
"itemtype": "method",
"name": "subMatch",
"params": [
{
"name": "sub",
"description": "the existing subscription",
"type": "Subscription"
},
{
"name": "args",
"description": "the calling arguments passed to\n Y.on(...) etc.",
"type": "Array"
}
],
"return": {
"description": "true if the sub can be described by the args\n present",
"type": "Boolean"
},
"since": "3.2.0",
"class": "SyntheticEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/js/synthetic.js",
"line": 669,
"description": "Defines a new event in the DOM event system. Implementers are\nresponsible for monitoring for a scenario whereby the event is fired. A\nnotifier object is provided to the functions identified below. When the\ncriteria defining the event are met, call notifier.fire( [args] ); to\nexecute event subscribers.
\n\nThe first parameter is the name of the event. The second parameter is a\nconfiguration object which define the behavior of the event system when the\nnew event is subscribed to or detached from. The methods that should be\ndefined in this configuration object are on,\ndetach, delegate, and detachDelegate.\nYou are free to define any other methods or properties needed to define your\nevent. Be aware, however, that since the object is used to subclass\nSyntheticEvent, you should avoid method names used by SyntheticEvent unless\nyour intention is to override the default behavior.
\n\nThis is a list of properties and methods that you can or should specify\nin the configuration object:
\n\n\n onfunction (node, subscription, notifier) The\n implementation logic for subscription. Any special setup you need to\n do to create the environment for the event being fired--E.g. native\n DOM event subscriptions. Store subscription related objects and\n state on the subscription object. When the\n criteria have been met to fire the synthetic event, call\n notifier.fire(e). See Notifier's fire()\n method for details about what to pass as parameters.detachfunction (node, subscription, notifier) The\n implementation logic for cleaning up a detached subscription. E.g.\n detach any DOM subscriptions added in on.delegatefunction (node, subscription, notifier, filter) The\n implementation logic for subscription via Y.delegate or\n node.delegate. The filter is typically either a selector\n string or a function. You can use\n Y.delegate.compileFilter(selectorString) to create a\n filter function from a selector string if needed. The filter function\n expects an event object as input and should output either null, a\n matching Node, or an array of matching Nodes. Otherwise, this acts\n like on DOM event subscriptions. Store subscription\n related objects and information on the subscription\n object. When the criteria have been met to fire the synthetic event,\n call notifier.fire(e) as noted above.detachDelegatefunction (node, subscription, notifier) The\n implementation logic for cleaning up a detached delegate subscription.\n E.g. detach any DOM delegate subscriptions added in\n delegate.publishConfig- (Object) The configuration object that will be used to instantiate\n the underlying CustomEvent. See Notifier's
fire method\n for details. \n\n processArgs\n function (argArray, fromDelegate) Optional method\n to extract any additional arguments from the subscription\n signature. Using this allows on or\n delegate signatures like\n node.on("hover", overCallback,\n outCallback).
\n When processing an atypical argument signature, make sure the\n args array is returned to the normal signature before returning\n from the function. For example, in the "hover" example\n above, the outCallback needs to be spliced\n out of the array. The expected signature of the args array for\n on() subscriptions is:
\n \n [type, callback, target, contextOverride, argN...]\n
\n And for delegate():
\n \n [type, callback, target, filter, contextOverride, argN...]\n
\n where target is the node the event is being\n subscribed for. You can see these signatures documented for\n Y.on() and Y.delegate() respectively.
\n Whatever gets returned from the function will be stored on the\n subscription object under\n subscription._extra.
\n subMatch- \n
function (sub, args) Compares a set of\n subscription arguments against a Subscription object to determine\n if they match. The default implementation compares the callback\n function against the second argument passed to\n Y.on(...) or node.detach(...) etc.
\n \n
",
"itemtype": "method",
"name": "define",
"params": [
{
"name": "type",
"description": "the name of the event",
"type": "String"
},
{
"name": "config",
"description": "the prototype definition for the new event (see above)",
"type": "Object"
},
{
"name": "force",
"description": "override an existing event (use with caution)",
"type": "Boolean"
}
],
"return": {
"description": "the subclass implementation instance created to\n handle event subscriptions of this type",
"type": "SyntheticEvent"
},
"static": 1,
"since": "3.1.0",
"in": "event-synthetic",
"class": "Event",
"module": "event"
},
{
"file": "lib/yui3/src/event/tests/src/event-synthetic.js",
"line": 86,
"class": "CustomEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/tests/src/event-synthetic.js",
"line": 87,
"class": "CustomEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/tests/src/event-synthetic.js",
"line": 88,
"class": "CustomEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/tests/event-synthetic-tests.js",
"line": 88,
"class": "CustomEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/tests/event-synthetic-tests.js",
"line": 89,
"class": "CustomEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event/tests/event-synthetic-tests.js",
"line": 90,
"class": "CustomEvent",
"module": "event"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 58,
"description": "The type of event, returned to subscribers when the event fires",
"itemtype": "property",
"name": "type",
"type": "string",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 65,
"description": "The context the the event will fire from by default. Defaults to the YUI\ninstance.",
"itemtype": "property",
"name": "context",
"type": "object",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 73,
"description": "Monitor when an event is attached or detached.",
"itemtype": "property",
"name": "monitored",
"type": "boolean",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 83,
"description": "If 0, this event does not broadcast. If 1, the YUI instance is notified\nevery time this event fires. If 2, the YUI instance and the YUI global\n(if event is enabled on the global) are notified every time this event\nfires.",
"itemtype": "property",
"name": "broadcast",
"type": "int",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 93,
"description": "By default all custom events are logged in the debug build, set silent\nto true to disable debug outpu for this event.",
"itemtype": "property",
"name": "silent",
"type": "boolean",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 101,
"description": "Specifies whether this event should be queued when the host is actively\nprocessing an event. This will effect exectution order of the callbacks\nfor the various events.",
"itemtype": "property",
"name": "queuable",
"type": "boolean",
"default": "false",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 111,
"description": "The subscribers to this event",
"itemtype": "property",
"name": "subscribers",
"type": "Subscriber {}",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 118,
"description": "'After' subscribers",
"itemtype": "property",
"name": "afters",
"type": "Subscriber {}",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 125,
"description": "This event has fired if true",
"itemtype": "property",
"name": "fired",
"type": "boolean",
"default": "false;",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 134,
"description": "An array containing the arguments the custom event\nwas last fired with.",
"itemtype": "property",
"name": "firedWith",
"type": "Array",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 142,
"description": "This event should only fire one time if true, and if\nit has fired, any new subscribers should be notified\nimmediately.",
"itemtype": "property",
"name": "fireOnce",
"type": "boolean",
"default": "false;",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 153,
"description": "fireOnce listeners will fire syncronously unless async\nis set to true",
"itemtype": "property",
"name": "async",
"type": "boolean",
"default": "false",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 162,
"description": "Flag for stopPropagation that is modified during fire()\n1 means to stop propagation to bubble targets. 2 means\nto also stop additional subscribers on this target.",
"itemtype": "property",
"name": "stopped",
"type": "int",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 171,
"description": "Flag for preventDefault that is modified during fire().\nif it is not 0, the default behavior for this event",
"itemtype": "property",
"name": "prevented",
"type": "int",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 179,
"description": "Specifies the host for this custom event. This is used\nto enable event bubbling",
"itemtype": "property",
"name": "host",
"type": "EventTarget",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 187,
"description": "The default function to execute after event listeners\nhave fire, but only if the default action was not\nprevented.",
"itemtype": "property",
"name": "defaultFn",
"type": "Function",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 196,
"description": "The function to execute if a subscriber calls\nstopPropagation or stopImmediatePropagation",
"itemtype": "property",
"name": "stoppedFn",
"type": "Function",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 204,
"description": "The function to execute if a subscriber calls\npreventDefault",
"itemtype": "property",
"name": "preventedFn",
"type": "Function",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 212,
"description": "Specifies whether or not this event's default function\ncan be cancelled by a subscriber by executing preventDefault()\non the event facade",
"itemtype": "property",
"name": "preventable",
"type": "boolean",
"default": "true",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 222,
"description": "Specifies whether or not a subscriber can stop the event propagation\nvia stopPropagation(), stopImmediatePropagation(), or halt()\n\nEvents can only bubble if emitFacade is true.",
"itemtype": "property",
"name": "bubbles",
"type": "boolean",
"default": "true",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 234,
"description": "Supports multiple options for listener signatures in order to\nport YUI 2 apps.",
"itemtype": "property",
"name": "signature",
"type": "int",
"default": "9",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 250,
"description": "If set to true, the custom event will deliver an EventFacade object\nthat is similar to a DOM event object.",
"itemtype": "property",
"name": "emitFacade",
"type": "boolean",
"default": "false",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 268,
"description": "Returns the number of subscribers for this event as the sum of the on()\nsubscribers and after() subscribers.",
"itemtype": "method",
"name": "hasSubs",
"return": {
"description": "Number"
},
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 290,
"description": "Monitor the event state for the subscribed event. The first parameter\nis what should be monitored, the rest are the normal parameters when\nsubscribing to an event.",
"itemtype": "method",
"name": "monitor",
"params": [
{
"name": "what",
"description": "what to monitor ('detach', 'attach', 'publish').",
"type": "String"
}
],
"return": {
"description": "return value from the monitor event subscription.",
"type": "EventHandle"
},
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 306,
"description": "Get all of the subscribers to this event and any sibling event",
"itemtype": "method",
"name": "getSubs",
"return": {
"description": "first item is the on subscribers, second the after.",
"type": "Array"
},
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 322,
"description": "Apply configuration properties. Only applies the CONFIG whitelist",
"itemtype": "method",
"name": "applyConfig",
"params": [
{
"name": "o",
"description": "hash of properties to apply."
},
{
"name": "force",
"description": "if true, properties that exist on the event\nwill be overwritten.",
"type": "Boolean"
}
],
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 335,
"description": "Create the Subscription for subscribing function, context, and bound\narguments. If this is a fireOnce event, the subscriber is immediately \nnotified.",
"itemtype": "method",
"name": "_on",
"params": [
{
"name": "fn",
"description": "Subscription callback",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` in the callback",
"type": "Object",
"optional": true
},
{
"name": "args",
"description": "bound arguments that will be passed to the callback after the arguments generated by fire()",
"type": "Array",
"optional": true
},
{
"name": "when",
"description": "\"after\" to slot into after subscribers",
"type": "String",
"optional": true
}
],
"return": {
"description": "",
"type": "EventHandle"
},
"access": "protected",
"tagname": "",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 376,
"description": "Listen for this event",
"itemtype": "method",
"name": "subscribe",
"params": [
{
"name": "fn",
"description": "The function to execute.",
"type": "Function"
}
],
"return": {
"description": "Unsubscribe handle.",
"type": "EventHandle"
},
"deprecated": true,
"deprecationMessage": "use on.",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 389,
"description": "Listen for this event",
"itemtype": "method",
"name": "on",
"params": [
{
"name": "fn",
"description": "The function to execute.",
"type": "Function"
},
{
"name": "context",
"description": "optional execution context.",
"type": "Object"
},
{
"name": "arg",
"description": "0..n additional arguments to supply to the subscriber\nwhen the event fires.",
"type": "Mixed",
"multiple": true
}
],
"return": {
"description": "An object with a detach method to detch the handler(s).",
"type": "EventHandle"
},
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 408,
"description": "Listen for this event after the normal subscribers have been notified and\nthe default behavior has been applied. If a normal subscriber prevents the\ndefault behavior, it also prevents after listeners from firing.",
"itemtype": "method",
"name": "after",
"params": [
{
"name": "fn",
"description": "The function to execute.",
"type": "Function"
},
{
"name": "context",
"description": "optional execution context.",
"type": "Object"
},
{
"name": "arg",
"description": "0..n additional arguments to supply to the subscriber\nwhen the event fires.",
"type": "Mixed",
"multiple": true
}
],
"return": {
"description": "handle Unsubscribe handle.",
"type": "EventHandle"
},
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 424,
"description": "Detach listeners.",
"itemtype": "method",
"name": "detach",
"params": [
{
"name": "fn",
"description": "The subscribed function to remove, if not supplied\n all will be removed.",
"type": "Function"
},
{
"name": "context",
"description": "The context object passed to subscribe.",
"type": "Object"
}
],
"return": {
"description": "returns the number of subscribers unsubscribed.",
"type": "Int"
},
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 455,
"description": "Detach listeners.",
"itemtype": "method",
"name": "unsubscribe",
"params": [
{
"name": "fn",
"description": "The subscribed function to remove, if not supplied\n all will be removed.",
"type": "Function"
},
{
"name": "context",
"description": "The context object passed to subscribe.",
"type": "Object"
}
],
"return": {
"description": "returns the number of subscribers unsubscribed.",
"type": "Int|undefined"
},
"deprecated": true,
"deprecationMessage": "use detach.",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 468,
"description": "Notify a single subscriber",
"itemtype": "method",
"name": "_notify",
"params": [
{
"name": "s",
"description": "the subscriber.",
"type": "Subscriber"
},
{
"name": "args",
"description": "the arguments array to apply to the listener.",
"type": "Array"
}
],
"access": "protected",
"tagname": "",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 491,
"description": "Logger abstraction to centralize the application of the silent flag",
"itemtype": "method",
"name": "log",
"params": [
{
"name": "msg",
"description": "message to log.",
"type": "String"
},
{
"name": "cat",
"description": "log category.",
"type": "String"
}
],
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 503,
"description": "Notifies the subscribers. The callback functions will be executed\nfrom the context specified when the event was created, and with the\nfollowing parameters:\n \n - The type of event
\n - All of the arguments fire() was executed with as an array
\n - The custom object (if any) that was passed into the subscribe()\n method
\n
",
"itemtype": "method",
"name": "fire",
"params": [
{
"name": "arguments",
"description": "an arbitrary set of parameters to pass to\n the handler.",
"type": "Object*"
}
],
"return": {
"description": "false if one of the subscribers returned false,\n true otherwise.",
"type": "Boolean"
},
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 542,
"description": "Set up for notifying subscribers of non-emitFacade events.",
"itemtype": "method",
"name": "fireSimple",
"params": [
{
"name": "args",
"description": "Arguments passed to fire()",
"type": "Array"
}
],
"return": {
"description": "Boolean false if a subscriber returned false"
},
"access": "protected",
"tagname": "",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 570,
"description": "Notifies a list of subscribers.",
"itemtype": "method",
"name": "_procSubs",
"params": [
{
"name": "subs",
"description": "List of subscribers",
"type": "Array"
},
{
"name": "args",
"description": "Arguments passed to fire()",
"type": "Array"
},
{
"name": "ef",
"description": ""
}
],
"return": {
"description": "Boolean false if a subscriber returns false or stops the event\n propagation via e.stopPropagation(),\n e.stopImmediatePropagation(), or e.halt()"
},
"access": "private",
"tagname": "",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 601,
"description": "Notifies the YUI instance if the event is configured with broadcast = 1,\nand both the YUI instance and Y.Global if configured with broadcast = 2.",
"itemtype": "method",
"name": "_broadcast",
"params": [
{
"name": "args",
"description": "Arguments sent to fire()",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 625,
"description": "Removes all listeners",
"itemtype": "method",
"name": "unsubscribeAll",
"return": {
"description": "The number of listeners unsubscribed.",
"type": "Int"
},
"deprecated": true,
"deprecationMessage": "use detachAll.",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 635,
"description": "Removes all listeners",
"itemtype": "method",
"name": "detachAll",
"return": {
"description": "The number of listeners unsubscribed.",
"type": "Int"
},
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-custom.js",
"line": 644,
"description": "Deletes the subscriber from the internal store of on() and after()\nsubscribers.",
"itemtype": "method",
"name": "_delete",
"params": [
{
"name": "subscriber",
"description": "object."
}
],
"access": "private",
"tagname": "",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 21,
"description": "Cache of objects touched by the utility",
"itemtype": "property",
"name": "objs",
"static": 1,
"class": "Do",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 28,
"description": "Execute the supplied method before the specified function. Wrapping\nfunction may optionally return an instance of the following classes to\nfurther alter runtime behavior:
\n\n - Y.Do.Halt(message, returnValue)
\n - Immediatly stop execution and return\n
returnValue. No other wrapping functions will be\n executed. \n - Y.Do.AlterArgs(message, newArgArray)
\n - Replace the arguments that the original function will be\n called with.
\n - Y.Do.Prevent(message)
\n - Don't execute the wrapped function. Other before phase\n wrappers will be executed.
\n
",
"itemtype": "method",
"name": "before",
"params": [
{
"name": "fn",
"description": "the function to execute",
"type": "Function"
},
{
"name": "obj",
"description": "the object hosting the method to displace"
},
{
"name": "sFn",
"description": "the name of the method to displace",
"type": "String"
},
{
"name": "c",
"description": "The execution context for fn"
},
{
"name": "arg",
"description": "0..n additional arguments to supply to the subscriber\nwhen the event fires.",
"type": "Mixed",
"multiple": true
}
],
"return": {
"description": "handle for the subscription",
"type": "String"
},
"static": 1,
"class": "Do",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 66,
"description": "Execute the supplied method after the specified function. Wrapping\nfunction may optionally return an instance of the following classes to\nfurther alter runtime behavior:
\n\n - Y.Do.Halt(message, returnValue)
\n - Immediatly stop execution and return\n
returnValue. No other wrapping functions will be\n executed. \n - Y.Do.AlterReturn(message, returnValue)
\n - Return
returnValue instead of the wrapped\n method's original return value. This can be further altered by\n other after phase wrappers. \n
\n\nThe static properties Y.Do.originalRetVal and\nY.Do.currentRetVal will be populated for reference.
",
"itemtype": "method",
"name": "after",
"params": [
{
"name": "fn",
"description": "the function to execute",
"type": "Function"
},
{
"name": "obj",
"description": "the object hosting the method to displace"
},
{
"name": "sFn",
"description": "the name of the method to displace",
"type": "String"
},
{
"name": "c",
"description": "The execution context for fn"
},
{
"name": "arg",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Mixed",
"multiple": true
}
],
"return": {
"description": "handle for the subscription",
"type": "String"
},
"static": 1,
"class": "Do",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 103,
"description": "Execute the supplied method before or after the specified function.\nUsed by before and after.",
"itemtype": "method",
"name": "_inject",
"params": [
{
"name": "when",
"description": "before or after",
"type": "String"
},
{
"name": "fn",
"description": "the function to execute",
"type": "Function"
},
{
"name": "obj",
"description": "the object hosting the method to displace"
},
{
"name": "sFn",
"description": "the name of the method to displace",
"type": "String"
},
{
"name": "c",
"description": "The execution context for fn"
}
],
"return": {
"description": "handle for the subscription",
"type": "String"
},
"access": "private",
"tagname": "",
"static": 1,
"class": "Do",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 150,
"description": "Detach a before or after subscription.",
"itemtype": "method",
"name": "detach",
"params": [
{
"name": "handle",
"description": "the subscription handle",
"type": "String"
}
],
"static": 1,
"class": "Do",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 174,
"description": "Contains the return value from the wrapped method, accessible\nby 'after' event listeners.",
"itemtype": "property",
"name": "originalRetVal",
"static": 1,
"since": "3.2.0",
"class": "Do",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 183,
"description": "Contains the current state of the return value, consumable by\n'after' event listeners, and updated if an after subscriber\nchanges the return value generated by the wrapped function.",
"itemtype": "property",
"name": "currentRetVal",
"static": 1,
"since": "3.2.0",
"class": "Do",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 210,
"description": "Register a aop subscriber",
"itemtype": "method",
"name": "register",
"params": [
{
"name": "sid",
"description": "the subscriber id",
"type": "String"
},
{
"name": "fn",
"description": "the function to execute",
"type": "Function"
},
{
"name": "when",
"description": "when to execute the function",
"type": "String"
}
],
"class": "Do.Method",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 225,
"description": "Unregister a aop subscriber",
"itemtype": "method",
"name": "delete",
"params": [
{
"name": "sid",
"description": "the subscriber id",
"type": "String"
},
{
"name": "fn",
"description": "the function to execute",
"type": "Function"
},
{
"name": "when",
"description": "when to execute the function",
"type": "String"
}
],
"class": "Do.Method",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-do.js",
"line": 238,
"description": "Execute the wrapped method. All arguments are passed into the wrapping\nfunctions. If any of the before wrappers return an instance of\nY.Do.Halt or Y.Do.Prevent, neither the wrapped\nfunction nor any after phase subscribers will be executed.
\n\nThe return value will be the return value of the wrapped function or one\nprovided by a wrapper function via an instance of Y.Do.Halt or\nY.Do.AlterReturn.",
"itemtype": "method",
"name": "exec",
"params": [
{
"name": "arg",
"description": "Arguments are passed to the wrapping and wrapped functions",
"type": "Any",
"multiple": true
}
],
"return": {
"description": "Return value of wrapped function unless overwritten (see above)",
"type": "Any"
},
"class": "Do.Method",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 29,
"description": "The arguments passed to fire",
"itemtype": "property",
"name": "details",
"type": "Array",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 36,
"description": "The event type, this can be overridden by the fire() payload",
"itemtype": "property",
"name": "type",
"type": "string",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 43,
"description": "The real event type",
"itemtype": "property",
"name": "_type",
"type": "string",
"access": "private",
"tagname": "",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 53,
"description": "Node reference for the targeted eventtarget",
"itemtype": "property",
"name": "target",
"type": "Node",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 60,
"description": "Node reference for the element that the listener was attached to.",
"itemtype": "property",
"name": "currentTarget",
"type": "Node",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 67,
"description": "Node reference to the relatedTarget",
"itemtype": "property",
"name": "relatedTarget",
"type": "Node",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 78,
"description": "Stops the propagation to the next bubble target",
"itemtype": "method",
"name": "stopPropagation",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 87,
"description": "Stops the propagation to the next bubble target and\nprevents any additional listeners from being exectued\non the current target.",
"itemtype": "method",
"name": "stopImmediatePropagation",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 98,
"description": "Prevents the event's default behavior",
"itemtype": "method",
"name": "preventDefault",
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 107,
"description": "Stops the event propagation and prevents the default\nevent behavior.",
"itemtype": "method",
"name": "halt",
"params": [
{
"name": "immediate",
"description": "if true additional listeners\non the current target will not be executed",
"type": "Boolean"
}
],
"class": "EventFacade",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 327,
"description": "Stop propagation to bubble targets",
"itemtype": "method",
"name": "stopPropagation",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 340,
"description": "Stops propagation to bubble targets, and prevents any remaining\nsubscribers on the current target from executing.",
"itemtype": "method",
"name": "stopImmediatePropagation",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 353,
"description": "Prevents the execution of this event's defaultFn",
"itemtype": "method",
"name": "preventDefault",
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 366,
"description": "Stops the event propagation and prevents the default\nevent behavior.",
"itemtype": "method",
"name": "halt",
"params": [
{
"name": "immediate",
"description": "if true additional listeners\non the current target will not be executed",
"type": "Boolean"
}
],
"class": "CustomEvent",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 382,
"description": "Registers another EventTarget as a bubble target. Bubble order\nis determined by the order registered. Multiple targets can\nbe specified.\n\nEvents can only bubble if emitFacade is true.\n\nIncluded in the event-custom-complex submodule.",
"itemtype": "method",
"name": "addTarget",
"params": [
{
"name": "o",
"description": "the target to add",
"type": "EventTarget"
}
],
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 400,
"description": "Returns an array of bubble targets for this object.",
"itemtype": "method",
"name": "getTargets",
"return": {
"description": "EventTarget[]"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 409,
"description": "Removes a bubble target",
"itemtype": "method",
"name": "removeTarget",
"params": [
{
"name": "o",
"description": "the target to remove",
"type": "EventTarget"
}
],
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-facade.js",
"line": 419,
"description": "Propagate an event. Requires the event-custom-complex module.",
"itemtype": "method",
"name": "bubble",
"params": [
{
"name": "evt",
"description": "the custom event to propagate",
"type": "CustomEvent"
}
],
"return": {
"description": "the aggregated return value from Event.Custom.fire",
"type": "Boolean"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-complex"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 36,
"description": "If the instance has a prefix attribute and the\nevent type is not prefixed, the instance prefix is\napplied to the supplied type.",
"itemtype": "method",
"name": "_getType",
"access": "private",
"tagname": "",
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 52,
"description": "Returns an array with the detach key (if provided),\nand the prefixed event name from _getType\nY.on('detachcategory| menu:click', fn)",
"itemtype": "method",
"name": "_parseType",
"access": "private",
"tagname": "",
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 128,
"description": "Listen to a custom event hosted by this object one time.\nThis is the equivalent to on except the\nlistener is immediatelly detached when it is executed.",
"itemtype": "method",
"name": "once",
"params": [
{
"name": "type",
"description": "The name of the event",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching the\n subscription",
"type": "EventHandle"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 150,
"description": "Listen to a custom event hosted by this object one time.\nThis is the equivalent to after except the\nlistener is immediatelly detached when it is executed.",
"itemtype": "method",
"name": "onceAfter",
"params": [
{
"name": "type",
"description": "The name of the event",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching that\n subscription",
"type": "EventHandle"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 172,
"description": "Takes the type parameter passed to 'on' and parses out the\nvarious pieces that could be included in the type. If the\nevent type is passed without a prefix, it will be expanded\nto include the prefix one is supplied or the event target\nis configured with a default prefix.",
"itemtype": "method",
"name": "parseType",
"params": [
{
"name": "type",
"description": "the type",
"type": "String"
},
{
"name": "pre",
"description": "the prefix",
"type": "String",
"optional": true,
"optdefault": "this._yuievt.config.prefix"
}
],
"since": "3.3.0",
"return": {
"description": "an array containing:\n * the detach category, if supplied,\n * the prefixed event type,\n * whether or not this is an after listener,\n * the supplied event type",
"type": "Array"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 192,
"description": "Subscribe a callback function to a custom event fired by this object or\nfrom an object that bubbles its events to this object.\n\nCallback functions for events published with `emitFacade = true` will\nreceive an `EventFacade` as the first argument (typically named \"e\").\nThese callbacks can then call `e.preventDefault()` to disable the\nbehavior published to that event's `defaultFn`. See the `EventFacade`\nAPI for all available properties and methods. Subscribers to\nnon-`emitFacade` events will receive the arguments passed to `fire()`\nafter the event name.\n\nTo subscribe to multiple events at once, pass an object as the first\nargument, where the key:value pairs correspond to the eventName:callback,\nor pass an array of event names as the first argument to subscribe to\nall listed events with the same callback.\n\nReturning `false` from a callback is supported as an alternative to\ncalling `e.preventDefault(); e.stopPropagation();`. However, it is\nrecommended to use the event methods whenever possible.",
"itemtype": "method",
"name": "on",
"params": [
{
"name": "type",
"description": "The name of the event",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching that\n subscription",
"type": "EventHandle"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 335,
"description": "subscribe to an event",
"itemtype": "method",
"name": "subscribe",
"deprecated": true,
"deprecationMessage": "use on",
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 345,
"description": "Detach one or more listeners the from the specified event",
"itemtype": "method",
"name": "detach",
"params": [
{
"name": "type",
"description": "Either the handle to the subscriber or the\n type of event. If the type\n is not specified, it will attempt to remove\n the listener from all hosted events.",
"type": "String|Object"
},
{
"name": "fn",
"description": "The subscribed function to unsubscribe, if not\n supplied, all subscribers will be removed.",
"type": "Function"
},
{
"name": "context",
"description": "The custom object passed to subscribe. This is\n optional, but if supplied will be used to\n disambiguate multiple listeners that are the same\n (e.g., you subscribe many object using a function\n that lives on the prototype)",
"type": "Object"
}
],
"return": {
"description": "the host",
"type": "EventTarget"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 455,
"description": "detach a listener",
"itemtype": "method",
"name": "unsubscribe",
"deprecated": true,
"deprecationMessage": "use detach",
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 465,
"description": "Removes all listeners from the specified event. If the event type\nis not specified, all listeners from all hosted custom events will\nbe removed.",
"itemtype": "method",
"name": "detachAll",
"params": [
{
"name": "type",
"description": "The type, or name of the event",
"type": "String"
}
],
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 476,
"description": "Removes all listeners from the specified event. If the event type\nis not specified, all listeners from all hosted custom events will\nbe removed.",
"itemtype": "method",
"name": "unsubscribeAll",
"params": [
{
"name": "type",
"description": "The type, or name of the event",
"type": "String"
}
],
"deprecated": true,
"deprecationMessage": "use detachAll",
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 489,
"description": "Creates a new custom event of the specified type. If a custom event\nby that name already exists, it will not be re-created. In either\ncase the custom event is returned.",
"itemtype": "method",
"name": "publish",
"params": [
{
"name": "type",
"description": "the type, or name of the event",
"type": "String"
},
{
"name": "opts",
"description": "optional config params. Valid properties are:\n\n
\n - \n 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)\n
\n - \n 'bubbles': whether or not this event bubbles (true)\n Events can only bubble if emitFacade is true.\n
\n - \n 'context': the default execution context for the listeners (this)\n
\n - \n 'defaultFn': the default function to execute when this event fires if preventDefault was not called\n
\n - \n 'emitFacade': whether or not this event emits a facade (false)\n
\n - \n 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'\n
\n - \n 'fireOnce': if an event is configured to fire once, new subscribers after\n the fire will be notified immediately.\n
\n - \n 'async': fireOnce event listeners will fire synchronously if the event has already\n fired unless async is true.\n
\n - \n 'preventable': whether or not preventDefault() has an effect (true)\n
\n - \n 'preventedFn': a function that is executed when preventDefault is called\n
\n - \n 'queuable': whether or not this event can be queued during bubbling (false)\n
\n - \n 'silent': if silent is true, debug messages are not provided for this event.\n
\n - \n 'stoppedFn': a function that is executed when stopPropagation is called\n
\n\n - \n 'monitored': specifies whether or not this event should send notifications about\n when the event has been attached, detached, or published.\n
\n - \n 'type': the event type (valid option if not provided as the first parameter to publish)\n
\n
",
"type": "Object"
}
],
"return": {
"description": "the custom event",
"type": "CustomEvent"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 602,
"description": "This is the entry point for the event monitoring system.\nYou can monitor 'attach', 'detach', 'fire', and 'publish'.\nWhen configured, these events generate an event. click ->\nclick_attach, click_detach, click_publish -- these can\nbe subscribed to like other events to monitor the event\nsystem. Inividual published events can have monitoring\nturned on or off (publish can't be turned off before it\nit published) by setting the events 'monitor' config.",
"itemtype": "method",
"name": "_monitor",
"params": [
{
"name": "what",
"description": "'attach', 'detach', 'fire', or 'publish'",
"type": "String"
},
{
"name": "type",
"description": "Name of the event being monitored",
"type": "String"
},
{
"name": "o",
"description": "Information about the event interaction, such as\n fire() args, subscription category, publish config",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 629,
"description": "Fire a custom event by name. The callback functions will be executed\nfrom the context specified when the event was created, and with the\nfollowing parameters.\n\nIf the custom event object hasn't been created, then the event hasn't\nbeen published and it has no subscribers. For performance sake, we\nimmediate exit in this case. This means the event won't bubble, so\nif the intention is that a bubble target be notified, the event must\nbe published on this object first.\n\nThe first argument is the event type, and any additional arguments are\npassed to the listeners as parameters. If the first of these is an\nobject literal, and the event is configured to emit an event facade,\nthat object is mixed into the event facade and the facade is provided\nin place of the original object.",
"itemtype": "method",
"name": "fire",
"params": [
{
"name": "type",
"description": "The type of the event, or an object that contains\na 'type' property.",
"type": "String|Object"
},
{
"name": "arguments",
"description": "an arbitrary set of parameters to pass to\nthe handler. If the first of these is an object literal and the event is\nconfigured to emit an event facade, the event facade will replace that\nparameter after the properties the object literal contains are copied to\nthe event facade.",
"type": "Object*"
}
],
"return": {
"description": "the event host",
"type": "EventTarget"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 712,
"description": "Returns the custom event of the provided type has been created, a\nfalsy value otherwise",
"itemtype": "method",
"name": "getEvent",
"params": [
{
"name": "type",
"description": "the type, or name of the event",
"type": "String"
},
{
"name": "prefixed",
"description": "if true, the type is prefixed already",
"type": "String"
}
],
"return": {
"description": "the custom event or null",
"type": "CustomEvent"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 730,
"description": "Subscribe to a custom event hosted by this object. The\nsupplied callback will execute after any listeners add\nvia the subscribe method, and after the default function,\nif configured for the event, has executed.",
"itemtype": "method",
"name": "after",
"params": [
{
"name": "type",
"description": "The name of the event",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching the\n subscription",
"type": "EventHandle"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 767,
"description": "Executes the callback before a DOM event, custom event\nor method. If the first argument is a function, it\nis assumed the target is a method. For DOM and custom\nevents, this is an alias for Y.on.\n\nFor DOM and custom events:\ntype, callback, context, 0-n arguments\n\nFor methods:\ncallback, object (method host), methodName, context, 0-n arguments",
"itemtype": "method",
"name": "before",
"return": {
"description": "detach handle"
},
"class": "EventTarget",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 796,
"description": "Hosts YUI page level events. This is where events bubble to\nwhen the broadcast config is set to 2. This property is\nonly available if the custom event module is loaded.",
"itemtype": "property",
"name": "Global",
"type": "EventTarget",
"class": "YUI",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 808,
"description": "`Y.on()` can do many things:\n\n\n - Subscribe to custom events `publish`ed and `fire`d from Y
\n - Subscribe to custom events `publish`ed with `broadcast` 1 or 2 and\n `fire`d from any object in the YUI instance sandbox
\n - Subscribe to DOM events
\n - Subscribe to the execution of a method on any object, effectively\n treating that method as an event
\n
\n\nFor custom event subscriptions, pass the custom event name as the first argument and callback as the second. The `this` object in the callback will be `Y` unless an override is passed as the third argument.\n\n Y.on('io:complete', function () {\n Y.MyApp.updateStatus('Transaction complete');\n });\n\nTo subscribe to DOM events, pass the name of a DOM event as the first argument\nand a CSS selector string as the third argument after the callback function.\nAlternately, the third argument can be a `Node`, `NodeList`, `HTMLElement`,\narray, or simply omitted (the default is the `window` object).\n\n Y.on('click', function (e) {\n e.preventDefault();\n\n // proceed with ajax form submission\n var url = this.get('action');\n ...\n }, '#my-form');\n\nThe `this` object in DOM event callbacks will be the `Node` targeted by the CSS\nselector or other identifier.\n\n`on()` subscribers for DOM events or custom events `publish`ed with a\n`defaultFn` can prevent the default behavior with `e.preventDefault()` from the\nevent object passed as the first parameter to the subscription callback.\n\nTo subscribe to the execution of an object method, pass arguments corresponding to the call signature for \n`Y.Do.before(...)`.\n\nNOTE: The formal parameter list below is for events, not for function\ninjection. See `Y.Do.before` for that signature.",
"itemtype": "method",
"name": "on",
"params": [
{
"name": "type",
"description": "DOM or custom event name",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching the\n subscription",
"type": "EventHandle"
},
"see": [
"Do.before"
],
"class": "YUI",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 863,
"description": "Listen for an event one time. Equivalent to `on()`, except that\nthe listener is immediately detached when executed.\n\nSee the `on()` method for additional subscription\noptions.",
"see": [
"on"
],
"itemtype": "method",
"name": "once",
"params": [
{
"name": "type",
"description": "DOM or custom event name",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching the\n subscription",
"type": "EventHandle"
},
"class": "YUI",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 881,
"description": "Listen for an event one time. Equivalent to `once()`, except, like `after()`,\nthe subscription callback executes after all `on()` subscribers and the event's\n`defaultFn` (if configured) have executed. Like `after()` if any `on()` phase\nsubscriber calls `e.preventDefault()`, neither the `defaultFn` nor the `after()`\nsubscribers will execute.\n\nThe listener is immediately detached when executed.\n\nSee the `on()` method for additional subscription\noptions.",
"see": [
"once"
],
"itemtype": "method",
"name": "onceAfter",
"params": [
{
"name": "type",
"description": "The custom event name",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching the\n subscription",
"type": "EventHandle"
},
"class": "YUI",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/event-target.js",
"line": 904,
"description": "Like `on()`, this method creates a subscription to a custom event or to the\nexecution of a method on an object.\n\nFor events, `after()` subscribers are executed after the event's\n`defaultFn` unless `e.preventDefault()` was called from an `on()` subscriber.\n\nSee the `on()` method for additional subscription\noptions.\n\nNOTE: The subscription signature shown is for events, not for function\ninjection. See `Y.Do.after`\nfor that signature.",
"see": [
"on",
"Do.after"
],
"itemtype": "method",
"name": "after",
"params": [
{
"name": "type",
"description": "The custom event name",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "args*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching the\n subscription",
"type": "EventHandle"
},
"class": "YUI",
"module": "event-custom",
"submodule": "event-custom-base"
},
{
"file": "lib/yui3/src/event-custom/js/handle.js",
"line": 10,
"description": "The custom event",
"itemtype": "property",
"name": "evt",
"type": "CustomEvent",
"class": "EventHandle",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/handle.js",
"line": 18,
"description": "The subscriber object",
"itemtype": "property",
"name": "sub",
"type": "Subscriber",
"class": "EventHandle",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/handle.js",
"line": 37,
"description": "Detaches this subscriber",
"itemtype": "method",
"name": "detach",
"return": {
"description": "the number of detached listeners",
"type": "Int"
},
"class": "EventHandle",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/handle.js",
"line": 60,
"description": "Monitor the event state for the subscribed event. The first parameter\nis what should be monitored, the rest are the normal parameters when\nsubscribing to an event.",
"itemtype": "method",
"name": "monitor",
"params": [
{
"name": "what",
"description": "what to monitor ('attach', 'detach', 'publish').",
"type": "String"
}
],
"return": {
"description": "return value from the monitor event subscription.",
"type": "EventHandle"
},
"class": "EventHandle",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/subscriber.js",
"line": 12,
"description": "The callback that will be execute when the event fires\nThis is wrapped by Y.rbind if obj was supplied.",
"itemtype": "property",
"name": "fn",
"type": "Function",
"class": "Subscriber",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/subscriber.js",
"line": 20,
"description": "Optional 'this' keyword for the listener",
"itemtype": "property",
"name": "context",
"type": "Object",
"class": "Subscriber",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/subscriber.js",
"line": 27,
"description": "Unique subscriber id",
"itemtype": "property",
"name": "id",
"type": "String",
"class": "Subscriber",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/subscriber.js",
"line": 34,
"description": "Additional arguments to propagate to the subscriber",
"itemtype": "property",
"name": "args",
"type": "Array",
"class": "Subscriber",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/subscriber.js",
"line": 41,
"description": "Custom events for a given fire transaction.",
"itemtype": "property",
"name": "events",
"type": "{EventTarget}",
"class": "Subscriber",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/subscriber.js",
"line": 48,
"description": "This listener only reacts to the event once",
"itemtype": "property",
"name": "once",
"class": "Subscriber",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/subscriber.js",
"line": 94,
"description": "Executes the subscriber.",
"itemtype": "method",
"name": "notify",
"params": [
{
"name": "args",
"description": "Arguments array for the subscriber.",
"type": "Array"
},
{
"name": "ce",
"description": "The custom event that sent the notification.",
"type": "CustomEvent"
}
],
"class": "Subscriber",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-custom/js/subscriber.js",
"line": 122,
"description": "Returns true if the fn and obj match this objects properties.\nUsed by the unsubscribe method to match the right subscriber.",
"itemtype": "method",
"name": "contains",
"params": [
{
"name": "fn",
"description": "the function to execute.",
"type": "Function"
},
{
"name": "context",
"description": "optional 'this' keyword for the listener.",
"type": "Object"
}
],
"return": {
"description": "true if the supplied arguments match this\n subscriber's signature.",
"type": "Boolean"
},
"class": "Subscriber",
"module": "event-custom"
},
{
"file": "lib/yui3/src/event-gestures/js/Flick.js",
"line": 46,
"description": "Sets up a \"flick\" event, that is fired whenever the user initiates a flick gesture on the node\nwhere the listener is attached. The subscriber can specify a minimum distance or velocity for\nwhich the event is to be fired. The subscriber can also specify if there is a particular axis which\nthey are interested in - \"x\" or \"y\". If no axis is specified, the axis along which there was most distance\ncovered is used.\n\nIt is recommended that you use Y.bind to set up context and additional arguments for your event handler,\nhowever if you want to pass the context and arguments as additional signature arguments to \"on\", \nyou need to provide a null value for the configuration object, e.g: node.on(\"flick\", fn, null, context, arg1, arg2, arg3)
",
"itemtype": "event",
"name": "flick",
"params": [
{
"name": "type",
"description": "\"flick\"",
"type": "String"
},
{
"name": "fn",
"description": "The method the event invokes. It receives an event facade with an e.flick object containing the flick related properties: e.flick.time, e.flick.distance, e.flick.velocity and e.flick.axis, e.flick.start.",
"type": "Function"
},
{
"name": "cfg",
"description": "Optional. An object which specifies any of the following:\n\n- minDistance (in pixels, defaults to 10)
\n- The minimum distance between start and end points, which would qualify the gesture as a flick.
\n- minVelocity (in pixels/ms, defaults to 0)
\n- The minimum velocity which would qualify the gesture as a flick.
\n- preventDefault (defaults to false)
\n- Can be set to true/false to prevent default behavior as soon as the touchstart/touchend or mousedown/mouseup is received so that things like scrolling or text selection can be \nprevented. This property can also be set to a function, which returns true or false, based on the event facade passed to it.
\n- axis (no default)
\n- Can be set to \"x\" or \"y\" if you want to constrain the flick velocity and distance to a single axis. If not\ndefined, the axis along which the maximum distance was covered is used.
\n
",
"type": "Object"
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event-gestures",
"submodule": "event-flick"
},
{
"file": "lib/yui3/src/event-gestures/js/Move.js",
"line": 89,
"description": "Sets up a \"gesturemovestart\" event, that is fired on touch devices in response to a single finger \"touchstart\",\nand on mouse based devices in response to a \"mousedown\". The subscriber can specify the minimum time\nand distance thresholds which should be crossed before the \"gesturemovestart\" is fired and for the mouse,\nwhich button should initiate a \"gesturemovestart\". This event can also be listened for using node.delegate().\n\nIt is recommended that you use Y.bind to set up context and additional arguments for your event handler,\nhowever if you want to pass the context and arguments as additional signature arguments to on/delegate, \nyou need to provide a null value for the configuration object, e.g: node.on(\"gesturemovestart\", fn, null, context, arg1, arg2, arg3)
",
"itemtype": "event",
"name": "gesturemovestart",
"params": [
{
"name": "type",
"description": "\"gesturemovestart\"",
"type": "String"
},
{
"name": "fn",
"description": "The method the event invokes. It receives the event facade of the underlying DOM event (mousedown or touchstart.touches[0]) which contains position co-ordinates.",
"type": "Function"
},
{
"name": "cfg",
"description": "Optional. An object which specifies:\n\n\n- minDistance (defaults to 0)
\n- The minimum distance threshold which should be crossed before the gesturemovestart is fired
\n- minTime (defaults to 0)
\n- The minimum time threshold for which the finger/mouse should be help down before the gesturemovestart is fired
\n- button (no default)
\n- In the case of a mouse input device, if the event should only be fired for a specific mouse button.
\n- preventDefault (defaults to false)
\n- Can be set to true/false to prevent default behavior as soon as the touchstart or mousedown is received (that is before minTime or minDistance thresholds are crossed, and so before the gesturemovestart listener is notified) so that things like text selection and context popups (on touch devices) can be \nprevented. This property can also be set to a function, which returns true or false, based on the event facade passed to it (for example, DragDrop can determine if the target is a valid handle or not before preventing default).
\n
",
"type": "Object"
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event-gestures",
"submodule": "event-move"
},
{
"file": "lib/yui3/src/event-gestures/js/Move.js",
"line": 276,
"description": "Sets up a \"gesturemove\" event, that is fired on touch devices in response to a single finger \"touchmove\",\nand on mouse based devices in response to a \"mousemove\".\n\nBy default this event is only fired when the same node\nhas received a \"gesturemovestart\" event. The subscriber can set standAlone to true, in the configuration properties,\nif they want to listen for this event without an initial \"gesturemovestart\".
\n\nBy default this event sets up it's internal \"touchmove\" and \"mousemove\" DOM listeners on the document element. The subscriber\ncan set the root configuration property, to specify which node to attach DOM listeners to, if different from the document.
\n\nThis event can also be listened for using node.delegate().
\n\nIt is recommended that you use Y.bind to set up context and additional arguments for your event handler,\nhowever if you want to pass the context and arguments as additional signature arguments to on/delegate, \nyou need to provide a null value for the configuration object, e.g: node.on(\"gesturemove\", fn, null, context, arg1, arg2, arg3)
",
"itemtype": "event",
"name": "gesturemove",
"params": [
{
"name": "type",
"description": "\"gesturemove\"",
"type": "String"
},
{
"name": "fn",
"description": "The method the event invokes. It receives the event facade of the underlying DOM event (mousemove or touchmove.touches[0]) which contains position co-ordinates.",
"type": "Function"
},
{
"name": "cfg",
"description": "Optional. An object which specifies:\n\n- standAlone (defaults to false)
\n- true, if the subscriber should be notified even if a \"gesturemovestart\" has not occured on the same node.
\n- root (defaults to document)
\n- The node to which the internal DOM listeners should be attached.
\n- preventDefault (defaults to false)
\n- Can be set to true/false to prevent default behavior as soon as the touchmove or mousemove is received. As with gesturemovestart, can also be set to function which returns true/false based on the event facade passed to it.
\n
",
"type": "Object"
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event-gestures",
"submodule": "event-move"
},
{
"file": "lib/yui3/src/event-gestures/js/Move.js",
"line": 395,
"description": "Sets up a \"gesturemoveend\" event, that is fired on touch devices in response to a single finger \"touchend\",\nand on mouse based devices in response to a \"mouseup\".\n\nBy default this event is only fired when the same node\nhas received a \"gesturemove\" or \"gesturemovestart\" event. The subscriber can set standAlone to true, in the configuration properties,\nif they want to listen for this event without a preceding \"gesturemovestart\" or \"gesturemove\".
\n\nBy default this event sets up it's internal \"touchend\" and \"mouseup\" DOM listeners on the document element. The subscriber\ncan set the root configuration property, to specify which node to attach DOM listeners to, if different from the document.
\n\nThis event can also be listened for using node.delegate().
\n\nIt is recommended that you use Y.bind to set up context and additional arguments for your event handler,\nhowever if you want to pass the context and arguments as additional signature arguments to on/delegate, \nyou need to provide a null value for the configuration object, e.g: node.on(\"gesturemoveend\", fn, null, context, arg1, arg2, arg3)
",
"itemtype": "event",
"name": "gesturemoveend",
"params": [
{
"name": "type",
"description": "\"gesturemoveend\"",
"type": "String"
},
{
"name": "fn",
"description": "The method the event invokes. It receives the event facade of the underlying DOM event (mouseup or touchend.changedTouches[0]).",
"type": "Function"
},
{
"name": "cfg",
"description": "Optional. An object which specifies:\n\n- standAlone (defaults to false)
\n- true, if the subscriber should be notified even if a \"gesturemovestart\" or \"gesturemove\" has not occured on the same node.
\n- root (defaults to document)
\n- The node to which the internal DOM listeners should be attached.
\n- preventDefault (defaults to false)
\n- Can be set to true/false to prevent default behavior as soon as the touchend or mouseup is received. As with gesturemovestart, can also be set to function which returns true/false based on the event facade passed to it.
\n
",
"type": "Object"
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "YUI",
"module": "event-gestures",
"submodule": "event-move"
},
{
"file": "lib/yui3/src/event-simulate/js/event-simulate.js",
"line": 568,
"description": "Simulates the event with the given name on a target.",
"params": [
{
"name": "target",
"description": "The DOM element that's the target of the event.",
"type": "HTMLElement"
},
{
"name": "type",
"description": "The type of event to simulate (i.e., \"click\").",
"type": "String"
},
{
"name": "options",
"description": "(Optional) Extra options to copy onto the event object.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "simulate",
"static": 1,
"class": "Event",
"module": "event-simulate"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 24,
"description": "Interval (in milliseconds) at which to poll for changes to the value of\nan element with one or more valueChange subscribers when the\nuser is likely to be interacting with it.",
"itemtype": "property",
"name": "POLL_INTERVAL",
"type": "Number",
"default": "50",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 36,
"description": "Timeout (in milliseconds) after which to stop polling when there hasn't\nbeen any new activity (keypresses, mouse clicks, etc.) on an element.",
"itemtype": "property",
"name": "TIMEOUT",
"type": "Number",
"default": "10000",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 55,
"description": "Called at an interval to poll for changes to the value of the specified\nnode.",
"itemtype": "method",
"name": "_poll",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
},
{
"name": "stamp",
"description": "",
"type": "String"
},
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 95,
"description": "Restarts the inactivity timeout for the specified node.",
"itemtype": "method",
"name": "_refreshTimeout",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
},
{
"name": "stamp",
"description": "",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 116,
"description": "Begins polling for changes to the value property of the\nspecified node. If polling is already underway for the specified node,\nit will not be restarted unless the force parameter is\ntrue",
"itemtype": "method",
"name": "_startPolling",
"params": [
{
"name": "node",
"description": "Node to watch.",
"type": "Node"
},
{
"name": "stamp",
"description": "(optional) Object stamp for the node. Will be\n generated if not provided (provide it to improve performance).",
"type": "String"
},
{
"name": "e",
"description": "(optional) Event facade of the event that\n initiated the polling (if any).",
"type": "EventFacade"
},
{
"name": "force",
"description": "(optional) If true, polling will be\n restarted even if we're already polling this node.",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 158,
"description": "Stops polling for changes to the specified node's value\nattribute.",
"itemtype": "method",
"name": "_stopPolling",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
},
{
"name": "stamp",
"description": "(optional)",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 179,
"description": "Clears the inactivity timeout for the specified node, if any.",
"itemtype": "method",
"name": "_stopTimeout",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
},
{
"name": "stamp",
"description": "(optional)",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 198,
"description": "Stops polling when a node's blur event fires.",
"itemtype": "method",
"name": "_onBlur",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 210,
"description": "Resets a node's history and starts polling when a focus event occurs.",
"itemtype": "method",
"name": "_onFocus",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 225,
"description": "Starts polling when a node receives a keyDown event.",
"itemtype": "method",
"name": "_onKeyDown",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 237,
"description": "Starts polling when an IME-related keyUp event occurs on a node.",
"itemtype": "method",
"name": "_onKeyUp",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 253,
"description": "Starts polling when a node receives a mouseDown event.",
"itemtype": "method",
"name": "_onMouseDown",
"params": [
{
"name": "e",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 265,
"description": "Called when event-valuechange receives a new subscriber.",
"itemtype": "method",
"name": "_onSubscribe",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
},
{
"name": "subscription",
"description": "",
"type": "Subscription"
},
{
"name": "notifier",
"description": "",
"type": "SyntheticEvent.Notifier"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 296,
"description": "Called when event-valuechange loses a subscriber.",
"itemtype": "method",
"name": "_onUnsubscribe",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
},
{
"name": "subscription",
"description": "",
"type": "Subscription"
},
{
"name": "notifier",
"description": "",
"type": "SyntheticEvent.Notifier"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "ValueChange",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/event-valuechange/js/event-valuechange.js",
"line": 326,
"description": "\nSynthetic event that fires when the value property of an input\nfield or textarea changes as a result of a keystroke, mouse operation, or\ninput method editor (IME) input event.\n
\n\n\nUnlike the onchange event, this event fires when the value\nactually changes and not when the element loses focus. This event also\nreports IME and multi-stroke input more reliably than oninput or\nthe various key events across browsers.\n
",
"example": [
"\n\n YUI().use('event-valuechange', function (Y) {\n Y.one('input').on('valueChange', function (e) {\n // Handle valueChange events on the first input element on the page.\n });\n });"
],
"itemtype": "event",
"name": "valueChange",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n\n - prevVal (String)
\n - \n Previous value before the latest change.\n
\n\n - newVal (String)
\n - \n New value after the latest change.\n
\n
",
"type": "EventFacade"
}
],
"class": "YUI",
"module": "event-valuechange"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 54,
"description": "Used as value for the _rounding method.",
"itemtype": "property",
"name": "_rounder",
"access": "private",
"tagname": "",
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 62,
"description": "Updates the matrix.",
"itemtype": "method",
"name": "multiple",
"params": [
{
"name": "a",
"description": "",
"type": "Number"
},
{
"name": "b",
"description": "",
"type": "Number"
},
{
"name": "c",
"description": "",
"type": "Number"
},
{
"name": "d",
"description": "",
"type": "Number"
},
{
"name": "dx",
"description": "",
"type": "Number"
},
{
"name": "dy",
"description": "",
"type": "Number"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 91,
"description": "Parses a string and updates the matrix.",
"itemtype": "method",
"name": "applyCSSText",
"params": [
{
"name": "val",
"description": "A css transform string",
"type": "String"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 111,
"description": "Parses a string and returns an array of transform arrays.",
"itemtype": "method",
"name": "applyCSSText",
"params": [
{
"name": "val",
"description": "A css transform string",
"type": "String"
}
],
"return": {
"description": "Array"
},
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 134,
"description": "Default values for the matrix",
"itemtype": "property",
"name": "_defaults",
"access": "private",
"tagname": "",
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 149,
"description": "Rounds values",
"itemtype": "method",
"name": "_round",
"access": "private",
"tagname": "",
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 160,
"description": "Initializes a matrix.",
"itemtype": "method",
"name": "init",
"params": [
{
"name": "config",
"description": "Specified key value pairs for matrix properties. If a property is not explicitly defined in the config argument,\nthe default value will be used.",
"type": "Object"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 183,
"description": "Applies a scale transform",
"itemtype": "method",
"name": "scale",
"params": [
{
"name": "val",
"description": "",
"type": "Number"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 194,
"description": "Applies a skew transformation.",
"itemtype": "method",
"name": "skew",
"params": [
{
"name": "x",
"description": "The value to skew on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to skew on the y-axis.",
"type": "Number"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 218,
"description": "Applies a skew to the x-coordinate",
"itemtype": "method",
"name": "skewX",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 229,
"description": "Applies a skew to the y-coordinate",
"itemtype": "method",
"name": "skewY",
"params": [
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 240,
"description": "Returns a string of text that can be used to populate a the css transform property of an element.",
"itemtype": "method",
"name": "toCSSText",
"return": {
"description": "String"
},
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 274,
"description": "Returns a string that can be used to populate the css filter property of an element.",
"itemtype": "method",
"name": "toFilterText",
"return": {
"description": "String"
},
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 294,
"description": "Converts a radian value to a degree.",
"itemtype": "method",
"name": "rad2deg",
"params": [
{
"name": "rad",
"description": "Radian value to be converted.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 306,
"description": "Converts a degree value to a radian.",
"itemtype": "method",
"name": "deg2rad",
"params": [
{
"name": "deg",
"description": "Degree value to be converted to radian.",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 328,
"description": "Applies a rotate transform.",
"itemtype": "method",
"name": "rotate",
"params": [
{
"name": "deg",
"description": "The degree of the rotation.",
"type": "Number"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 343,
"description": "Applies translate transformation.",
"itemtype": "method",
"name": "translate",
"params": [
{
"name": "x",
"description": "The value to transate on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to translate on the y-axis.",
"type": "Number"
}
],
"class": "Matrix",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 377,
"description": "Initializes the attributes for a shape. If an attribute config is passed into the constructor of the host, \nthe initial values will be overwritten.",
"itemtype": "method",
"name": "addAttrs",
"params": [
{
"name": "cfg",
"description": "Optional object containing attributes key value pairs to be set.",
"type": "Object"
}
],
"class": "AttributeLite",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 446,
"description": "For a given item, returns the value of the property requested, or undefined if not found.",
"itemtype": "method",
"name": "get",
"params": [
{
"name": "name",
"description": "The name of the item",
"type": "String"
}
],
"return": {
"description": "The value of the supplied property.",
"type": "Any"
},
"class": "AttributeLite",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 475,
"description": "Sets the value of an attribute.",
"itemtype": "method",
"name": "set",
"params": [
{
"name": "name",
"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",
"type": "String|Object"
},
{
"name": "value",
"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",
"type": "Any"
}
],
"class": "AttributeLite",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 503,
"description": "Provides setter logic. Used by `set`.",
"itemtype": "method",
"name": "_set",
"params": [
{
"name": "name",
"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",
"type": "String|Object"
},
{
"name": "value",
"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",
"type": "Any"
}
],
"access": "protected",
"tagname": "",
"class": "AttributeLite",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 573,
"description": "Init method, invoked during construction.\nFires an init event after calling `initializer` on implementers.",
"itemtype": "method",
"name": "init",
"access": "protected",
"tagname": "",
"class": "BaseGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 610,
"description": "Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.",
"itemtype": "method",
"name": "lineTo",
"params": [
{
"name": "point1",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "point2",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "Drawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 617,
"description": "Moves the current drawing position to specified x and y coordinates.",
"itemtype": "method",
"name": "moveTo",
"params": [
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "Drawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 624,
"description": "Draws a bezier curve.",
"itemtype": "method",
"name": "curveTo",
"params": [
{
"name": "cp1x",
"description": "x-coordinate for the first control point.",
"type": "Number"
},
{
"name": "cp1y",
"description": "y-coordinate for the first control point.",
"type": "Number"
},
{
"name": "cp2x",
"description": "x-coordinate for the second control point.",
"type": "Number"
},
{
"name": "cp2y",
"description": "y-coordinate for the second control point.",
"type": "Number"
},
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "Drawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 635,
"description": "Draws a quadratic bezier curve.",
"itemtype": "method",
"name": "quadraticCurveTo",
"params": [
{
"name": "cpx",
"description": "x-coordinate for the control point.",
"type": "Number"
},
{
"name": "cpy",
"description": "y-coordinate for the control point.",
"type": "Number"
},
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "Drawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 644,
"description": "Draws a rectangle.",
"itemtype": "method",
"name": "drawRect",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
}
],
"class": "Drawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 653,
"description": "Draws a rectangle with rounded corners.",
"itemtype": "method",
"name": "drawRoundRect",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
},
{
"name": "ew",
"description": "width of the ellipse used to draw the rounded corners",
"type": "Number"
},
{
"name": "eh",
"description": "height of the ellipse used to draw the rounded corners",
"type": "Number"
}
],
"class": "Drawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 664,
"description": "Completes a drawing operation.",
"itemtype": "method",
"name": "end",
"class": "Drawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 669,
"description": "Clears the path.",
"itemtype": "method",
"name": "clear",
"class": "Drawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 701,
"description": "Init method, invoked during construction.\nCalls `initializer` method.",
"itemtype": "method",
"name": "init",
"access": "protected",
"tagname": "",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 708,
"description": "Initializes the shape",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "initializer",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 714,
"description": "Add a class name to each node.",
"itemtype": "method",
"name": "addClass",
"params": [
{
"name": "className",
"description": "the class name to add to the node's class attribute",
"type": "String"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 720,
"description": "Removes a class name from each node.",
"itemtype": "method",
"name": "removeClass",
"params": [
{
"name": "className",
"description": "the class name to remove from the node's class attribute",
"type": "String"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 726,
"description": "Gets the current position of the node in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "Array The XY position of the shape."
},
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 732,
"description": "Set the position of the shape in page coordinates, regardless of how the node is positioned.",
"itemtype": "method",
"name": "setXY",
"params": [
{
"name": "Contains",
"description": "x & y values for new position (coordinates are page-based)",
"type": "Array"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 738,
"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",
"itemtype": "method",
"name": "contains",
"params": [
{
"name": "needle",
"description": "The possible node or descendent",
"type": "Shape | HTMLElement"
}
],
"return": {
"description": "Boolean Whether or not this shape is the needle or its ancestor."
},
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 745,
"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",
"itemtype": "method",
"name": "compareTo",
"params": [
{
"name": "refNode",
"description": "The reference node to compare to the node.",
"type": "HTMLElement | Node"
}
],
"return": {
"description": "True if the nodes match, false if they do not.",
"type": "Boolean"
},
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 752,
"description": "Test if the supplied node matches the supplied selector.",
"itemtype": "method",
"name": "test",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "Boolean Wheter or not the shape matches the selector."
},
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 759,
"description": "Sets the value of an attribute.",
"itemtype": "method",
"name": "set",
"params": [
{
"name": "name",
"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",
"type": "String|Object"
},
{
"name": "value",
"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",
"type": "Any"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 768,
"description": "Specifies a 2d translation.",
"itemtype": "method",
"name": "translate",
"params": [
{
"name": "x",
"description": "The value to transate on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to translate on the y-axis.",
"type": "Number"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 775,
"description": "Translates the shape along the x-axis. When translating x and y coordinates,\nuse the `translate` method.",
"itemtype": "method",
"name": "translateX",
"params": [
{
"name": "x",
"description": "The value to translate.",
"type": "Number"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 782,
"description": "Translates the shape along the y-axis. When translating x and y coordinates,\nuse the `translate` method.",
"itemtype": "method",
"name": "translateY",
"params": [
{
"name": "y",
"description": "The value to translate.",
"type": "Number"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 789,
"description": "Skews the shape around the x-axis and y-axis.",
"itemtype": "method",
"name": "skew",
"params": [
{
"name": "x",
"description": "The value to skew on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to skew on the y-axis.",
"type": "Number"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 796,
"description": "Skews the shape around the x-axis.",
"itemtype": "method",
"name": "skewX",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 802,
"description": "Skews the shape around the y-axis.",
"itemtype": "method",
"name": "skewY",
"params": [
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 808,
"description": "Rotates the shape clockwise around it transformOrigin.",
"itemtype": "method",
"name": "rotate",
"params": [
{
"name": "deg",
"description": "The degree of the rotation.",
"type": "Number"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 814,
"description": "Specifies a 2d scaling operation.",
"itemtype": "method",
"name": "scale",
"params": [
{
"name": "val",
"description": "",
"type": "Number"
}
],
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 820,
"description": "Returns the bounds for a shape.\n\nCalculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.\nThe calculated bounding box is used by the graphic instance to calculate its viewBox.",
"itemtype": "method",
"name": "getBounds",
"return": {
"description": "Object"
},
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 829,
"description": "Destroys the instance.",
"itemtype": "method",
"name": "destroy",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 834,
"description": "An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a \nfraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].",
"itemtype": "config",
"name": "transformOrigin",
"type": "Array",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 841,
"description": "A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:\n \n
\n - rotate
- Rotates the shape clockwise around it transformOrigin.
\n - translate
- Specifies a 2d translation.
\n - skew
- Skews the shape around the x-axis and y-axis.
\n - scale
- Specifies a 2d scaling operation.
\n - translateX
- Translates the shape along the x-axis.
\n - translateY
- Translates the shape along the y-axis.
\n - skewX
- Skews the shape around the x-axis.
\n - skewY
- Skews the shape around the y-axis.
\n
\n\nApplying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform\nthat will apply the transform to the current matrix. The below code illustrates how you might use the `transform` attribute to instantiate a recangle with a rotation of 45 degrees.
\n var myRect = new Y.Rect({\n type:\"rect\",\n width: 50,\n height: 40,\n transform: \"rotate(45)\"\n };\nThe code below would apply `translate` and `rotate` to an existing shape.
\n \n myRect.set(\"transform\", \"translate(40, 50) rotate(45)\");",
"itemtype": "config",
"name": "transform",
"type": "String",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 869,
"description": "Unique id for class instance.",
"itemtype": "config",
"name": "id",
"type": "String",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 875,
"description": "Indicates the x position of shape.",
"itemtype": "config",
"name": "x",
"type": "Number",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 881,
"description": "Indicates the y position of shape.",
"itemtype": "config",
"name": "y",
"type": "Number",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 887,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 893,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 899,
"description": "Indicates whether the shape is visible.",
"itemtype": "config",
"name": "visible",
"type": "Boolean",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 905,
"description": "Contains information about the fill of the shape. \n \n - color
- The color of the fill.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.
\n - type
- Type of fill.\n
\n - solid
- Solid single color fill. (default)
\n - linear
- Linear gradient fill.
\n - radial
- Radial gradient fill.
\n
\n \n
\n If a `linear` or `radial` is specified as the fill type. The following additional property is used:\n
\n - stops
- An array of objects containing the following properties:\n
\n - color
- The color of the stop.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8
\n - offset
- Number between 0 and 1 indicating where the color stop is positioned.
\n
\n \n Linear gradients also have the following property:
\n - rotation
- Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)
\n Radial gradients have the following additional properties:
\n - r
- Radius of the gradient circle.
\n - fx
- Focal point x-coordinate of the gradient.
\n - fy
- Focal point y-coordinate of the gradient.
\n - cx
- \n
The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.
\n Note: Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape` classes which are used on Android or IE 6 - 8.
\n \n - cy
- \n
The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.
\n Note: Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape` classes which are used on Android or IE 6 - 8.
\n \n
",
"itemtype": "config",
"name": "fill",
"type": "Object",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 946,
"description": "Contains information about the stroke of the shape.\n \n - color
- The color of the stroke.
\n - weight
- Number that indicates the width of the stroke.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.
\n - dashstyle
Indicates whether to draw a dashed stroke. When set to \"none\", a solid stroke is drawn. When set to an array, the first index indicates the\n length of the dash. The second index indicates the length of gap.\n - linecap
- Specifies the linecap for the stroke. The following values can be specified:\n
\n - butt (default)
- Specifies a butt linecap.
\n - square
- Specifies a sqare linecap.
\n - round
- Specifies a round linecap.
\n
\n \n - linejoin
- Specifies a linejoin for the stroke. The following values can be specified:\n
\n - round (default)
- Specifies that the linejoin will be round.
\n - bevel
- Specifies a bevel for the linejoin.
\n - miter limit
- An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having\n separate miter and miter limit values.
\n
\n \n
",
"itemtype": "config",
"name": "stroke",
"type": "Object",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 974,
"description": "Dom node for the shape.",
"itemtype": "config",
"name": "node",
"type": "HTMLElement",
"readonly": "",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 981,
"description": "Reference to the parent graphic instance",
"itemtype": "config",
"name": "graphic",
"type": "Graphic",
"readonly": "",
"class": "Shape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1046,
"description": "Radius of the circle",
"itemtype": "config",
"name": "radius",
"type": "Number",
"class": "Circle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1234,
"description": "Indicates the path used for the node.",
"itemtype": "config",
"name": "path",
"type": "String",
"readonly": "",
"class": "Path",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1263,
"description": "Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.",
"itemtype": "config",
"name": "render",
"type": "Node | String",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1269,
"description": "Unique id for class instance.",
"itemtype": "config",
"name": "id",
"type": "String",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1275,
"description": "Key value pairs in which a shape instance is associated with its id.",
"itemtype": "config",
"name": "shapes",
"type": "Object",
"readonly": "",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1282,
"description": "Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.",
"itemtype": "config",
"name": "contentBounds",
"type": "Object",
"readonly": "",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1289,
"description": "The html element that represents to coordinate system of the Graphic instance.",
"itemtype": "config",
"name": "node",
"type": "HTMLElement",
"readonly": "",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1296,
"description": "Indicates the width of the `Graphic`.",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1302,
"description": "Indicates the height of the `Graphic`.",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1308,
"description": "Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents.\nIf false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.",
"itemtype": "config",
"name": "autoSize",
"type": "Boolean",
"default": "false",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1316,
"description": "The contentBounds will resize to greater values but not to smaller values. (for performance)\nWhen resizing the contentBounds down is desirable, set the resizeDown value to true.",
"itemtype": "config",
"name": "resizeDown",
"type": "Boolean",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1323,
"description": "Indicates the x-coordinate for the instance.",
"itemtype": "config",
"name": "x",
"type": "Number",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1329,
"description": "Indicates the y-coordinate for the instance.",
"itemtype": "config",
"name": "y",
"type": "Number",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1335,
"description": "Indicates whether or not the instance will automatically redraw after a change is made to a shape.\nThis property will get set to false when batching operations.",
"itemtype": "config",
"name": "autoDraw",
"type": "Boolean",
"default": "true",
"access": "private",
"tagname": "",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1344,
"description": "Indicates whether the `Graphic` and its children are visible.",
"itemtype": "config",
"name": "visible",
"type": "Boolean",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1350,
"description": "Gets the current position of the graphic instance in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "Array The XY position of the shape."
},
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1356,
"description": "Adds the graphics node to the dom.",
"itemtype": "method",
"name": "render",
"params": [
{
"name": "parentNode",
"description": "node in which to render the graphics node into.",
"type": "Node|String"
}
],
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1362,
"description": "Removes all nodes.",
"itemtype": "method",
"name": "destroy",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1367,
"description": "Generates a shape instance by type. The method accepts an object that contain's the shape's\ntype and attributes to be customized. For example, the code below would create a rectangle:
\n\n var myRect = myGraphic.addShape({\n type: \"rect\",\n width: 40,\n height: 30,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });\n\nThe `Graphics` module includes a few basic shapes. More information on their creation \ncan be found in each shape's documentation:\n\n
\n\n The `Graphics` module also allows for the creation of custom shapes. If a custom shape\n has been created, it can be instantiated with the `addShape` method as well. The attributes,\n required and optional, would need to be defined in the custom shape.\n\n var myCustomShape = myGraphic.addShape({\n type: Y.MyCustomShape,\n width: 50,\n height: 50,\n fill: {\n color: \"#9aa\"\n },\n stroke: {\n weight: 1,\n color: \"#000\"\n }\n });",
"itemtype": "method",
"name": "addShape",
"params": [
{
"name": "cfg",
"description": "Object containing the shape's type and attributes.",
"type": "Object"
}
],
"return": {
"description": "Shape"
},
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1415,
"description": "Removes a shape instance from from the graphic instance.",
"itemtype": "method",
"name": "removeShape",
"params": [
{
"name": "shape",
"description": "The instance or id of the shape to be removed.",
"type": "Shape|String"
}
],
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1421,
"description": "Removes all shape instances from the dom.",
"itemtype": "method",
"name": "removeAllShapes",
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1426,
"description": "Returns a shape based on the id of its dom node.",
"itemtype": "method",
"name": "getShapeById",
"params": [
{
"name": "id",
"description": "Dom id of the shape's node attribute.",
"type": "String"
}
],
"return": {
"description": "Shape"
},
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/BaseGraphic.js",
"line": 1433,
"description": "Allows for creating multiple shapes in order to batch appending and redraw operations.",
"itemtype": "method",
"name": "batch",
"params": [
{
"name": "method",
"description": "Method to execute.",
"type": "Function"
}
],
"class": "Graphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasCircle.js",
"line": 20,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "CanvasCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasCircle.js",
"line": 29,
"description": "Draws the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "CanvasCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasCircle.js",
"line": 48,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "CanvasCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasCircle.js",
"line": 67,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "CanvasCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasCircle.js",
"line": 86,
"description": "Radius of the circle",
"itemtype": "config",
"name": "radius",
"type": "Number",
"class": "CanvasCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 35,
"description": "Parses hex color string and alpha value to rgba",
"itemtype": "method",
"name": "_toRGBA",
"params": [
{
"name": "val",
"description": "Color value to parse. Can be hex string, rgb or name.",
"type": "Object"
},
{
"name": "alpha",
"description": "Numeric value between 0 and 1 representing the alpha level.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 59,
"description": "Converts color to rgb format",
"itemtype": "method",
"name": "_toRGB",
"params": [
{
"name": "val",
"description": "Color value to convert."
}
],
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 70,
"description": "Sets the size of the graphics object.",
"itemtype": "method",
"name": "setSize",
"params": [
{
"name": "w",
"description": "width to set for the instance.",
"type": "Number"
},
{
"name": "h",
"description": "height to set for the instance.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 94,
"description": "Tracks coordinates. Used to calculate the start point of dashed lines.",
"itemtype": "method",
"name": "_updateCoords",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 108,
"description": "Clears the coordinate arrays. Called at the end of a drawing operation.",
"itemtype": "method",
"name": "_clearAndUpdateCoords",
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 121,
"description": "Moves the shape's dom node.",
"itemtype": "method",
"name": "_updateNodePosition",
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 137,
"description": "Queues up a method to be executed when a shape redraws.",
"itemtype": "method",
"name": "_updateDrawingQueue",
"params": [
{
"name": "val",
"description": "An array containing data that can be parsed into a method and arguments. The value at zero-index of the array is a string reference of\nthe drawing method that will be called. All subsequent indices are argument for that method. For example, `lineTo(10, 100)` would be structured as:\n`[\"lineTo\", 10, 100]`.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 151,
"description": "Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.",
"itemtype": "method",
"name": "lineTo",
"params": [
{
"name": "point1",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "point2",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 192,
"description": "Moves the current drawing position to specified x and y coordinates.",
"itemtype": "method",
"name": "moveTo",
"params": [
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 209,
"description": "Draws a bezier curve.",
"itemtype": "method",
"name": "curveTo",
"params": [
{
"name": "cp1x",
"description": "x-coordinate for the first control point.",
"type": "Number"
},
{
"name": "cp1y",
"description": "y-coordinate for the first control point.",
"type": "Number"
},
{
"name": "cp2x",
"description": "x-coordinate for the second control point.",
"type": "Number"
},
{
"name": "cp2y",
"description": "y-coordinate for the second control point.",
"type": "Number"
},
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 237,
"description": "Draws a quadratic bezier curve.",
"itemtype": "method",
"name": "quadraticCurveTo",
"params": [
{
"name": "cpx",
"description": "x-coordinate for the control point.",
"type": "Number"
},
{
"name": "cpy",
"description": "y-coordinate for the control point.",
"type": "Number"
},
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 264,
"description": "Draws a circle. Used internally by `CanvasCircle` class.",
"itemtype": "method",
"name": "drawCircle",
"params": [
{
"name": "x",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "r",
"description": "radius",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 287,
"description": "Draws an ellipse. Used internally by `CanvasEllipse` class.",
"itemtype": "method",
"name": "drawEllipse",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 329,
"description": "Draws a rectangle.",
"itemtype": "method",
"name": "drawRect",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
}
],
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 351,
"description": "Draws a rectangle with rounded corners.",
"itemtype": "method",
"name": "drawRect",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
},
{
"name": "ew",
"description": "width of the ellipse used to draw the rounded corners",
"type": "Number"
},
{
"name": "eh",
"description": "height of the ellipse used to draw the rounded corners",
"type": "Number"
}
],
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 380,
"description": "Draws a wedge.",
"itemtype": "method",
"name": "drawWedge",
"params": [
{
"name": "x",
"description": "x-coordinate of the wedge's center point",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate of the wedge's center point",
"type": "Number"
},
{
"name": "startAngle",
"description": "starting angle in degrees",
"type": "Number"
},
{
"name": "arc",
"description": "sweep of the wedge. Negative values draw clockwise.",
"type": "Number"
},
{
"name": "radius",
"description": "radius of wedge. If [optional] yRadius is defined, then radius is the x radius.",
"type": "Number"
},
{
"name": "yRadius",
"description": "[optional] y radius for wedge.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 460,
"description": "Completes a drawing operation.",
"itemtype": "method",
"name": "end",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 470,
"description": "Clears the graphics object.",
"itemtype": "method",
"name": "clear",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 476,
"description": "Returns a linear gradient fill",
"itemtype": "method",
"name": "_getLinearGradient",
"return": {
"description": "CanvasGradient"
},
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 556,
"description": "Returns a radial gradient fill",
"itemtype": "method",
"name": "_getRadialGradient",
"return": {
"description": "CanvasGradient"
},
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 648,
"description": "Clears all values",
"itemtype": "method",
"name": "_initProps",
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 667,
"description": "Indicates a drawing has completed.",
"itemtype": "property",
"name": "_drawingComplete",
"type": "Boolean",
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 676,
"description": "Creates canvas element",
"itemtype": "method",
"name": "_createGraphic",
"return": {
"description": "HTMLCanvasElement"
},
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasDrawing.js",
"line": 688,
"description": "Updates the size of the graphics object",
"itemtype": "method",
"name": "_trackSize",
"params": [
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "CanvasDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasEllipse.js",
"line": 20,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "CanvasEllipse",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasEllipse.js",
"line": 29,
"description": "Draws the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "CanvasEllipse",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 20,
"description": "Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.",
"itemtype": "config",
"name": "render",
"type": "Node | String",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 28,
"description": "Unique id for class instance.",
"itemtype": "config",
"name": "id",
"type": "String",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 51,
"description": "Key value pairs in which a shape instance is associated with its id.",
"itemtype": "config",
"name": "shapes",
"type": "Object",
"readonly": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 67,
"description": "Object containing size and coordinate data for the content of a Graphic in relation to the graphic instance's position.",
"itemtype": "config",
"name": "contentBounds",
"type": "Object",
"readonly": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 83,
"description": "The outermost html element of the Graphic instance.",
"itemtype": "config",
"name": "node",
"type": "HTMLElement",
"readonly": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 99,
"description": "Indicates the width of the `Graphic`.",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 116,
"description": "Indicates the height of the `Graphic`.",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 133,
"description": "Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents.\nIf false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.",
"itemtype": "config",
"name": "autoSize",
"type": "Boolean",
"default": "false",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 145,
"description": "The contentBounds will resize to greater values but not smaller values. (for performance)\nWhen resizing the contentBounds down is desirable, set the resizeDown value to true.",
"itemtype": "config",
"name": "resizeDown",
"type": "Boolean",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 166,
"description": "Indicates the x-coordinate for the instance.",
"itemtype": "config",
"name": "x",
"type": "Number",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 189,
"description": "Indicates the y-coordinate for the instance.",
"itemtype": "config",
"name": "y",
"type": "Number",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 212,
"description": "Indicates whether or not the instance will automatically redraw after a change is made to a shape.\nThis property will get set to false when batching operations.",
"itemtype": "config",
"name": "autoDraw",
"type": "Boolean",
"default": "true",
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 225,
"description": "Indicates whether the `Graphic` and its children are visible.",
"itemtype": "config",
"name": "visible",
"type": "Boolean",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 243,
"description": "Storage for `x` attribute.",
"itemtype": "property",
"name": "_x",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 252,
"description": "Storage for `y` attribute.",
"itemtype": "property",
"name": "_y",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 261,
"description": "Gets the current position of the graphic instance in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "Array The XY position of the shape."
},
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 278,
"description": "Storage for `resizeDown` attribute.",
"itemtype": "property",
"name": "_resizeDown",
"type": "Boolean",
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 287,
"description": "Initializes the class.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Optional attributes",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 316,
"description": "Adds the graphics node to the dom.",
"itemtype": "method",
"name": "render",
"params": [
{
"name": "parentNode",
"description": "node in which to render the graphics node into.",
"type": "HTMLElement"
}
],
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 339,
"description": "Removes all nodes.",
"itemtype": "method",
"name": "destroy",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 354,
"description": "Generates a shape instance by type.",
"itemtype": "method",
"name": "addShape",
"params": [
{
"name": "cfg",
"description": "attributes for the shape",
"type": "Object"
}
],
"return": {
"description": "Shape"
},
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 370,
"description": "Adds a shape instance to the graphic instance.",
"itemtype": "method",
"name": "_appendShape",
"params": [
{
"name": "shape",
"description": "The shape instance to be added to the graphic.",
"type": "Shape"
}
],
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 391,
"description": "Removes a shape instance from from the graphic instance.",
"itemtype": "method",
"name": "removeShape",
"params": [
{
"name": "shape",
"description": "The instance or id of the shape to be removed.",
"type": "Shape|String"
}
],
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 418,
"description": "Removes all shape instances from the dom.",
"itemtype": "method",
"name": "removeAllShapes",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 437,
"description": "Removes all child nodes.",
"itemtype": "method",
"name": "_removeChildren",
"params": [
{
"name": "node",
"description": "",
"type": "HTMLElement"
}
],
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 458,
"description": "Toggles visibility",
"itemtype": "method",
"name": "_toggleVisible",
"params": [
{
"name": "val",
"description": "indicates visibilitye",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 483,
"description": "Returns a shape class. Used by `addShape`.",
"itemtype": "method",
"name": "_getShapeClass",
"params": [
{
"name": "val",
"description": "Indicates which shape class.",
"type": "Shape | String"
}
],
"return": {
"description": "Function"
},
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 501,
"description": "Look up for shape classes. Used by `addShape` to retrieve a class for instantiation.",
"itemtype": "property",
"name": "_shapeClass",
"type": "Object",
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 516,
"description": "Returns a shape based on the id of its dom node.",
"itemtype": "method",
"name": "getShapeById",
"params": [
{
"name": "id",
"description": "Dom id of the shape's node attribute.",
"type": "String"
}
],
"return": {
"description": "Shape"
},
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 529,
"description": "Allows for creating multiple shapes in order to batch appending and redraw operations.",
"itemtype": "method",
"name": "batch",
"params": [
{
"name": "method",
"description": "Method to execute.",
"type": "Function"
}
],
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 544,
"description": "Returns a document fragment to for attaching shapes.",
"itemtype": "method",
"name": "_getDocFrag",
"return": {
"description": "DocumentFragment"
},
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 560,
"description": "Redraws all shapes.",
"itemtype": "method",
"name": "_redraw",
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 581,
"description": "Adds a shape to the redraw queue and calculates the contentBounds. Used internally \nby `Shape` instances.",
"itemtype": "method",
"name": "addToRedrawQueue",
"params": [
{
"name": "Shape",
"description": "shape The shape instance to add to the queue"
}
],
"access": "protected",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasGraphic.js",
"line": 612,
"description": "Recalculates and returns the `contentBounds` for the `Graphic` instance.",
"itemtype": "method",
"name": "_getUpdatedContentBounds",
"return": {
"description": "",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "CanvasGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPath.js",
"line": 18,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "CanvasPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPath.js",
"line": 27,
"description": "Draws the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "CanvasPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPath.js",
"line": 38,
"description": "Creates the dom node for the shape.",
"itemtype": "method",
"name": "createNode",
"return": {
"description": "HTMLElement"
},
"access": "private",
"tagname": "",
"class": "CanvasPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPath.js",
"line": 60,
"description": "Completes a drawing operation.",
"itemtype": "method",
"name": "end",
"class": "CanvasPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPath.js",
"line": 72,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "CanvasPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPath.js",
"line": 92,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "CanvasPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPath.js",
"line": 112,
"description": "Indicates the path used for the node.",
"itemtype": "config",
"name": "path",
"type": "String",
"readonly": "",
"class": "CanvasPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPieSlice.js",
"line": 14,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "CanvasPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPieSlice.js",
"line": 23,
"description": "Change event listener",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_updateHandler",
"class": "CanvasPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPieSlice.js",
"line": 53,
"description": "Starting angle in relation to a circle in which to begin the pie slice drawing.",
"itemtype": "config",
"name": "startAngle",
"type": "Number",
"class": "CanvasPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPieSlice.js",
"line": 63,
"description": "Arc of the slice.",
"itemtype": "config",
"name": "arc",
"type": "Number",
"class": "CanvasPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasPieSlice.js",
"line": 73,
"description": "Radius of the circle in which the pie slice is drawn",
"itemtype": "config",
"name": "radius",
"type": "Number",
"class": "CanvasPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasRect.js",
"line": 18,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "CanvasRect",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasRect.js",
"line": 27,
"description": "Draws the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "CanvasRect",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 22,
"description": "Init method, invoked during construction.\nCalls `initializer` method.",
"itemtype": "method",
"name": "init",
"access": "protected",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 34,
"description": "Initializes the shape",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_initialize",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 51,
"description": "Add a class name to each node.",
"itemtype": "method",
"name": "addClass",
"params": [
{
"name": "className",
"description": "the class name to add to the node's class attribute",
"type": "String"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 63,
"description": "Removes a class name from each node.",
"itemtype": "method",
"name": "removeClass",
"params": [
{
"name": "className",
"description": "the class name to remove from the node's class attribute",
"type": "String"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 75,
"description": "Gets the current position of the node in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "Array The XY position of the shape."
},
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 90,
"description": "Set the position of the shape in page coordinates, regardless of how the node is positioned.",
"itemtype": "method",
"name": "setXY",
"params": [
{
"name": "Contains",
"description": "X & Y values for new position (coordinates are page-based)",
"type": "Array"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 107,
"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",
"itemtype": "method",
"name": "contains",
"params": [
{
"name": "needle",
"description": "The possible node or descendent",
"type": "CanvasShape | HTMLElement"
}
],
"return": {
"description": "Boolean Whether or not this shape is the needle or its ancestor."
},
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 119,
"description": "Test if the supplied node matches the supplied selector.",
"itemtype": "method",
"name": "test",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "Boolean Wheter or not the shape matches the selector."
},
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 132,
"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",
"itemtype": "method",
"name": "compareTo",
"params": [
{
"name": "refNode",
"description": "The reference node to compare to the node.",
"type": "HTMLElement | Node"
}
],
"return": {
"description": "True if the nodes match, false if they do not.",
"type": "Boolean"
},
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 144,
"description": "Value function for fill attribute",
"itemtype": "method",
"name": "_getDefaultFill",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 162,
"description": "Value function for stroke attribute",
"itemtype": "method",
"name": "_getDefaultStroke",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 179,
"description": "Left edge of the path",
"itemtype": "property",
"name": "_left",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 188,
"description": "Right edge of the path",
"itemtype": "property",
"name": "_right",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 197,
"description": "Top edge of the path",
"itemtype": "property",
"name": "_top",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 206,
"description": "Bottom edge of the path",
"itemtype": "property",
"name": "_bottom",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 215,
"description": "Creates the dom node for the shape.",
"itemtype": "method",
"name": "createNode",
"return": {
"description": "HTMLElement"
},
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 235,
"description": "Overrides default `on` method. Checks to see if its a dom interaction event. If so, \nreturn an event attached to the `node` element. If not, return the normal functionality.",
"itemtype": "method",
"name": "on",
"params": [
{
"name": "type",
"description": "event type",
"type": "String"
},
{
"name": "callback",
"description": "function",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 253,
"description": "Adds a stroke to the shape node.",
"itemtype": "method",
"name": "_strokeChangeHandler",
"params": [
{
"name": "stroke",
"description": "Properties of the `stroke` attribute.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 303,
"description": "Sets the value of an attribute.",
"itemtype": "method",
"name": "set",
"params": [
{
"name": "name",
"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",
"type": "String|Object"
},
{
"name": "value",
"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",
"type": "Any"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 323,
"description": "Adds a fill to the shape node.",
"itemtype": "method",
"name": "_setFillProps",
"params": [
{
"name": "fill",
"description": "Properties of the `fill` attribute.",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 362,
"description": "Specifies a 2d translation.",
"itemtype": "method",
"name": "translate",
"params": [
{
"name": "x",
"description": "The value to transate on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to translate on the y-axis.",
"type": "Number"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 376,
"description": "Translates the shape along the x-axis. When translating x and y coordinates,\nuse the `translate` method.",
"itemtype": "method",
"name": "translateX",
"params": [
{
"name": "x",
"description": "The value to translate.",
"type": "Number"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 389,
"description": "Performs a translate on the y-coordinate. When translating x and y coordinates,\nuse the `translate` method.",
"itemtype": "method",
"name": "translateY",
"params": [
{
"name": "y",
"description": "The value to translate.",
"type": "Number"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 402,
"description": "Skews the shape around the x-axis and y-axis.",
"itemtype": "method",
"name": "skew",
"params": [
{
"name": "x",
"description": "The value to skew on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to skew on the y-axis.",
"type": "Number"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 414,
"description": "Skews the shape around the x-axis.",
"itemtype": "method",
"name": "skewX",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 425,
"description": "Skews the shape around the y-axis.",
"itemtype": "method",
"name": "skewY",
"params": [
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 436,
"description": "Rotates the shape clockwise around it transformOrigin.",
"itemtype": "method",
"name": "rotate",
"params": [
{
"name": "deg",
"description": "The degree of the rotation.",
"type": "Number"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 448,
"description": "Specifies a 2d scaling operation.",
"itemtype": "method",
"name": "scale",
"params": [
{
"name": "val",
"description": "",
"type": "Number"
}
],
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 459,
"description": "Storage for `rotation` atribute.",
"itemtype": "property",
"name": "_rotation",
"type": "Number",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 468,
"description": "Storage for the transform attribute.",
"itemtype": "property",
"name": "_transform",
"type": "String",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 477,
"description": "Adds a transform to the shape.",
"itemtype": "method",
"name": "_addTransform",
"params": [
{
"name": "type",
"description": "The transform being applied.",
"type": "String"
},
{
"name": "args",
"description": "The arguments for the transform.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 497,
"description": "Applies all transforms.",
"itemtype": "method",
"name": "_updateTransform",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 542,
"description": "Updates `Shape` based on attribute changes.",
"itemtype": "method",
"name": "_updateHandler",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 554,
"description": "Updates the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 569,
"description": "Completes a shape or drawing",
"itemtype": "method",
"name": "_paint",
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 682,
"description": "Draws a dashed line between two points.",
"itemtype": "method",
"name": "_drawDashedLine",
"params": [
{
"name": "xStart",
"description": "The x position of the start of the line",
"type": "Number"
},
{
"name": "yStart",
"description": "The y position of the start of the line",
"type": "Number"
},
{
"name": "xEnd",
"description": "The x position of the end of the line",
"type": "Number"
},
{
"name": "yEnd",
"description": "The y position of the end of the line",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 743,
"description": "Returns the bounds for a shape.\n\nCalculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.\nThe calculated bounding box is used by the graphic instance to calculate its viewBox.",
"itemtype": "method",
"name": "getBounds",
"return": {
"description": "Object"
},
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 811,
"description": "Returns the x coordinate for a bounding box's corner based on the corner's original x/y coordinates, rotation and transform origin of the rotation.",
"itemtype": "method",
"name": "_getRotatedCornerX",
"params": [
{
"name": "x",
"description": "original x-coordinate of corner",
"type": "Number"
},
{
"name": "y",
"description": "original y-coordinate of corner",
"type": "Number"
},
{
"name": "tox",
"description": "transform origin x-coordinate of rotation",
"type": "Number"
},
{
"name": "toy",
"description": "transform origin y-coordinate of rotation",
"type": "Number"
},
{
"name": "cosRadians",
"description": "cosine (in radians) of rotation",
"type": "Number"
},
{
"name": "sinRadians",
"description": "sin (in radians) or rotation",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 829,
"description": "Returns the y coordinate for a bounding box's corner based on the corner's original x/y coordinates, rotation and transform origin of the rotation.",
"itemtype": "method",
"name": "_getRotatedCornerY",
"params": [
{
"name": "x",
"description": "original x-coordinate of corner",
"type": "Number"
},
{
"name": "y",
"description": "original y-coordinate of corner",
"type": "Number"
},
{
"name": "tox",
"description": "transform origin x-coordinate of rotation",
"type": "Number"
},
{
"name": "toy",
"description": "transform origin y-coordinate of rotation",
"type": "Number"
},
{
"name": "cosRadians",
"description": "cosine (in radians) of rotation",
"type": "Number"
},
{
"name": "sinRadians",
"description": "sin (in radians) or rotation",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 847,
"description": "Destroys the instance.",
"itemtype": "method",
"name": "destroy",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 871,
"description": "An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a \nfraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].",
"itemtype": "config",
"name": "transformOrigin",
"type": "Array",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 885,
"description": "A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:\n \n
\n - rotate
- Rotates the shape clockwise around it transformOrigin.
\n - translate
- Specifies a 2d translation.
\n - skew
- Skews the shape around the x-axis and y-axis.
\n - scale
- Specifies a 2d scaling operation.
\n - translateX
- Translates the shape along the x-axis.
\n - translateY
- Translates the shape along the y-axis.
\n - skewX
- Skews the shape around the x-axis.
\n - skewY
- Skews the shape around the y-axis.
\n
\n\nApplying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform\nthat will apply the transform to the current matrix. The below code illustrates how you might use the `transform` attribute to instantiate a recangle with a rotation of 45 degrees.
\n var myRect = new Y.Rect({\n type:\"rect\",\n width: 50,\n height: 40,\n transform: \"rotate(45)\"\n };\nThe code below would apply `translate` and `rotate` to an existing shape.
\n \n myRect.set(\"transform\", \"translate(40, 50) rotate(45)\");",
"itemtype": "config",
"name": "transform",
"type": "String",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 932,
"description": "Dom node for the shape",
"itemtype": "config",
"name": "node",
"type": "HTMLElement",
"readonly": "",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 948,
"description": "Unique id for class instance.",
"itemtype": "config",
"name": "id",
"type": "String",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 971,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 981,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 991,
"description": "Indicates the x position of shape.",
"itemtype": "config",
"name": "x",
"type": "Number",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 1001,
"description": "Indicates the y position of shape.",
"itemtype": "config",
"name": "y",
"type": "Number",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 1011,
"description": "Indicates whether the shape is visible.",
"itemtype": "config",
"name": "visible",
"type": "Boolean",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 1027,
"description": "Contains information about the fill of the shape. \n \n - color
- The color of the fill.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.
\n - type
- Type of fill.\n
\n - solid
- Solid single color fill. (default)
\n - linear
- Linear gradient fill.
\n - radial
- Radial gradient fill.
\n
\n \n
\n If a `linear` or `radial` is specified as the fill type. The following additional property is used:\n
\n - stops
- An array of objects containing the following properties:\n
\n - color
- The color of the stop.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8
\n - offset
- Number between 0 and 1 indicating where the color stop is positioned.
\n
\n \n Linear gradients also have the following property:
\n - rotation
- Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)
\n Radial gradients have the following additional properties:
\n - r
- Radius of the gradient circle.
\n - fx
- Focal point x-coordinate of the gradient.
\n - fy
- Focal point y-coordinate of the gradient.
\n
\n The corresponding `SVGShape` class implements the following additional properties.
\n \n - cx
- \n
The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.
\n \n - cy
- \n
The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.
\n \n
\n These properties are not currently implemented in `CanvasShape` or `VMLShape`.
",
"itemtype": "config",
"name": "fill",
"type": "Object",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 1090,
"description": "Contains information about the stroke of the shape.\n \n - color
- The color of the stroke.
\n - weight
- Number that indicates the width of the stroke.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.
\n - dashstyle
Indicates whether to draw a dashed stroke. When set to \"none\", a solid stroke is drawn. When set to an array, the first index indicates the\n length of the dash. The second index indicates the length of gap.\n - linecap
- Specifies the linecap for the stroke. The following values can be specified:\n
\n - butt (default)
- Specifies a butt linecap.
\n - square
- Specifies a sqare linecap.
\n - round
- Specifies a round linecap.
\n
\n \n - linejoin
- Specifies a linejoin for the stroke. The following values can be specified:\n
\n - round (default)
- Specifies that the linejoin will be round.
\n - bevel
- Specifies a bevel for the linejoin.
\n - miter limit
- An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having\n separate miter and miter limit values.
\n
\n \n
",
"itemtype": "config",
"name": "stroke",
"type": "Object",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/CanvasShape.js",
"line": 1154,
"description": "Reference to the container Graphic.",
"itemtype": "config",
"name": "graphic",
"type": "Graphic",
"class": "CanvasShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGCircle.js",
"line": 20,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "SVGCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGCircle.js",
"line": 29,
"description": "Updates the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "SVGCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGCircle.js",
"line": 53,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "SVGCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGCircle.js",
"line": 72,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "SVGCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGCircle.js",
"line": 91,
"description": "Radius of the circle",
"itemtype": "config",
"name": "radius",
"type": "Number",
"class": "SVGCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 26,
"description": "Indicates the type of shape",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_type",
"readonly": "",
"type": "String",
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 36,
"description": "Draws a bezier curve.",
"itemtype": "method",
"name": "curveTo",
"params": [
{
"name": "cp1x",
"description": "x-coordinate for the first control point.",
"type": "Number"
},
{
"name": "cp1y",
"description": "y-coordinate for the first control point.",
"type": "Number"
},
{
"name": "cp2x",
"description": "x-coordinate for the second control point.",
"type": "Number"
},
{
"name": "cp2y",
"description": "y-coordinate for the second control point.",
"type": "Number"
},
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 79,
"description": "Draws a quadratic bezier curve.",
"itemtype": "method",
"name": "quadraticCurveTo",
"params": [
{
"name": "cpx",
"description": "x-coordinate for the control point.",
"type": "Number"
},
{
"name": "cpy",
"description": "y-coordinate for the control point.",
"type": "Number"
},
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 120,
"description": "Draws a rectangle.",
"itemtype": "method",
"name": "drawRect",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
}
],
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 137,
"description": "Draws a rectangle with rounded corners.",
"itemtype": "method",
"name": "drawRect",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
},
{
"name": "ew",
"description": "width of the ellipse used to draw the rounded corners",
"type": "Number"
},
{
"name": "eh",
"description": "height of the ellipse used to draw the rounded corners",
"type": "Number"
}
],
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 160,
"description": "Draws a wedge.",
"itemtype": "method",
"name": "drawWedge",
"params": [
{
"name": "x",
"description": "x-coordinate of the wedge's center point",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate of the wedge's center point",
"type": "Number"
},
{
"name": "startAngle",
"description": "starting angle in degrees",
"type": "Number"
},
{
"name": "arc",
"description": "sweep of the wedge. Negative values draw clockwise.",
"type": "Number"
},
{
"name": "radius",
"description": "radius of wedge. If [optional] yRadius is defined, then radius is the x radius.",
"type": "Number"
},
{
"name": "yRadius",
"description": "[optional] y radius for wedge.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 254,
"description": "Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.",
"itemtype": "method",
"name": "lineTo",
"params": [
{
"name": "point1",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "point2",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 302,
"description": "Moves the current drawing position to specified x and y coordinates.",
"itemtype": "method",
"name": "moveTo",
"params": [
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 328,
"description": "Completes a drawing operation.",
"itemtype": "method",
"name": "end",
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 339,
"description": "Clears the path.",
"itemtype": "method",
"name": "clear",
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 354,
"description": "Draws the path.",
"itemtype": "method",
"name": "_closePath",
"access": "private",
"tagname": "",
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGDrawing.js",
"line": 423,
"description": "Updates the size of the graphics object",
"itemtype": "method",
"name": "_trackSize",
"params": [
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "SVGDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGEllipse.js",
"line": 19,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "SVGEllipse",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGEllipse.js",
"line": 28,
"description": "Updates the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "SVGEllipse",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 18,
"description": "Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.",
"itemtype": "config",
"name": "render",
"type": "Node | String",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 26,
"description": "Unique id for class instance.",
"itemtype": "config",
"name": "id",
"type": "String",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 49,
"description": "Key value pairs in which a shape instance is associated with its id.",
"itemtype": "config",
"name": "shapes",
"type": "Object",
"readonly": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 65,
"description": "Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.",
"itemtype": "config",
"name": "contentBounds",
"type": "Object",
"readonly": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 81,
"description": "The html element that represents to coordinate system of the Graphic instance.",
"itemtype": "config",
"name": "node",
"type": "HTMLElement",
"readonly": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 97,
"description": "Indicates the width of the `Graphic`.",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 114,
"description": "Indicates the height of the `Graphic`.",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 131,
"description": "Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents.\nIf false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.",
"itemtype": "config",
"name": "autoSize",
"type": "Boolean",
"default": "false",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 143,
"description": "The contentBounds will resize to greater values but not to smaller values. (for performance)\nWhen resizing the contentBounds down is desirable, set the resizeDown value to true.",
"itemtype": "config",
"name": "resizeDown",
"type": "Boolean",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 164,
"description": "Indicates the x-coordinate for the instance.",
"itemtype": "config",
"name": "x",
"type": "Number",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 187,
"description": "Indicates the y-coordinate for the instance.",
"itemtype": "config",
"name": "y",
"type": "Number",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 210,
"description": "Indicates whether or not the instance will automatically redraw after a change is made to a shape.\nThis property will get set to false when batching operations.",
"itemtype": "config",
"name": "autoDraw",
"type": "Boolean",
"default": "true",
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 245,
"description": "Storage for `x` attribute.",
"itemtype": "property",
"name": "_x",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 254,
"description": "Storage for `y` attribute.",
"itemtype": "property",
"name": "_y",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 263,
"description": "Gets the current position of the graphic instance in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "Array The XY position of the shape."
},
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 280,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_resizeDown",
"type": "Boolean",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 287,
"description": "Initializes the class.",
"itemtype": "method",
"name": "initializer",
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 316,
"description": "Adds the graphics node to the dom.",
"itemtype": "method",
"name": "render",
"params": [
{
"name": "parentNode",
"description": "node in which to render the graphics node into.",
"type": "HTMLElement"
}
],
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 335,
"description": "Removes all nodes.",
"itemtype": "method",
"name": "destroy",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 350,
"description": "Generates a shape instance by type.",
"itemtype": "method",
"name": "addShape",
"params": [
{
"name": "cfg",
"description": "attributes for the shape",
"type": "Object"
}
],
"return": {
"description": "Shape"
},
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 366,
"description": "Adds a shape instance to the graphic instance.",
"itemtype": "method",
"name": "_appendShape",
"params": [
{
"name": "shape",
"description": "The shape instance to be added to the graphic.",
"type": "Shape"
}
],
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 387,
"description": "Removes a shape instance from from the graphic instance.",
"itemtype": "method",
"name": "removeShape",
"params": [
{
"name": "shape",
"description": "The instance or id of the shape to be removed.",
"type": "Shape|String"
}
],
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 414,
"description": "Removes all shape instances from the dom.",
"itemtype": "method",
"name": "removeAllShapes",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 433,
"description": "Removes all child nodes.",
"itemtype": "method",
"name": "_removeChildren",
"params": [
{
"name": "node",
"description": "",
"type": "HTMLElement"
}
],
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 454,
"description": "Clears the graphics object.",
"itemtype": "method",
"name": "clear",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 463,
"description": "Toggles visibility",
"itemtype": "method",
"name": "_toggleVisible",
"params": [
{
"name": "val",
"description": "indicates visibilitye",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 489,
"description": "Returns a shape class. Used by `addShape`.",
"itemtype": "method",
"name": "_getShapeClass",
"params": [
{
"name": "val",
"description": "Indicates which shape class.",
"type": "Shape | String"
}
],
"return": {
"description": "Function"
},
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 507,
"description": "Look up for shape classes. Used by `addShape` to retrieve a class for instantiation.",
"itemtype": "property",
"name": "_shapeClass",
"type": "Object",
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 522,
"description": "Returns a shape based on the id of its dom node.",
"itemtype": "method",
"name": "getShapeById",
"params": [
{
"name": "id",
"description": "Dom id of the shape's node attribute.",
"type": "String"
}
],
"return": {
"description": "Shape"
},
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 535,
"description": "Allows for creating multiple shapes in order to batch appending and redraw operations.",
"itemtype": "method",
"name": "batch",
"params": [
{
"name": "method",
"description": "Method to execute.",
"type": "Function"
}
],
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 550,
"description": "Returns a document fragment to for attaching shapes.",
"itemtype": "method",
"name": "_getDocFrag",
"return": {
"description": "DocumentFragment"
},
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 566,
"description": "Redraws all shapes.",
"itemtype": "method",
"name": "_redraw",
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 594,
"description": "Adds a shape to the redraw queue and calculates the contentBounds. Used internally \nby `Shape` instances.",
"itemtype": "method",
"name": "addToRedrawQueue",
"params": [
{
"name": "shape",
"description": "",
"type": "SVGShape"
}
],
"access": "protected",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 625,
"description": "Recalculates and returns the `contentBounds` for the `Graphic` instance.",
"itemtype": "method",
"name": "_getUpdatedContentBounds",
"return": {
"description": "",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 662,
"description": "Creates a contentNode element",
"itemtype": "method",
"name": "_createGraphics",
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 680,
"description": "Creates a graphic node",
"itemtype": "method",
"name": "_createGraphicNode",
"params": [
{
"name": "type",
"description": "node type to create",
"type": "String"
},
{
"name": "pe",
"description": "specified pointer-events value",
"type": "String"
}
],
"return": {
"description": "HTMLElement"
},
"access": "private",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGGraphic.js",
"line": 700,
"description": "Returns a reference to a gradient definition based on an id and type.",
"itemtype": "method",
"name": "getGradientNode",
"params": [
{
"name": "key",
"description": "id that references the gradient definition",
"type": "String"
},
{
"name": "type",
"description": "description of the gradient type",
"type": "String"
}
],
"return": {
"description": "HTMLElement"
},
"access": "protected",
"tagname": "",
"class": "SVGGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 18,
"description": "Left edge of the path",
"itemtype": "property",
"name": "_left",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 27,
"description": "Right edge of the path",
"itemtype": "property",
"name": "_right",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 36,
"description": "Top edge of the path",
"itemtype": "property",
"name": "_top",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 45,
"description": "Bottom edge of the path",
"itemtype": "property",
"name": "_bottom",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 54,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"readonly": "",
"type": "String",
"access": "private",
"tagname": "",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 64,
"description": "Storage for path",
"itemtype": "property",
"name": "_path",
"type": "String",
"access": "private",
"tagname": "",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 75,
"description": "Indicates the path used for the node.",
"itemtype": "config",
"name": "path",
"type": "String",
"readonly": "",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 91,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPath.js",
"line": 105,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "SVGPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPieSlice.js",
"line": 14,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "SVGPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPieSlice.js",
"line": 23,
"description": "Change event listener",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_updateHandler",
"class": "SVGPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPieSlice.js",
"line": 49,
"description": "Starting angle in relation to a circle in which to begin the pie slice drawing.",
"itemtype": "config",
"name": "startAngle",
"type": "Number",
"class": "SVGPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPieSlice.js",
"line": 59,
"description": "Arc of the slice.",
"itemtype": "config",
"name": "arc",
"type": "Number",
"class": "SVGPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGPieSlice.js",
"line": 69,
"description": "Radius of the circle in which the pie slice is drawn",
"itemtype": "config",
"name": "radius",
"type": "Number",
"class": "SVGPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGRect.js",
"line": 17,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "SVGRect",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 22,
"description": "Init method, invoked during construction.\nCalls `initializer` method.",
"itemtype": "method",
"name": "init",
"access": "protected",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 34,
"description": "Initializes the shape",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "initializer",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 48,
"description": "Add a class name to each node.",
"itemtype": "method",
"name": "addClass",
"params": [
{
"name": "className",
"description": "the class name to add to the node's class attribute",
"type": "String"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 60,
"description": "Removes a class name from each node.",
"itemtype": "method",
"name": "removeClass",
"params": [
{
"name": "className",
"description": "the class name to remove from the node's class attribute",
"type": "String"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 74,
"description": "Gets the current position of the node in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "Array The XY position of the shape."
},
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 89,
"description": "Set the position of the shape in page coordinates, regardless of how the node is positioned.",
"itemtype": "method",
"name": "setXY",
"params": [
{
"name": "Contains",
"description": "x & y values for new position (coordinates are page-based)",
"type": "Array"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 103,
"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",
"itemtype": "method",
"name": "contains",
"params": [
{
"name": "needle",
"description": "The possible node or descendent",
"type": "SVGShape | HTMLElement"
}
],
"return": {
"description": "Boolean Whether or not this shape is the needle or its ancestor."
},
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 115,
"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",
"itemtype": "method",
"name": "compareTo",
"params": [
{
"name": "refNode",
"description": "The reference node to compare to the node.",
"type": "HTMLElement | Node"
}
],
"return": {
"description": "True if the nodes match, false if they do not.",
"type": "Boolean"
},
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 128,
"description": "Test if the supplied node matches the supplied selector.",
"itemtype": "method",
"name": "test",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "Boolean Wheter or not the shape matches the selector."
},
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 140,
"description": "Value function for fill attribute",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getDefaultFill",
"return": {
"description": "Object"
},
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 159,
"description": "Value function for stroke attribute",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getDefaultStroke",
"return": {
"description": "Object"
},
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 176,
"description": "Creates the dom node for the shape.",
"itemtype": "method",
"name": "createNode",
"return": {
"description": "HTMLElement"
},
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 201,
"description": "Overrides default `on` method. Checks to see if its a dom interaction event. If so, \nreturn an event attached to the `node` element. If not, return the normal functionality.",
"itemtype": "method",
"name": "on",
"params": [
{
"name": "type",
"description": "event type",
"type": "String"
},
{
"name": "callback",
"description": "function",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 219,
"description": "Adds a stroke to the shape node.",
"itemtype": "method",
"name": "_strokeChangeHandler",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 268,
"description": "Adds a fill to the shape node.",
"itemtype": "method",
"name": "_fillChangeHandler",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 306,
"description": "Creates a gradient fill",
"itemtype": "method",
"name": "_setGradientFill",
"params": [
{
"name": "type",
"description": "gradient type",
"type": "String"
}
],
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 412,
"description": "Sets the value of an attribute.",
"itemtype": "method",
"name": "set",
"params": [
{
"name": "name",
"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",
"type": "String|Object"
},
{
"name": "value",
"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",
"type": "Any"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 431,
"description": "Specifies a 2d translation.",
"itemtype": "method",
"name": "translate",
"params": [
{
"name": "x",
"description": "The value to transate on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to translate on the y-axis.",
"type": "Number"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 445,
"description": "Translates the shape along the x-axis. When translating x and y coordinates,\nuse the `translate` method.",
"itemtype": "method",
"name": "translateX",
"params": [
{
"name": "x",
"description": "The value to translate.",
"type": "Number"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 458,
"description": "Translates the shape along the y-axis. When translating x and y coordinates,\nuse the `translate` method.",
"itemtype": "method",
"name": "translateY",
"params": [
{
"name": "y",
"description": "The value to translate.",
"type": "Number"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 471,
"description": "Skews the shape around the x-axis and y-axis.",
"itemtype": "method",
"name": "skew",
"params": [
{
"name": "x",
"description": "The value to skew on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to skew on the y-axis.",
"type": "Number"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 483,
"description": "Skews the shape around the x-axis.",
"itemtype": "method",
"name": "skewX",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 494,
"description": "Skews the shape around the y-axis.",
"itemtype": "method",
"name": "skewY",
"params": [
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 505,
"description": "Storage for `rotation` atribute.",
"itemtype": "property",
"name": "_rotation",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 514,
"description": "Rotates the shape clockwise around it transformOrigin.",
"itemtype": "method",
"name": "rotate",
"params": [
{
"name": "deg",
"description": "The degree of the rotation.",
"type": "Number"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 526,
"description": "Specifies a 2d scaling operation.",
"itemtype": "method",
"name": "scale",
"params": [
{
"name": "val",
"description": "",
"type": "Number"
}
],
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 537,
"description": "Adds a transform to the shape.",
"itemtype": "method",
"name": "_addTransform",
"params": [
{
"name": "type",
"description": "The transform being applied.",
"type": "String"
},
{
"name": "args",
"description": "The arguments for the transform.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 557,
"description": "Applies all transforms.",
"itemtype": "method",
"name": "_updateTransform",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 633,
"description": "Draws the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 653,
"description": "Updates `Shape` based on attribute changes.",
"itemtype": "method",
"name": "_updateHandler",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 664,
"description": "Storage for translateX",
"itemtype": "property",
"name": "_translateX",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 673,
"description": "Storage for translateY",
"itemtype": "property",
"name": "_translateY",
"type": "Number",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 682,
"description": "Storage for the transform attribute.",
"itemtype": "property",
"name": "_transform",
"type": "String",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 691,
"description": "Returns the bounds for a shape.\n\nCalculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.\nThe calculated bounding box is used by the graphic instance to calculate its viewBox.",
"itemtype": "method",
"name": "getBounds",
"return": {
"description": "Object"
},
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 749,
"description": "Returns the x coordinate for a bounding box's corner based on the corner's original x/y coordinates, rotation and transform origin of the rotation.",
"itemtype": "method",
"name": "_getRotatedCornerX",
"params": [
{
"name": "x",
"description": "original x-coordinate of corner",
"type": "Number"
},
{
"name": "y",
"description": "original y-coordinate of corner",
"type": "Number"
},
{
"name": "tox",
"description": "transform origin x-coordinate of rotation",
"type": "Number"
},
{
"name": "toy",
"description": "transform origin y-coordinate of rotation",
"type": "Number"
},
{
"name": "cosRadians",
"description": "cosine (in radians) of rotation",
"type": "Number"
},
{
"name": "sinRadians",
"description": "sin (in radians) or rotation",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 767,
"description": "Returns the y coordinate for a bounding box's corner based on the corner's original x/y coordinates, rotation and transform origin of the rotation.",
"itemtype": "method",
"name": "_getRotatedCornerY",
"params": [
{
"name": "x",
"description": "original x-coordinate of corner",
"type": "Number"
},
{
"name": "y",
"description": "original y-coordinate of corner",
"type": "Number"
},
{
"name": "tox",
"description": "transform origin x-coordinate of rotation",
"type": "Number"
},
{
"name": "toy",
"description": "transform origin y-coordinate of rotation",
"type": "Number"
},
{
"name": "cosRadians",
"description": "cosine (in radians) of rotation",
"type": "Number"
},
{
"name": "sinRadians",
"description": "sin (in radians) or rotation",
"type": "Number"
}
],
"return": {
"description": "Number"
},
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 785,
"description": "Destroys the instance.",
"itemtype": "method",
"name": "destroy",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 800,
"description": "An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a \nfraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].",
"itemtype": "config",
"name": "transformOrigin",
"type": "Array",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 814,
"description": "A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:\n \n
\n - rotate
- Rotates the shape clockwise around it transformOrigin.
\n - translate
- Specifies a 2d translation.
\n - skew
- Skews the shape around the x-axis and y-axis.
\n - scale
- Specifies a 2d scaling operation.
\n - translateX
- Translates the shape along the x-axis.
\n - translateY
- Translates the shape along the y-axis.
\n - skewX
- Skews the shape around the x-axis.
\n - skewY
- Skews the shape around the y-axis.
\n
\n\nApplying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform\nthat will apply the transform to the current matrix. The below code illustrates how you might use the `transform` attribute to instantiate a recangle with a rotation of 45 degrees.
\n var myRect = new Y.Rect({\n type:\"rect\",\n width: 50,\n height: 40,\n transform: \"rotate(45)\"\n };\nThe code below would apply `translate` and `rotate` to an existing shape.
\n \n myRect.set(\"transform\", \"translate(40, 50) rotate(45)\");",
"itemtype": "config",
"name": "transform",
"type": "String",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 861,
"description": "Unique id for class instance.",
"itemtype": "config",
"name": "id",
"type": "String",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 884,
"description": "Indicates the x position of shape.",
"itemtype": "config",
"name": "x",
"type": "Number",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 894,
"description": "Indicates the y position of shape.",
"itemtype": "config",
"name": "y",
"type": "Number",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 904,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 914,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 924,
"description": "Indicates whether the shape is visible.",
"itemtype": "config",
"name": "visible",
"type": "Boolean",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 940,
"description": "Contains information about the fill of the shape. \n \n - color
- The color of the fill.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.
\n - type
- Type of fill.\n
\n - solid
- Solid single color fill. (default)
\n - linear
- Linear gradient fill.
\n - radial
- Radial gradient fill.
\n
\n \n
\n If a `linear` or `radial` is specified as the fill type. The following additional property is used:\n
\n - stops
- An array of objects containing the following properties:\n
\n - color
- The color of the stop.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8
\n - offset
- Number between 0 and 1 indicating where the color stop is positioned.
\n
\n \n Linear gradients also have the following property:
\n - rotation
- Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)
\n Radial gradients have the following additional properties:
\n - r
- Radius of the gradient circle.
\n - fx
- Focal point x-coordinate of the gradient.
\n - fy
- Focal point y-coordinate of the gradient.
\n - cx
- \n
The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.
\n Note: Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape` classes which are used on Android or IE 6 - 8.
\n \n - cy
- \n
The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.
\n Note: Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape` classes which are used on Android or IE 6 - 8.
\n \n
",
"itemtype": "config",
"name": "fill",
"type": "Object",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 1000,
"description": "Contains information about the stroke of the shape.\n \n - color
- The color of the stroke.
\n - weight
- Number that indicates the width of the stroke.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.
\n - dashstyle
Indicates whether to draw a dashed stroke. When set to \"none\", a solid stroke is drawn. When set to an array, the first index indicates the\n length of the dash. The second index indicates the length of gap.\n - linecap
- Specifies the linecap for the stroke. The following values can be specified:\n
\n - butt (default)
- Specifies a butt linecap.
\n - square
- Specifies a sqare linecap.
\n - round
- Specifies a round linecap.
\n
\n \n - linejoin
- Specifies a linejoin for the stroke. The following values can be specified:\n
\n - round (default)
- Specifies that the linejoin will be round.
\n - bevel
- Specifies a bevel for the linejoin.
\n - miter limit
- An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having\n separate miter and miter limit values.
\n
\n \n
",
"itemtype": "config",
"name": "stroke",
"type": "Object",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 1081,
"description": "The node used for gradient fills.",
"itemtype": "config",
"name": "gradientNode",
"type": "HTMLElement",
"access": "private",
"tagname": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 1107,
"description": "Dom node for the shape.",
"itemtype": "config",
"name": "node",
"type": "HTMLElement",
"readonly": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/SVGShape.js",
"line": 1123,
"description": "Reference to the parent graphic instance",
"itemtype": "config",
"name": "graphic",
"type": "SVGGraphic",
"readonly": "",
"class": "SVGShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLCircle.js",
"line": 19,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "VMLCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLCircle.js",
"line": 30,
"description": "Radius for the circle.",
"itemtype": "config",
"name": "radius",
"type": "Number",
"class": "VMLCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLCircle.js",
"line": 42,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "VMLCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLCircle.js",
"line": 63,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "VMLCircle",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 30,
"description": "Current x position of the drqwing.",
"itemtype": "property",
"name": "_currentX",
"type": "Number",
"access": "private",
"tagname": "",
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 39,
"description": "Current y position of the drqwing.",
"itemtype": "property",
"name": "_currentY",
"type": "Number",
"access": "private",
"tagname": "",
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 48,
"description": "Draws a bezier curve.",
"itemtype": "method",
"name": "curveTo",
"params": [
{
"name": "cp1x",
"description": "x-coordinate for the first control point.",
"type": "Number"
},
{
"name": "cp1y",
"description": "y-coordinate for the first control point.",
"type": "Number"
},
{
"name": "cp2x",
"description": "x-coordinate for the second control point.",
"type": "Number"
},
{
"name": "cp2y",
"description": "y-coordinate for the second control point.",
"type": "Number"
},
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 77,
"description": "Draws a quadratic bezier curve.",
"itemtype": "method",
"name": "quadraticCurveTo",
"params": [
{
"name": "cpx",
"description": "x-coordinate for the control point.",
"type": "Number"
},
{
"name": "cpy",
"description": "y-coordinate for the control point.",
"type": "Number"
},
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 96,
"description": "Draws a rectangle.",
"itemtype": "method",
"name": "drawRect",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
}
],
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 116,
"description": "Draws a rectangle with rounded corners.",
"itemtype": "method",
"name": "drawRect",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
},
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
},
{
"name": "ew",
"description": "width of the ellipse used to draw the rounded corners",
"type": "Number"
},
{
"name": "eh",
"description": "height of the ellipse used to draw the rounded corners",
"type": "Number"
}
],
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 140,
"description": "Draws a wedge.",
"itemtype": "method",
"name": "drawWedge",
"params": [
{
"name": "x",
"description": "x-coordinate of the wedge's center point",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate of the wedge's center point",
"type": "Number"
},
{
"name": "startAngle",
"description": "starting angle in degrees",
"type": "Number"
},
{
"name": "arc",
"description": "sweep of the wedge. Negative values draw clockwise.",
"type": "Number"
},
{
"name": "radius",
"description": "radius of wedge. If [optional] yRadius is defined, then radius is the x radius.",
"type": "Number"
},
{
"name": "yRadius",
"description": "[optional] y radius for wedge.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 173,
"description": "Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.",
"itemtype": "method",
"name": "lineTo",
"params": [
{
"name": "point1",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "point2",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 202,
"description": "Moves the current drawing position to specified x and y coordinates.",
"itemtype": "method",
"name": "moveTo",
"params": [
{
"name": "x",
"description": "x-coordinate for the end point.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the end point.",
"type": "Number"
}
],
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 220,
"description": "Draws the graphic.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 263,
"description": "Completes a drawing operation.",
"itemtype": "method",
"name": "end",
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 273,
"description": "Clears the path.",
"itemtype": "method",
"name": "clear",
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLDrawing.js",
"line": 283,
"description": "Updates the size of the graphics object",
"itemtype": "method",
"name": "_trackSize",
"params": [
{
"name": "w",
"description": "width",
"type": "Number"
},
{
"name": "h",
"description": "height",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "VMLDrawing",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLEllipse.js",
"line": 19,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "VMLEllipse",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 18,
"description": "Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.",
"itemtype": "config",
"name": "render",
"type": "Node | String",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 26,
"description": "Unique id for class instance.",
"itemtype": "config",
"name": "id",
"type": "String",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 49,
"description": "Key value pairs in which a shape instance is associated with its id.",
"itemtype": "config",
"name": "shapes",
"type": "Object",
"readonly": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 65,
"description": "Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.",
"itemtype": "config",
"name": "contentBounds",
"type": "Object",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 80,
"description": "The html element that represents to coordinate system of the Graphic instance.",
"itemtype": "config",
"name": "node",
"type": "HTMLElement",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 95,
"description": "Indicates the width of the `Graphic`.",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 112,
"description": "Indicates the height of the `Graphic`.",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 129,
"description": "Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents.\nIf false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.",
"itemtype": "config",
"name": "autoSize",
"type": "Boolean",
"default": "false",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 141,
"description": "The contentBounds will resize to greater values but not values. (for performance)\nWhen resizing the contentBounds down is desirable, set the resizeDown value to true.",
"itemtype": "config",
"name": "resizeDown",
"type": "Boolean",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 162,
"description": "Indicates the x-coordinate for the instance.",
"itemtype": "config",
"name": "x",
"type": "Number",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 185,
"description": "Indicates the y-coordinate for the instance.",
"itemtype": "config",
"name": "y",
"type": "Number",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 208,
"description": "Indicates whether or not the instance will automatically redraw after a change is made to a shape.\nThis property will get set to false when batching operations.",
"itemtype": "config",
"name": "autoDraw",
"type": "Boolean",
"default": "true",
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 233,
"description": "Storage for `x` attribute.",
"itemtype": "property",
"name": "_x",
"type": "Number",
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 242,
"description": "Storage for `y` attribute.",
"itemtype": "property",
"name": "_y",
"type": "Number",
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 251,
"description": "Gets the current position of the graphic instance in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "Array The XY position of the shape."
},
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 268,
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_resizeDown",
"type": "Boolean",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 275,
"description": "Initializes the class.",
"itemtype": "method",
"name": "initializer",
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 298,
"description": "Adds the graphics node to the dom.",
"itemtype": "method",
"name": "render",
"params": [
{
"name": "parentNode",
"description": "node in which to render the graphics node into.",
"type": "HTMLElement"
}
],
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 317,
"description": "Removes all nodes.",
"itemtype": "method",
"name": "destroy",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 328,
"description": "Generates a shape instance by type.",
"itemtype": "method",
"name": "addShape",
"params": [
{
"name": "cfg",
"description": "attributes for the shape",
"type": "Object"
}
],
"return": {
"description": "Shape"
},
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 344,
"description": "Adds a shape instance to the graphic instance.",
"itemtype": "method",
"name": "_appendShape",
"params": [
{
"name": "shape",
"description": "The shape instance to be added to the graphic.",
"type": "Shape"
}
],
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 365,
"description": "Removes a shape instance from from the graphic instance.",
"itemtype": "method",
"name": "removeShape",
"params": [
{
"name": "shape",
"description": "The instance or id of the shape to be removed.",
"type": "Shape|String"
}
],
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 391,
"description": "Removes all shape instances from the dom.",
"itemtype": "method",
"name": "removeAllShapes",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 410,
"description": "Removes all child nodes.",
"itemtype": "method",
"name": "_removeChildren",
"params": [
{
"name": "node",
"description": ""
}
],
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 431,
"description": "Clears the graphics object.",
"itemtype": "method",
"name": "clear",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 441,
"description": "Toggles visibility",
"itemtype": "method",
"name": "_toggleVisible",
"params": [
{
"name": "val",
"description": "indicates visibilitye",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 466,
"description": "Sets the size of the graphics object.",
"itemtype": "method",
"name": "setSize",
"params": [
{
"name": "w",
"description": "width to set for the instance.",
"type": "Number"
},
{
"name": "h",
"description": "height to set for the instance.",
"type": "Number"
}
],
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 481,
"description": "Sets the positon of the graphics object.",
"itemtype": "method",
"name": "setPosition",
"params": [
{
"name": "x",
"description": "x-coordinate for the object.",
"type": "Number"
},
{
"name": "y",
"description": "y-coordinate for the object.",
"type": "Number"
}
],
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 496,
"description": "Creates a group element",
"itemtype": "method",
"name": "_createGraphic",
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 509,
"description": "Creates a graphic node",
"itemtype": "method",
"name": "_createGraphicNode",
"params": [
{
"name": "type",
"description": "node type to create",
"type": "String"
},
{
"name": "pe",
"description": "specified pointer-events value",
"type": "String"
}
],
"return": {
"description": "HTMLElement"
},
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 524,
"description": "Returns a shape based on the id of its dom node.",
"itemtype": "method",
"name": "getShapeById",
"params": [
{
"name": "id",
"description": "Dom id of the shape's node attribute.",
"type": "String"
}
],
"return": {
"description": "Shape"
},
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 536,
"description": "Returns a shape class. Used by `addShape`.",
"itemtype": "method",
"name": "_getShapeClass",
"params": [
{
"name": "val",
"description": "Indicates which shape class.",
"type": "Shape | String"
}
],
"return": {
"description": "Function"
},
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 554,
"description": "Look up for shape classes. Used by `addShape` to retrieve a class for instantiation.",
"itemtype": "property",
"name": "_shapeClass",
"type": "Object",
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 569,
"description": "Allows for creating multiple shapes in order to batch appending and redraw operations.",
"itemtype": "method",
"name": "batch",
"params": [
{
"name": "method",
"description": "Method to execute.",
"type": "Function"
}
],
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 584,
"description": "Returns a document fragment to for attaching shapes.",
"itemtype": "method",
"name": "_getDocFrag",
"return": {
"description": "DocumentFragment"
},
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 600,
"description": "Adds a shape to the redraw queue and calculates the contentBounds.",
"itemtype": "method",
"name": "addToRedrawQueue",
"params": [
{
"name": "shape",
"description": "",
"type": "VMLShape"
}
],
"access": "protected",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 630,
"description": "Redraws all shapes.",
"itemtype": "method",
"name": "_redraw",
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLGraphic.js",
"line": 650,
"description": "Recalculates and returns the `contentBounds` for the `Graphic` instance.",
"itemtype": "method",
"name": "_getUpdatedContentBounds",
"return": {
"description": "",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "VMLGraphic",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPath.js",
"line": 18,
"description": "Updates `Shape` based on attribute changes.",
"itemtype": "method",
"name": "_updateHandler",
"access": "private",
"tagname": "",
"class": "VMLPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPath.js",
"line": 33,
"description": "Indicates the width of the shape",
"itemtype": "config",
"name": "width",
"type": "Number",
"class": "VMLPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPath.js",
"line": 52,
"description": "Indicates the height of the shape",
"itemtype": "config",
"name": "height",
"type": "Number",
"class": "VMLPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPath.js",
"line": 71,
"description": "Indicates the path used for the node.",
"itemtype": "config",
"name": "path",
"type": "String",
"readonly": "",
"class": "VMLPath",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPieSlice.js",
"line": 14,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "VMLPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPieSlice.js",
"line": 23,
"description": "Change event listener",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_updateHandler",
"class": "VMLPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPieSlice.js",
"line": 49,
"description": "Starting angle in relation to a circle in which to begin the pie slice drawing.",
"itemtype": "config",
"name": "startAngle",
"type": "Number",
"class": "VMLPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPieSlice.js",
"line": 59,
"description": "Arc of the slice.",
"itemtype": "config",
"name": "arc",
"type": "Number",
"class": "VMLPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLPieSlice.js",
"line": 69,
"description": "Radius of the circle in which the pie slice is drawn",
"itemtype": "config",
"name": "radius",
"type": "Number",
"class": "VMLPieSlice",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLRect.js",
"line": 17,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "VMLRect",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 23,
"description": "Indicates the type of shape",
"itemtype": "property",
"name": "_type",
"type": "String",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 32,
"description": "Init method, invoked during construction.\nCalls `initializer` method.",
"itemtype": "method",
"name": "init",
"access": "protected",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 44,
"description": "Initializes the shape",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_initialize",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 59,
"description": "Creates the dom node for the shape.",
"itemtype": "method",
"name": "createNode",
"return": {
"description": "HTMLElement"
},
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 162,
"description": "Add a class name to each node.",
"itemtype": "method",
"name": "addClass",
"params": [
{
"name": "className",
"description": "the class name to add to the node's class attribute",
"type": "String"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 174,
"description": "Removes a class name from each node.",
"itemtype": "method",
"name": "removeClass",
"params": [
{
"name": "className",
"description": "the class name to remove from the node's class attribute",
"type": "String"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 186,
"description": "Gets the current position of the node in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "Array The XY position of the shape."
},
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 201,
"description": "Set the position of the shape in page coordinates, regardless of how the node is positioned.",
"itemtype": "method",
"name": "setXY",
"params": [
{
"name": "Contains",
"description": "x & y values for new position (coordinates are page-based)",
"type": "Array"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 216,
"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",
"itemtype": "method",
"name": "contains",
"params": [
{
"name": "needle",
"description": "The possible node or descendent",
"type": "VMLShape | HTMLElement"
}
],
"return": {
"description": "Boolean Whether or not this shape is the needle or its ancestor."
},
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 228,
"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",
"itemtype": "method",
"name": "compareTo",
"params": [
{
"name": "refNode",
"description": "The reference node to compare to the node.",
"type": "HTMLElement | Node"
}
],
"return": {
"description": "True if the nodes match, false if they do not.",
"type": "Boolean"
},
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 241,
"description": "Test if the supplied node matches the supplied selector.",
"itemtype": "method",
"name": "test",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "Boolean Wheter or not the shape matches the selector."
},
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 253,
"description": "Calculates and returns properties for setting an initial stroke.",
"itemtype": "method",
"name": "_getStrokeProps",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 320,
"description": "Adds a stroke to the shape node.",
"itemtype": "method",
"name": "_strokeChangeHandler",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 402,
"description": "Calculates and returns properties for setting an initial fill.",
"itemtype": "method",
"name": "_getFillProps",
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 460,
"description": "Adds a fill to the shape node.",
"itemtype": "method",
"name": "_fillChangeHandler",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 554,
"description": "Calculates and returns an object containing gradient properties for a fill node.",
"itemtype": "method",
"name": "_getGradientFill",
"params": [
{
"name": "fill",
"description": "Object containing fill properties.",
"type": "Object"
}
],
"return": {
"description": "Object"
},
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 642,
"description": "Adds a transform to the shape.",
"itemtype": "method",
"name": "_addTransform",
"params": [
{
"name": "type",
"description": "The transform being applied.",
"type": "String"
},
{
"name": "args",
"description": "The arguments for the transform.",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 662,
"description": "Applies all transforms.",
"itemtype": "method",
"name": "_updateTransform",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 765,
"description": "Storage for translateX",
"itemtype": "property",
"name": "_translateX",
"type": "Number",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 774,
"description": "Storage for translateY",
"itemtype": "property",
"name": "_translateY",
"type": "Number",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 783,
"description": "Storage for the transform attribute.",
"itemtype": "property",
"name": "_transform",
"type": "String",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 792,
"description": "Specifies a 2d translation.",
"itemtype": "method",
"name": "translate",
"params": [
{
"name": "x",
"description": "The value to transate on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to translate on the y-axis.",
"type": "Number"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 806,
"description": "Translates the shape along the x-axis. When translating x and y coordinates,\nuse the `translate` method.",
"itemtype": "method",
"name": "translateX",
"params": [
{
"name": "x",
"description": "The value to translate.",
"type": "Number"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 819,
"description": "Performs a translate on the y-coordinate. When translating x and y coordinates,\nuse the `translate` method.",
"itemtype": "method",
"name": "translateY",
"params": [
{
"name": "y",
"description": "The value to translate.",
"type": "Number"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 832,
"description": "Skews the shape around the x-axis and y-axis.",
"itemtype": "method",
"name": "skew",
"params": [
{
"name": "x",
"description": "The value to skew on the x-axis.",
"type": "Number"
},
{
"name": "y",
"description": "The value to skew on the y-axis.",
"type": "Number"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 844,
"description": "Skews the shape around the x-axis.",
"itemtype": "method",
"name": "skewX",
"params": [
{
"name": "x",
"description": "x-coordinate",
"type": "Number"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 855,
"description": "Skews the shape around the y-axis.",
"itemtype": "method",
"name": "skewY",
"params": [
{
"name": "y",
"description": "y-coordinate",
"type": "Number"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 867,
"description": "Storage for `rotation` atribute.",
"itemtype": "property",
"name": "_rotation",
"type": "Number",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 876,
"description": "Rotates the shape clockwise around it transformOrigin.",
"itemtype": "method",
"name": "rotate",
"params": [
{
"name": "deg",
"description": "The degree of the rotation.",
"type": "Number"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 888,
"description": "Specifies a 2d scaling operation.",
"itemtype": "method",
"name": "scale",
"params": [
{
"name": "val",
"description": "",
"type": "Number"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 899,
"description": "Overrides default `on` method. Checks to see if its a dom interaction event. If so, \nreturn an event attached to the `node` element. If not, return the normal functionality.",
"itemtype": "method",
"name": "on",
"params": [
{
"name": "type",
"description": "event type",
"type": "String"
},
{
"name": "callback",
"description": "function",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 917,
"description": "Draws the shape.",
"itemtype": "method",
"name": "_draw",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 927,
"description": "Updates `Shape` based on attribute changes.",
"itemtype": "method",
"name": "_updateHandler",
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 945,
"description": "Creates a graphic node",
"itemtype": "method",
"name": "_createGraphicNode",
"params": [
{
"name": "type",
"description": "node type to create",
"type": "String"
}
],
"return": {
"description": "HTMLElement"
},
"access": "private",
"tagname": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 959,
"description": "Value function for fill attribute",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getDefaultFill",
"return": {
"description": "Object"
},
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 977,
"description": "Value function for stroke attribute",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_getDefaultStroke",
"return": {
"description": "Object"
},
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 994,
"description": "Sets the value of an attribute.",
"itemtype": "method",
"name": "set",
"params": [
{
"name": "name",
"description": "The name of the attribute. Alternatively, an object of key value pairs can \nbe passed in to set multiple attributes at once.",
"type": "String|Object"
},
{
"name": "value",
"description": "The value to set the attribute to. This value is ignored if an object is received as \nthe name param.",
"type": "Any"
}
],
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1013,
"description": "Returns the bounds for a shape.\n\nCalculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.\nThe calculated bounding box is used by the graphic instance to calculate its viewBox.",
"itemtype": "method",
"name": "getBounds",
"params": [
{
"name": "optional",
"description": "cfg Reference to matrix instance",
"type": "Matrix",
"optional": true
}
],
"return": {
"description": "Object"
},
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1071,
"description": "Destroys shape",
"itemtype": "method",
"name": "destroy",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1099,
"description": "An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a \nfraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].",
"itemtype": "config",
"name": "transformOrigin",
"type": "Array",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1113,
"description": "A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:\n \n
\n - rotate
- Rotates the shape clockwise around it transformOrigin.
\n - translate
- Specifies a 2d translation.
\n - skew
- Skews the shape around the x-axis and y-axis.
\n - scale
- Specifies a 2d scaling operation.
\n - translateX
- Translates the shape along the x-axis.
\n - translateY
- Translates the shape along the y-axis.
\n - skewX
- Skews the shape around the x-axis.
\n - skewY
- Skews the shape around the y-axis.
\n
\n\nApplying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains corresponding methods for each transform\nthat will apply the transform to the current matrix. The below code illustrates how you might use the `transform` attribute to instantiate a recangle with a rotation of 45 degrees.
\n var myRect = new Y.Rect({\n type:\"rect\",\n width: 50,\n height: 40,\n transform: \"rotate(45)\"\n };\nThe code below would apply `translate` and `rotate` to an existing shape.
\n \n myRect.set(\"transform\", \"translate(40, 50) rotate(45)\");",
"itemtype": "config",
"name": "transform",
"type": "String",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1173,
"description": "Indicates the x position of shape.",
"itemtype": "config",
"name": "x",
"type": "Number",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1183,
"description": "Indicates the y position of shape.",
"itemtype": "config",
"name": "y",
"type": "Number",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1193,
"description": "Unique id for class instance.",
"itemtype": "config",
"name": "id",
"type": "String",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1216,
"itemtype": "config",
"name": "width",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1224,
"itemtype": "config",
"name": "height",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1232,
"description": "Indicates whether the shape is visible.",
"itemtype": "config",
"name": "visible",
"type": "Boolean",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1252,
"description": "Contains information about the fill of the shape. \n \n - color
- The color of the fill.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.
\n - type
- Type of fill.\n
\n - solid
- Solid single color fill. (default)
\n - linear
- Linear gradient fill.
\n - radial
- Radial gradient fill.
\n
\n \n
\n If a `linear` or `radial` is specified as the fill type. The following additional property is used:\n
\n - stops
- An array of objects containing the following properties:\n
\n - color
- The color of the stop.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the stop. The default value is 1. Note: No effect for IE 6 - 8
\n - offset
- Number between 0 and 1 indicating where the color stop is positioned.
\n
\n \n Linear gradients also have the following property:
\n - rotation
- Linear gradients flow left to right by default. The rotation property allows you to change the flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)
\n Radial gradients have the following additional properties:
\n - r
- Radius of the gradient circle.
\n - fx
- Focal point x-coordinate of the gradient.
\n - fy
- Focal point y-coordinate of the gradient.
\n
\n The corresponding `SVGShape` class implements the following additional properties.
\n \n - cx
- \n
The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.
\n \n - cy
- \n
The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.
\n \n
\n These properties are not currently implemented in `CanvasShape` or `VMLShape`.
",
"itemtype": "config",
"name": "fill",
"type": "Object",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1332,
"description": "Contains information about the stroke of the shape.\n \n - color
- The color of the stroke.
\n - weight
- Number that indicates the width of the stroke.
\n - opacity
- Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.
\n - dashstyle
Indicates whether to draw a dashed stroke. When set to \"none\", a solid stroke is drawn. When set to an array, the first index indicates the\n length of the dash. The second index indicates the length of gap.\n - linecap
- Specifies the linecap for the stroke. The following values can be specified:\n
\n - butt (default)
- Specifies a butt linecap.
\n - square
- Specifies a sqare linecap.
\n - round
- Specifies a round linecap.
\n
\n \n - linejoin
- Specifies a linejoin for the stroke. The following values can be specified:\n
\n - round (default)
- Specifies that the linejoin will be round.
\n - bevel
- Specifies a bevel for the linejoin.
\n - miter limit
- An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin of miter, you simply specify the limit as opposed to having\n separate miter and miter limit values.
\n
\n \n
",
"itemtype": "config",
"name": "stroke",
"type": "Object",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1408,
"description": "Dom node for the shape.",
"itemtype": "config",
"name": "node",
"type": "HTMLElement",
"readonly": "",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/graphics/js/VMLShape.js",
"line": 1424,
"description": "Reference to the container Graphic.",
"itemtype": "config",
"name": "graphic",
"type": "Graphic",
"class": "VMLShape",
"module": "graphics"
},
{
"file": "lib/yui3/src/highlight/js/highlight-accentfold.js",
"line": 21,
"description": "Accent-folding version of `all()`.",
"itemtype": "method",
"name": "allFold",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings that should be\n highlighted.",
"type": "String|String[]"
},
{
"name": "options",
"description": "Options object.",
"type": "Object",
"optional": true,
"props": [
{
"name": "startsWith",
"description": "If `true`, matches must be\n anchored to the beginning of the string.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
]
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-accentfold"
},
{
"file": "lib/yui3/src/highlight/js/highlight-accentfold.js",
"line": 100,
"description": "Accent-folding version of `start()`.",
"itemtype": "method",
"name": "startFold",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings that should be\n highlighted.",
"type": "String|String[]"
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-accentfold"
},
{
"file": "lib/yui3/src/highlight/js/highlight-accentfold.js",
"line": 114,
"description": "Accent-folding version of `words()`.",
"itemtype": "method",
"name": "wordsFold",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings containing words\n that should be highlighted. If a string is passed, it will be split\n into words; if an array is passed, it is assumed to have already been\n split.",
"type": "String|String[]"
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-accentfold"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 42,
"description": "Regular expression template for highlighting a match that occurs anywhere\nin a string. The placeholder `%needles` will be replaced with a list of\nneedles to match, joined by `|` characters.\n\nThis regex should have two capturing subpatterns:\n\n 1. Zero or one unclosed HTML entity (e.g. \"&\" without a \";\" at the\n end).\n 2. The `%needles` placeholder.\n\nThe first subpattern match is used to emulate a negative lookbehind\nassertion in order to prevent highlighting inside HTML entities.",
"itemtype": "property",
"name": "_REGEX",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"final": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 64,
"description": "Regex replacer function or string for normal matches.",
"itemtype": "property",
"name": "_REPLACER",
"type": "Function|String",
"access": "protected",
"tagname": "",
"static": 1,
"final": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 81,
"description": "Regular expression template for highlighting start-of-string matches\n(i.e., only matches that occur at the beginning of a string). The\nplaceholder `%needles` will be replaced with a list of needles to match,\njoined by `|` characters.\n\nSee `_REGEX` for a description of the capturing subpatterns this regex\nstring should contain.",
"itemtype": "property",
"name": "_START_REGEX",
"type": "String",
"access": "protected",
"tagname": "",
"static": 1,
"final": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 98,
"description": "Highlight template which will be used as a replacement for matched\nsubstrings. The placeholder `{s}` will be replaced with the matched\nsubstring.",
"itemtype": "property",
"name": "_TEMPLATE",
"type": "String",
"default": "'{s}'",
"access": "protected",
"tagname": "",
"static": 1,
"final": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 114,
"description": "Highlights all occurrences in the _haystack_ string of the items in the\n_needles_ array, regardless of where they occur. The returned string will\nhave all HTML characters escaped except for the highlighting markup.",
"itemtype": "method",
"name": "all",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings that should be\n highlighted.",
"type": "String|String[]"
},
{
"name": "options",
"description": "Options object.",
"type": "Object",
"optional": true,
"props": [
{
"name": "caseSensitive",
"description": "If `true`, matching will\n be case-sensitive.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
},
{
"name": "startsWith",
"description": "If `true`, matches must be\n anchored to the beginning of the string.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
]
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 175,
"description": "Same as `all()`, but case-sensitive by default.",
"itemtype": "method",
"name": "allCase",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings that should be\n highlighted.",
"type": "String|String[]"
},
{
"name": "options",
"description": "Options object. See `all()` for details.",
"type": "Object",
"optional": true
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 191,
"description": "Highlights _needles_ that occur at the start of _haystack_. The returned\nstring will have all HTML characters escaped except for the highlighting\nmarkup.",
"itemtype": "method",
"name": "start",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings that should be\n highlighted.",
"type": "String|String[]"
},
{
"name": "options",
"description": "Options object.",
"type": "Object",
"optional": true,
"props": [
{
"name": "caseSensitive",
"description": "If `true`, matching will\n be case-sensitive.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
]
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 211,
"description": "Same as `start()`, but case-sensitive by default.",
"itemtype": "method",
"name": "startCase",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings that should be\n highlighted.",
"type": "String|String[]"
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 228,
"description": "Highlights complete words in the _haystack_ string that are also in the\n_needles_ array. The returned string will have all HTML characters escaped\nexcept for the highlighting markup.",
"itemtype": "method",
"name": "words",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings containing words\n that should be highlighted. If a string is passed, it will be split\n into words; if an array is passed, it is assumed to have already been\n split.",
"type": "String|String[]"
},
{
"name": "options",
"description": "Options object.",
"type": "Object",
"optional": true,
"props": [
{
"name": "caseSensitive",
"description": "If `true`, matching will\n be case-sensitive.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
]
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/highlight/js/highlight-base.js",
"line": 287,
"description": "Same as `words()`, but case-sensitive by default.",
"itemtype": "method",
"name": "wordsCase",
"params": [
{
"name": "haystack",
"description": "String to apply highlighting to.",
"type": "String"
},
{
"name": "needles",
"description": "String or array of strings containing words\n that should be highlighted. If a string is passed, it will be split\n into words; if an array is passed, it is assumed to have already been\n split.",
"type": "String|String[]"
}
],
"return": {
"description": "Escaped and highlighted copy of _haystack_.",
"type": "String"
},
"static": 1,
"class": "Highlight",
"module": "highlight",
"submodule": "highlight-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 72,
"description": "Returns true if value is a simple object and not a\nfunction or an array.",
"itemtype": "method",
"name": "_isSimpleObject",
"params": [
{
"name": "value",
"description": "",
"type": "Mixed"
}
],
"return": {
"description": "",
"type": "Boolean"
},
"access": "private",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 87,
"description": "Name of this component.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 96,
"description": "Constant used to identify state changes originating from the\nadd() method.",
"itemtype": "property",
"name": "SRC_ADD",
"type": "String",
"static": 1,
"final": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 107,
"description": "Constant used to identify state changes originating from the\nreplace() method.",
"itemtype": "property",
"name": "SRC_REPLACE",
"type": "String",
"static": 1,
"final": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 118,
"description": "Whether or not this browser supports the HTML5 History API.",
"itemtype": "property",
"name": "html5",
"type": "Boolean",
"static": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 132,
"description": "Whether or not this browser supports the window.onhashchange\nevent natively. Note that even if this is true, you may\nstill want to use HistoryHash's synthetic hashchange event\nsince it normalizes implementation differences and fixes spec violations\nacross various browsers.",
"itemtype": "property",
"name": "nativeHashChange",
"type": "Boolean",
"static": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 157,
"description": "Initializes this HistoryBase instance. This method is called by the\nconstructor.",
"itemtype": "method",
"name": "_init",
"params": [
{
"name": "config",
"description": "configuration object",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 168,
"description": "Configuration object provided by the user on instantiation, or an\nempty object if one wasn't provided.",
"itemtype": "property",
"name": "_config",
"type": "Object",
"default": "{}",
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 179,
"description": "If `true`, a `history:change` event will be fired whenever the URL\nchanges, even if there is no associated state change.",
"itemtype": "property",
"name": "force",
"type": "Boolean",
"default": "false",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 189,
"description": "Resolved initial state: a merge of the user-supplied initial state\n(if any) and any initial state provided by a subclass. This may\ndiffer from _config.initialState. If neither the config\nnor a subclass supplies an initial state, this property will be\nnull.",
"itemtype": "property",
"name": "_initialState",
"type": "Object|null",
"default": "{}",
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 204,
"description": "Fired when the state changes. To be notified of all state changes\nregardless of the History or YUI instance that generated them,\nsubscribe to this event on Y.Global. If you would rather\nbe notified only about changes generated by this specific History\ninstance, subscribe to this event on the instance.",
"itemtype": "event",
"name": "history:change",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n\n - changed (Object)
\n - \n Object hash of state items that have been added or changed. The\n key is the item key, and the value is an object containing\n
newVal and prevVal properties\n representing the values of the item both before and after the\n change. If the item was newly added, prevVal will be\n undefined.\n \n\n - newVal (Object)
\n - \n Object hash of key/value pairs of all state items after the\n change.\n
\n\n - prevVal (Object)
\n - \n Object hash of key/value pairs of all state items before the\n change.\n
\n\n - removed (Object)
\n - \n Object hash of key/value pairs of state items that have been\n removed. Values are the old values prior to removal.\n
\n\n - src (String)
\n - \n The source of the event. This can be used to selectively ignore\n events generated by certain sources.\n
\n
",
"type": "EventFacade"
}
],
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 264,
"description": "Adds a state entry with new values for the specified keys. By default,\nthe new state will be merged into the existing state, and new values will\noverride existing values. Specifying a null or\nundefined value will cause that key to be removed from the\nnew state entry.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "state",
"description": "Object hash of key/value pairs.",
"type": "Object"
},
{
"name": "options",
"description": "(optional) Zero or more of the following options:\n \n - merge (Boolean)
\n - \n
\n If true (the default), the new state will be merged\n into the existing state. New values will override existing values,\n and null or undefined values will be\n removed from the state.\n
\n\n \n If false, the existing state will be discarded as a\n whole and the new state will take its place.\n
\n \n
",
"type": "Object"
}
],
"chainable": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 298,
"description": "Adds a state entry with a new value for a single key. By default, the new\nvalue will be merged into the existing state values, and will override an\nexisting value with the same key if there is one. Specifying a\nnull or undefined value will cause the key to\nbe removed from the new state entry.",
"itemtype": "method",
"name": "addValue",
"params": [
{
"name": "key",
"description": "State parameter key.",
"type": "String"
},
{
"name": "value",
"description": "New value.",
"type": "String"
},
{
"name": "options",
"description": "(optional) Zero or more options. See\n add() for a list of supported options.",
"type": "Object"
}
],
"chainable": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 318,
"description": "Returns the current value of the state parameter specified by key,\nor an object hash of key/value pairs for all current state parameters if\nno key is specified.",
"itemtype": "method",
"name": "get",
"params": [
{
"name": "key",
"description": "(optional) State parameter key.",
"type": "String"
}
],
"return": {
"description": "Value of the specified state parameter, or an\n object hash of key/value pairs for all current state parameters.",
"type": "Object|String"
},
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 339,
"description": "Same as add() except that a new browser history entry will\nnot be created. Instead, the current history entry will be replaced with\nthe new state.",
"itemtype": "method",
"name": "replace",
"params": [
{
"name": "state",
"description": "Object hash of key/value pairs.",
"type": "Object"
},
{
"name": "options",
"description": "(optional) Zero or more options. See\n add() for a list of supported options.",
"type": "Object"
}
],
"chainable": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 356,
"description": "Same as addValue() except that a new browser history entry\nwill not be created. Instead, the current history entry will be replaced\nwith the new state.",
"itemtype": "method",
"name": "replaceValue",
"params": [
{
"name": "key",
"description": "State parameter key.",
"type": "String"
},
{
"name": "value",
"description": "New value.",
"type": "String"
},
{
"name": "options",
"description": "(optional) Zero or more options. See\n add() for a list of supported options.",
"type": "Object"
}
],
"chainable": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 376,
"description": "Changes the state. This method provides a common implementation shared by\nthe public methods for changing state.",
"itemtype": "method",
"name": "_change",
"params": [
{
"name": "src",
"description": "Source of the change, for inclusion in event facades\n to facilitate filtering.",
"type": "String"
},
{
"name": "state",
"description": "Object hash of key/value pairs.",
"type": "Object"
},
{
"name": "options",
"description": "(optional) Zero or more options. See\n add() for a list of supported options.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"chainable": 1,
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 401,
"description": "Called by _resolveChanges() when the state has changed. This method takes\ncare of actually firing the necessary events.",
"itemtype": "method",
"name": "_fireEvents",
"params": [
{
"name": "src",
"description": "Source of the changes, for inclusion in event facades\n to facilitate filtering.",
"type": "String"
},
{
"name": "changes",
"description": "Resolved changes.",
"type": "Object"
},
{
"name": "options",
"description": "Zero or more options. See add() for\n a list of supported options.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 434,
"description": "Fires a dynamic \"[key]Change\" event.",
"itemtype": "method",
"name": "_fireChangeEvent",
"params": [
{
"name": "src",
"description": "source of the change, for inclusion in event facades\n to facilitate filtering",
"type": "String"
},
{
"name": "key",
"description": "key of the item that was changed",
"type": "String"
},
{
"name": "value",
"description": "object hash containing newVal and\n prevVal properties for the changed item",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 446,
"description": "\nDynamic event fired when an individual history item is added or\nchanged. The name of this event depends on the name of the key that\nchanged. To listen to change events for a key named \"foo\", subscribe\nto the fooChange event; for a key named \"bar\", subscribe\nto barChange, etc.\n
\n\n\nKey-specific events are only fired for instance-level changes; that\nis, changes that were made via the same History instance on which the\nevent is subscribed. To be notified of changes made by other History\ninstances, subscribe to the global history:change event.\n
",
"itemtype": "event",
"name": "[key]Change",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n\n - newVal (mixed)
\n - \n The new value of the item after the change.\n
\n\n - prevVal (mixed)
\n - \n The previous value of the item before the change, or\n
undefined if the item was just added and has no\n previous value.\n \n\n - src (String)
\n - \n The source of the event. This can be used to selectively ignore\n events generated by certain sources.\n
\n
",
"type": "EventFacade"
}
],
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 493,
"description": "Fires a dynamic \"[key]Remove\" event.",
"itemtype": "method",
"name": "_fireRemoveEvent",
"params": [
{
"name": "src",
"description": "source of the change, for inclusion in event facades\n to facilitate filtering",
"type": "String"
},
{
"name": "key",
"description": "key of the item that was removed",
"type": "String"
},
{
"name": "value",
"description": "value of the item prior to its removal",
"type": "Mixed"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 504,
"description": "\nDynamic event fired when an individual history item is removed. The\nname of this event depends on the name of the key that was removed.\nTo listen to remove events for a key named \"foo\", subscribe to the\nfooRemove event; for a key named \"bar\", subscribe to\nbarRemove, etc.\n
\n\n\nKey-specific events are only fired for instance-level changes; that\nis, changes that were made via the same History instance on which the\nevent is subscribed. To be notified of changes made by other History\ninstances, subscribe to the global history:change event.\n
",
"itemtype": "event",
"name": "[key]Remove",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n\n - prevVal (mixed)
\n - \n The value of the item before it was removed.\n
\n\n - src (String)
\n - \n The source of the event. This can be used to selectively ignore\n events generated by certain sources.\n
\n
",
"type": "EventFacade"
}
],
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 543,
"description": "Resolves the changes (if any) between newState and the current\nstate and fires appropriate events if things have changed.",
"itemtype": "method",
"name": "_resolveChanges",
"params": [
{
"name": "src",
"description": "source of the changes, for inclusion in event facades\n to facilitate filtering",
"type": "String"
},
{
"name": "newState",
"description": "object hash of key/value pairs representing the\n new state",
"type": "Object"
},
{
"name": "options",
"description": "Zero or more options. See add() for\n a list of supported options.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 602,
"description": "Stores the specified state. Don't call this method directly; go through\n_resolveChanges() to ensure that changes are resolved and all events are\nfired properly.",
"itemtype": "method",
"name": "_storeState",
"params": [
{
"name": "src",
"description": "source of the changes",
"type": "String"
},
{
"name": "newState",
"description": "new state to store",
"type": "Object"
},
{
"name": "options",
"description": "Zero or more options. See add() for\n a list of supported options.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-base.js",
"line": 622,
"description": "Default history:change event handler.",
"itemtype": "method",
"name": "_defChangeFn",
"params": [
{
"name": "e",
"description": "state change event facade",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryBase",
"module": "history",
"submodule": "history-base"
},
{
"file": "lib/yui3/src/history/js/history-hash-ie.js",
"line": 23,
"description": "Gets the raw (not decoded) current location hash from the IE iframe,\nminus the preceding '#' character and the hashPrefix (if one is set).",
"itemtype": "method",
"name": "getIframeHash",
"return": {
"description": "current iframe hash",
"type": "String"
},
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash-ie"
},
{
"file": "lib/yui3/src/history/js/history-hash-ie.js",
"line": 43,
"description": "Updates the history iframe with the specified hash.",
"itemtype": "method",
"name": "_updateIframe",
"params": [
{
"name": "hash",
"description": "location hash",
"type": "String"
},
{
"name": "replace",
"description": "(optional) if true, the current\n history state will be replaced without adding a new history entry",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash-ie"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 88,
"description": "Handler for hashchange events.",
"itemtype": "method",
"name": "_afterHashChange",
"params": [
{
"name": "e",
"description": "",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 102,
"description": "Constant used to identify state changes originating from\nhashchange events.",
"itemtype": "property",
"name": "SRC_HASH",
"type": "String",
"static": 1,
"final": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 113,
"description": "\nPrefix to prepend when setting the hash fragment. For example, if the\nprefix is ! and the hash fragment is set to\n#foo=bar&baz=quux, the final hash fragment in the URL will\nbecome #!foo=bar&baz=quux. This can be used to help make an\nAjax application crawlable in accordance with Google's guidelines at\nhttp://code.google.com/web/ajaxcrawling/.\n
\n\n\nNote that this prefix applies to all HistoryHash instances. It's not\npossible for individual instances to use their own prefixes since they\nall operate on the same URL.\n
",
"itemtype": "property",
"name": "hashPrefix",
"type": "String",
"default": "''",
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 138,
"description": "Regular expression used to parse location hash/query strings.",
"itemtype": "property",
"name": "_REGEX_HASH",
"type": "RegExp",
"access": "protected",
"tagname": "",
"static": 1,
"final": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 151,
"description": "Creates a location hash string from the specified object of key/value\npairs.",
"itemtype": "method",
"name": "createHash",
"params": [
{
"name": "params",
"description": "object of key/value parameter pairs",
"type": "Object"
}
],
"return": {
"description": "location hash string",
"type": "String"
},
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 173,
"description": "Wrapper around decodeURIComponent() that also converts +\nchars into spaces.",
"itemtype": "method",
"name": "decode",
"params": [
{
"name": "string",
"description": "string to decode",
"type": "String"
}
],
"return": {
"description": "decoded string",
"type": "String"
},
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 186,
"description": "Wrapper around encodeURIComponent() that converts spaces to\n+ chars.",
"itemtype": "method",
"name": "encode",
"params": [
{
"name": "string",
"description": "string to encode",
"type": "String"
}
],
"return": {
"description": "encoded string",
"type": "String"
},
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 199,
"description": "Gets the raw (not decoded) current location hash, minus the preceding '#'\ncharacter and the hashPrefix (if one is set).",
"itemtype": "method",
"name": "getHash",
"return": {
"description": "current location hash",
"type": "String"
},
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 231,
"description": "Gets the current bookmarkable URL.",
"itemtype": "method",
"name": "getUrl",
"return": {
"description": "current bookmarkable URL",
"type": "String"
},
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 242,
"description": "Parses a location hash string into an object of key/value parameter\npairs. If hash is not specified, the current location hash will\nbe used.",
"itemtype": "method",
"name": "parseHash",
"params": [
{
"name": "hash",
"description": "(optional) location hash string",
"type": "String"
}
],
"return": {
"description": "object of parsed key/value parameter pairs",
"type": "Object"
},
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 282,
"description": "Replaces the browser's current location hash with the specified hash\nand removes all forward navigation states, without creating a new browser\nhistory entry. Automatically prepends the hashPrefix if one\nis set.",
"itemtype": "method",
"name": "replaceHash",
"params": [
{
"name": "hash",
"description": "new location hash",
"type": "String"
}
],
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 302,
"description": "Sets the browser's location hash to the specified string. Automatically\nprepends the hashPrefix if one is set.",
"itemtype": "method",
"name": "setHash",
"params": [
{
"name": "hash",
"description": "new location hash",
"type": "String"
}
],
"static": 1,
"class": "HistoryHash",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-hash.js",
"line": 326,
"description": "Synthetic window.onhashchange event that normalizes differences\nacross browsers and provides support for browsers that don't natively support\nonhashchange.\n\nThis event is provided by the history-hash module.",
"example": [
"\n\n YUI().use('history-hash', function (Y) {\n Y.on('hashchange', function (e) {\n // Handle hashchange events on the current window.\n }, Y.config.win);\n });"
],
"itemtype": "event",
"name": "hashchange",
"params": [
{
"name": "e",
"description": "Event facade with the following additional\n properties:\n\n\n - oldHash
\n - \n Previous hash fragment value before the change.\n
\n\n - oldUrl
\n - \n Previous URL (including the hash fragment) before the change.\n
\n\n - newHash
\n - \n New hash fragment value after the change.\n
\n\n - newUrl
\n - \n New URL (including the hash fragment) after the change.\n
\n
",
"type": "EventFacade"
}
],
"since": "3.2.0",
"class": "YUI",
"module": "history",
"submodule": "history-hash"
},
{
"file": "lib/yui3/src/history/js/history-html5.js",
"line": 87,
"description": "Overrides HistoryBase's _storeState() and pushes or replaces\na history entry using the HTML5 history API when necessary.",
"itemtype": "method",
"name": "_storeState",
"params": [
{
"name": "src",
"description": "Source of the changes.",
"type": "String"
},
{
"name": "newState",
"description": "New state to store.",
"type": "Object"
},
{
"name": "options",
"description": "Zero or more options.",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryHTML5",
"module": "history",
"submodule": "history-html5"
},
{
"file": "lib/yui3/src/history/js/history-html5.js",
"line": 111,
"description": "Handler for popstate events.",
"itemtype": "method",
"name": "_onPopState",
"params": [
{
"name": "e",
"description": "",
"type": "Event"
}
],
"access": "protected",
"tagname": "",
"class": "HistoryHTML5",
"module": "history",
"submodule": "history-html5"
},
{
"file": "lib/yui3/src/history/js/history-html5.js",
"line": 125,
"description": "Constant used to identify state changes originating from\npopstate events.",
"itemtype": "property",
"name": "SRC_POPSTATE",
"type": "String",
"static": 1,
"final": 1,
"class": "HistoryHTML5",
"module": "history",
"submodule": "history-html5"
},
{
"file": "lib/yui3/src/history/js/history-html5.js",
"line": 143,
"description": "\nIf true, the Y.History alias will always point to\nY.HistoryHTML5 when the history-html5 module is loaded, even if\nthe current browser doesn't support HTML5 history.\n
\n\n\nIf false, the Y.History alias will always point to\nY.HistoryHash when the history-hash module is loaded, even if\nthe current browser supports HTML5 history.\n
\n\n\nIf neither true nor false, the\nY.History alias will point to the best available history adapter\nthat the browser supports. This is the default behavior.\n
",
"itemtype": "property",
"name": "useHistoryHTML5",
"type": "boolean",
"since": "3.2.0",
"class": "config",
"module": "history",
"submodule": "history-html5"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 25,
"description": "Name for the group. Only used to identify the group in logging statements.",
"itemtype": "attribute",
"name": "name",
"type": "String",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 34,
"description": "Time limit, in seconds, after which images are fetched regardless of trigger events.",
"itemtype": "attribute",
"name": "timeLimit",
"type": "Number",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 43,
"description": "Distance below the fold for which images are loaded. Images are not loaded until they are at most this distance away from (or above) the fold.\nThis check is performed at page load (domready) and after any window scroll or window resize event (until all images are loaded).",
"itemtype": "attribute",
"name": "foldDistance",
"type": "Number",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 55,
"description": "Class name that will identify images belonging to the group. This class name will be removed from each element in order to fetch images.\nThis class should have, in its CSS style definition, \"background:none !important;\".",
"itemtype": "attribute",
"name": "className",
"type": "String",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 67,
"description": "Determines how to act when className is used as the way to delay load images. The \"default\" action is to just\nremove the class name. The \"enhanced\" action is to remove the class name and also set the src attribute if\nthe element is an img.",
"itemtype": "attribute",
"name": "classNameAction",
"type": "String",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 82,
"description": "Initialize all private members needed for the group.",
"itemtype": "method",
"name": "_init",
"access": "private",
"tagname": "",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 89,
"description": "Collection of triggers for this group.\nKeeps track of each trigger's event handle, as returned from Y.on.",
"itemtype": "property",
"name": "_triggers",
"access": "private",
"tagname": "",
"type": "Array",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 98,
"description": "Collection of images (Y.ImgLoadImgObj objects) registered with this group, keyed by DOM id.",
"itemtype": "property",
"name": "_imgObjs",
"access": "private",
"tagname": "",
"type": "Object",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 106,
"description": "Timeout object to keep a handle on the time limit.",
"itemtype": "property",
"name": "_timeout",
"access": "private",
"tagname": "",
"type": "Object",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 114,
"description": "DOM elements having the class name that is associated with this group.\nElements are stored during the _foldCheck function and reused later during any subsequent _foldCheck calls - gives a slight performance improvement when the page fold is repeatedly checked.",
"itemtype": "property",
"name": "_classImageEls",
"access": "private",
"tagname": "",
"type": "Array",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 123,
"description": "Keep the CSS class name in a member variable for ease and speed.",
"itemtype": "property",
"name": "_className",
"access": "private",
"tagname": "",
"type": "String",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 131,
"description": "Boolean tracking whether the window scroll and window resize triggers have been set if this is a fold group.",
"itemtype": "property",
"name": "_areFoldTriggersSet",
"access": "private",
"tagname": "",
"type": "Boolean",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 139,
"description": "The maximum pixel height of the document that has been made visible.\nDuring fold checks, if the user scrolls up then there's no need to check for newly exposed images.",
"itemtype": "property",
"name": "_maxKnownHLimit",
"access": "private",
"tagname": "",
"type": "Int",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 152,
"description": "Adds a trigger to the group. Arguments are passed to Y.on.",
"itemtype": "method",
"name": "addTrigger",
"chainable": 1,
"params": [
{
"name": "obj",
"description": "The DOM object to attach the trigger event to",
"type": "Object"
},
{
"name": "type",
"description": "The event type",
"type": "String"
}
],
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 179,
"description": "Adds a custom event trigger to the group.",
"itemtype": "method",
"name": "addCustomTrigger",
"chainable": 1,
"params": [
{
"name": "name",
"description": "The name of the event",
"type": "String"
},
{
"name": "obj",
"description": "The object on which to attach the event. obj is optional - by default the event is attached to the Y instance",
"type": "Object"
}
],
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 207,
"description": "Sets the window scroll and window resize triggers for any group that is fold-conditional (i.e., has a fold distance set).",
"itemtype": "method",
"name": "_setFoldTriggers",
"access": "private",
"tagname": "",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 227,
"description": "Performs necessary setup at domready time.\nInitiates time limit for group; executes the fold check for the images.",
"itemtype": "method",
"name": "_onloadTasks",
"access": "private",
"tagname": "",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 245,
"description": "Returns the group's fetch method, with the proper closure, for use with setTimeout.",
"itemtype": "method",
"name": "_getFetchTimeout",
"return": {
"description": "group's fetch method",
"type": "Function"
},
"access": "private",
"tagname": "",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 256,
"description": "Registers an image with the group.\nArguments are passed through to a Y.ImgLoadImgObj constructor; see that class' attribute documentation for detailed information. \"domId\" is a required attribute.",
"itemtype": "method",
"name": "registerImage",
"params": [
{
"name": "",
"description": "A configuration object literal with attribute name/value pairs (passed through to a Y.ImgLoadImgObj constructor)",
"type": "Object",
"multiple": true
}
],
"return": {
"description": "Y.ImgLoadImgObj that was registered",
"type": "Object"
},
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 275,
"description": "Displays the images in the group.\nThis method is called when a trigger fires or the time limit expires; it shouldn't be called externally, but is not private in the rare event that it needs to be called immediately.",
"itemtype": "method",
"name": "fetch",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 297,
"description": "Clears the timeout and all triggers associated with the group.",
"itemtype": "method",
"name": "_clearTriggers",
"access": "private",
"tagname": "",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 310,
"description": "Checks the position of each image in the group. If any part of the image is within the specified distance (foldDistance) of the client viewport, the image is fetched immediately.",
"itemtype": "method",
"name": "_foldCheck",
"access": "private",
"tagname": "",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 368,
"description": "Updates a given node, removing the ImageLoader class name. If the\nnode is an img and the classNameAction is \"enhanced\", then node\nclass name is removed and also the src attribute is set to the \nimage URL as well as clearing the style background image.",
"itemtype": "method",
"name": "_updateNodeClassName",
"params": [
{
"name": "node",
"description": "The node to act on.",
"type": "Node"
}
],
"access": "private",
"tagname": "",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 394,
"description": "Finds all elements in the DOM with the class name specified in the group. Removes the class from the element in order to let the style definitions trigger the image fetching.",
"itemtype": "method",
"name": "_fetchByClass",
"access": "private",
"tagname": "",
"class": "ImgLoadGroup",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 432,
"description": "HTML DOM id of the image element.",
"itemtype": "attribute",
"name": "domId",
"type": "String",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 442,
"description": "Background URL for the image.\nFor an image whose URL is specified by \"background-image\" in the element's style.",
"itemtype": "attribute",
"name": "bgUrl",
"type": "String",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 452,
"description": "Source URL for the image.\nFor an image whose URL is specified by a \"src\" attribute in the DOM element.",
"itemtype": "attribute",
"name": "srcUrl",
"type": "String",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 462,
"description": "Pixel width of the image. Will be set as a width attribute on the DOM element after the image is fetched.\nDefaults to the natural width of the image (no width attribute will be set).\nUsually only used with src images.",
"itemtype": "attribute",
"name": "width",
"type": "Int",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 473,
"description": "Pixel height of the image. Will be set as a height attribute on the DOM element after the image is fetched.\nDefaults to the natural height of the image (no height attribute will be set).\nUsually only used with src images.",
"itemtype": "attribute",
"name": "height",
"type": "Int",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 484,
"description": "Whether the image's style.visibility should be set to visible after the image is fetched.\nUsed when setting images as visibility:hidden prior to image fetching.",
"itemtype": "attribute",
"name": "setVisible",
"type": "Boolean",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 494,
"description": "Whether the image is a PNG.\nPNG images get special treatment in that the URL is specified through AlphaImageLoader for IE, versions 6 and earlier.\nOnly used with background images.",
"itemtype": "attribute",
"name": "isPng",
"type": "Boolean",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 505,
"description": "AlphaImageLoader sizingMethod property to be set for the image.\nOnly set if isPng value for this image is set to true.\nDefaults to scale.",
"itemtype": "attribute",
"name": "sizingMethod",
"type": "String",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 516,
"description": "AlphaImageLoader enabled property to be set for the image.\nOnly set if isPng value for this image is set to true.\nDefaults to true.",
"itemtype": "attribute",
"name": "enabled",
"type": "String",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 531,
"description": "Initialize all private members needed for the group.",
"itemtype": "method",
"name": "_init",
"access": "private",
"tagname": "",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 538,
"description": "Whether this image has already been fetched.\nIn the case of fold-conditional groups, images won't be fetched twice.",
"itemtype": "property",
"name": "_fetched",
"access": "private",
"tagname": "",
"type": "Boolean",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 547,
"description": "The Node object returned from Y.one, to avoid repeat calls to access the DOM.",
"itemtype": "property",
"name": "_imgEl",
"access": "private",
"tagname": "",
"type": "Object",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 555,
"description": "The vertical position returned from getY, to avoid repeat calls to access the DOM.\nThe Y position is checked only for images registered with fold-conditional groups. The position is checked first at page load (domready)\n and this caching enhancement assumes that the image's vertical position won't change after that first check.",
"itemtype": "property",
"name": "_yPos",
"access": "private",
"tagname": "",
"type": "Int",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 566,
"description": "Displays the image; puts the URL into the DOM.\nThis method shouldn't be called externally, but is not private in the rare event that it needs to be called immediately.",
"itemtype": "method",
"name": "fetch",
"params": [
{
"name": "withinY",
"description": "The pixel distance from the top of the page, for which if the image lies within, it will be fetched. Undefined indicates that no check should be made, and the image should always be fetched",
"type": "Int"
}
],
"return": {
"description": "Whether the image has been fetched (either during this execution or previously)",
"type": "Boolean"
},
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 628,
"description": "Gets the object (as a Y.Node) of the DOM element indicated by \"domId\".",
"itemtype": "method",
"name": "_getImgEl",
"return": {
"description": "DOM element of the image as a Y.Node object",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/imageloader/js/imageloader.js",
"line": 641,
"description": "Gets the Y position of the node in page coordinates.\nExpects that the page-coordinate position of the image won't change.",
"itemtype": "method",
"name": "_getYPos",
"return": {
"description": "The Y position of the image",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "ImgLoadImgObj",
"module": "imageloader"
},
{
"file": "lib/yui3/src/intl/js/Intl.js",
"line": 22,
"description": "Private method to retrieve the language hash for a given module.",
"itemtype": "method",
"name": "_mod",
"access": "private",
"tagname": "",
"params": [
{
"name": "module",
"description": "The name of the module",
"type": "String"
}
],
"return": {
"description": "The hash of localized resources for the module, keyed by BCP language tag",
"type": "Object"
},
"class": "Intl",
"module": "intl"
},
{
"file": "lib/yui3/src/intl/js/Intl.js",
"line": 38,
"description": "Sets the active language for the given module.\n\nReturns false on failure, which would happen if the language had not been registered through the add() method.",
"itemtype": "method",
"name": "setLang",
"params": [
{
"name": "module",
"description": "The module name.",
"type": "String"
},
{
"name": "lang",
"description": "The BCP 47 language tag.",
"type": "String"
}
],
"return": {
"description": "boolean true if successful, false if not."
},
"class": "Intl",
"module": "intl"
},
{
"file": "lib/yui3/src/intl/js/Intl.js",
"line": 62,
"description": "Get the currently active language for the given module.",
"itemtype": "method",
"name": "getLang",
"params": [
{
"name": "module",
"description": "The module name.",
"type": "String"
}
],
"return": {
"description": "The BCP 47 language tag.",
"type": "String"
},
"class": "Intl",
"module": "intl"
},
{
"file": "lib/yui3/src/intl/js/Intl.js",
"line": 75,
"description": "Register a hash of localized resources for the given module and language",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "module",
"description": "The module name.",
"type": "String"
},
{
"name": "lang",
"description": "The BCP 47 language tag.",
"type": "String"
},
{
"name": "strings",
"description": "The hash of localized values, keyed by the string name.",
"type": "Object"
}
],
"class": "Intl",
"module": "intl"
},
{
"file": "lib/yui3/src/intl/js/Intl.js",
"line": 90,
"description": "Gets the module's localized resources for the currently active language (as provided by the getLang method).\n\nOptionally, the localized resources for alternate languages which have been added to Intl (see the add method) can\nbe retrieved by providing the BCP 47 language tag as the lang parameter.\n
",
"itemtype": "method",
"name": "get",
"params": [
{
"name": "module",
"description": "The module name.",
"type": "String"
},
{
"name": "key",
"description": "Optional. A single resource key. If not provided, returns a copy (shallow clone) of all resources.",
"type": "String"
},
{
"name": "lang",
"description": "Optional. The BCP 47 language tag. If not provided, the module's currently active language is used.",
"type": "String"
}
],
"return": {
"description": "String | Object A copy of the module's localized resources, or a single value if key is provided."
},
"class": "Intl",
"module": "intl"
},
{
"file": "lib/yui3/src/intl/js/Intl.js",
"line": 113,
"description": "Gets the list of languages for which localized resources are available for a given module, based on the module\nmeta-data (part of loader). If loader is not on the page, returns an empty array.",
"itemtype": "method",
"name": "getAvailableLangs",
"params": [
{
"name": "module",
"description": "The name of the module",
"type": "String"
}
],
"return": {
"description": "The array of languages available.",
"type": "Array"
},
"class": "Intl",
"module": "intl"
},
{
"file": "lib/yui3/src/intl/js/Intl.js",
"line": 132,
"description": "Notification event to indicate when the lang for a module has changed. There is no default behavior associated with this event,\nso the on and after moments are equivalent.",
"itemtype": "event",
"name": "intl:langChange",
"params": [
{
"name": "e",
"description": "The event facade\nThe event facade contains:
\n\n - module
- The name of the module for which the language changed
\n - newVal
- The new language tag
\n - prevVal
- The current language tag
\n
",
"type": "EventFacade"
}
],
"class": "Intl",
"module": "intl"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 47,
"description": "A counter that increments for each transaction.",
"itemtype": "property",
"name": "_id",
"access": "private",
"tagname": "",
"type": "{Number}",
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 56,
"description": "Object of IO HTTP headers sent with each transaction.",
"itemtype": "property",
"name": "_headers",
"access": "private",
"tagname": "",
"type": "{Object}",
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 67,
"description": "Object that stores timeout values for any transaction with a defined\n\"timeout\" configuration property.",
"itemtype": "property",
"name": "_timeout",
"access": "private",
"tagname": "",
"type": "{Object}",
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 98,
"description": "Method that creates a unique transaction object for each request.",
"itemtype": "method",
"name": "_create",
"access": "private",
"tagname": "",
"params": [
{
"name": "config",
"description": "Configuration object subset to determine if\n the transaction is an XDR or file upload,\n requiring an alternate transport.",
"type": "Object"
},
{
"name": "id",
"description": "Transaction id",
"type": "Number"
}
],
"return": {
"description": "The transaction object",
"type": "Object"
},
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 156,
"description": "Method for creating and firing events.",
"itemtype": "method",
"name": "_evt",
"access": "private",
"tagname": "",
"params": [
{
"name": "eventName",
"description": "Event to be published.",
"type": "String"
},
{
"name": "transaction",
"description": "Transaction object.",
"type": "Object"
},
{
"name": "config",
"description": "Configuration data subset for event subscription.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 211,
"description": "Fires event \"io:start\" and creates, fires a transaction-specific\nstart event, if `config.on.start` is defined.",
"itemtype": "method",
"name": "start",
"params": [
{
"name": "transaction",
"description": "Transaction object.",
"type": "Object"
},
{
"name": "config",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 220,
"description": "Signals the start of an IO request.",
"itemtype": "event",
"name": "io:start",
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 227,
"description": "Fires event \"io:complete\" and creates, fires a\ntransaction-specific \"complete\" event, if config.on.complete is\ndefined.",
"itemtype": "method",
"name": "complete",
"params": [
{
"name": "transaction",
"description": "Transaction object.",
"type": "Object"
},
{
"name": "config",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 237,
"description": "Signals the completion of the request-response phase of a\ntransaction. Response status and data are accessible, if\navailable, in this event.",
"itemtype": "event",
"name": "io:complete",
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 246,
"description": "Fires event \"io:end\" and creates, fires a transaction-specific \"end\"\nevent, if config.on.end is defined.",
"itemtype": "method",
"name": "end",
"params": [
{
"name": "transaction",
"description": "Transaction object.",
"type": "Object"
},
{
"name": "config",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 255,
"description": "Signals the end of the transaction lifecycle.",
"itemtype": "event",
"name": "io:end",
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 263,
"description": "Fires event \"io:success\" and creates, fires a transaction-specific\n\"success\" event, if config.on.success is defined.",
"itemtype": "method",
"name": "success",
"params": [
{
"name": "transaction",
"description": "Transaction object.",
"type": "Object"
},
{
"name": "config",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 272,
"description": "Signals an HTTP response with status in the 2xx range.\nFires after io:complete.",
"itemtype": "event",
"name": "io:success",
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 281,
"description": "Fires event \"io:failure\" and creates, fires a transaction-specific\n\"failure\" event, if config.on.failure is defined.",
"itemtype": "method",
"name": "failure",
"params": [
{
"name": "transaction",
"description": "Transaction object.",
"type": "Object"
},
{
"name": "config",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 290,
"description": "Signals an HTTP response with status outside of the 2xx range.\nFires after io:complete.",
"itemtype": "event",
"name": "io:failure",
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 299,
"description": "Retry an XDR transaction, using the Flash tranport, if the native\ntransport fails.",
"itemtype": "method",
"name": "_retry",
"access": "private",
"tagname": "",
"params": [
{
"name": "transaction",
"description": "Transaction object.",
"type": "Object"
},
{
"name": "uri",
"description": "Qualified path to transaction resource.",
"type": "String"
},
{
"name": "config",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 315,
"description": "Method that concatenates string data for HTTP GET transactions.",
"itemtype": "method",
"name": "_concat",
"access": "private",
"tagname": "",
"params": [
{
"name": "uri",
"description": "URI or root data.",
"type": "String"
},
{
"name": "data",
"description": "Data to be concatenated onto URI.",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 329,
"description": "Stores default client headers for all transactions. If a label is\npassed with no value argument, the header will be deleted.",
"itemtype": "method",
"name": "setHeader",
"params": [
{
"name": "name",
"description": "HTTP header",
"type": "String"
},
{
"name": "value",
"description": "HTTP header value",
"type": "String"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 345,
"description": "Method that sets all HTTP headers to be sent in a transaction.",
"itemtype": "method",
"name": "_setHeaders",
"access": "private",
"tagname": "",
"params": [
{
"name": "transaction",
"description": "- XHR instance for the specific transaction.",
"type": "Object"
},
{
"name": "headers",
"description": "- HTTP headers for the specific transaction, as\n defined in the configuration object passed to YUI.io().",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 363,
"description": "Starts timeout count if the configuration object has a defined\ntimeout property.",
"itemtype": "method",
"name": "_startTimeout",
"access": "private",
"tagname": "",
"params": [
{
"name": "transaction",
"description": "Transaction object generated by _create().",
"type": "Object"
},
{
"name": "timeout",
"description": "Timeout in milliseconds.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 380,
"description": "Clears the timeout interval started by _startTimeout().",
"itemtype": "method",
"name": "_clearTimeout",
"access": "private",
"tagname": "",
"params": [
{
"name": "id",
"description": "- Transaction id.",
"type": "Number"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 392,
"description": "Method that determines if a transaction response qualifies as success\nor failure, based on the response HTTP status code, and fires the\nappropriate success or failure events.",
"itemtype": "method",
"name": "_result",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "transaction",
"description": "Transaction object generated by _create().",
"type": "Object"
},
{
"name": "config",
"description": "Configuration object passed to io().",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 421,
"description": "Event handler bound to onreadystatechange.",
"itemtype": "method",
"name": "_rS",
"access": "private",
"tagname": "",
"params": [
{
"name": "transaction",
"description": "Transaction object generated by _create().",
"type": "Object"
},
{
"name": "config",
"description": "Configuration object passed to YUI.io().",
"type": "Object"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 445,
"description": "Terminates a transaction due to an explicit abort or timeout.",
"itemtype": "method",
"name": "_abort",
"access": "private",
"tagname": "",
"params": [
{
"name": "transaction",
"description": "Transaction object generated by _create().",
"type": "Object"
},
{
"name": "type",
"description": "Identifies timed out or aborted transaction.",
"type": "String"
}
],
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 460,
"description": "Requests a transaction. `send()` is implemented as `Y.io()`. Each\ntransaction may include a configuration object. Its properties are:\n\n\n - method
\n - HTTP method verb (e.g., GET or POST). If this property is not\n not defined, the default value will be GET.
\n\n - data
\n - This is the name-value string that will be sent as the\n transaction data. If the request is HTTP GET, the data become\n part of querystring. If HTTP POST, the data are sent in the\n message body.
\n\n - xdr
\n - Defines the transport to be used for cross-domain requests.\n By setting this property, the transaction will use the specified\n transport instead of XMLHttpRequest. The properties of the\n transport object are:\n
\n - use
\n - The transport to be used: 'flash' or 'native'
\n - dataType
\n - Set the value to 'XML' if that is the expected response\n content type.
\n
\n\n - form
\n - Form serialization configuration object. Its properties are:\n
\n - id
\n - Node object or id of HTML form
\n - useDisabled
\n - `true` to also serialize disabled form field values\n (defaults to `false`)
\n
\n\n - on
\n - Assigns transaction event subscriptions. Available events are:\n
\n - start
\n - Fires when a request is sent to a resource.
\n - complete
\n - Fires when the transaction is complete.
\n - success
\n - Fires when the HTTP response status is within the 2xx\n range.
\n - failure
\n - Fires when the HTTP response status is outside the 2xx\n range, if an exception occurs, if the transation is aborted,\n or if the transaction exceeds a configured `timeout`.
\n - end
\n - Fires at the conclusion of the transaction\n lifecycle, after `success` or `failure`.
\n
\n\n Callback functions for `start` and `end` receive the id of the\n transaction as a first argument. For `complete`, `success`, and\n `failure`, callbacks receive the id and the response object\n (usually the XMLHttpRequest instance). If the `arguments`\n property was included in the configuration object passed to\n `Y.io()`, the configured data will be passed to all callbacks as\n the last argument.
\n \n\n - sync
\n - Pass `true` to make a same-domain transaction synchronous.\n CAVEAT: This will negatively impact the user\n experience. Have a very good reason if you intend to use\n this.
\n\n - context
\n - The \"`this'\" object for all configured event handlers. If a\n specific context is needed for individual callbacks, bind the\n callback to a context using `Y.bind()`.
\n\n - headers
\n - Object map of transaction headers to send to the server. The\n object keys are the header names and the values are the header\n values.
\n\n - timeout
\n - Millisecond threshold for the transaction before being\n automatically aborted.
\n\n - arguments
\n - User-defined data passed to all registered event handlers.\n This value is available as the second argument in the \"start\" and\n \"end\" event handlers. It is the third argument in the \"complete\",\n \"success\", and \"failure\" event handlers. Be sure to quote\n this property name in the transaction configuration as\n \"arguments\" is a reserved word in JavaScript (e.g.\n `Y.io({ ..., \"arguments\": stuff })`).
\n
",
"itemtype": "method",
"name": "send",
"access": "public",
"tagname": "",
"params": [
{
"name": "uri",
"description": "Qualified path to transaction resource.",
"type": "String"
},
{
"name": "config",
"description": "Configuration object for the transaction.",
"type": "Object"
},
{
"name": "id",
"description": "Transaction id, if already set.",
"type": "Number"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "IO",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 699,
"description": "Method for initiating an ajax call. The first argument is the url end\npoint for the call. The second argument is an object to configure the\ntransaction and attach event subscriptions. The configuration object\nsupports the following properties:\n\n\n - method
\n - HTTP method verb (e.g., GET or POST). If this property is not\n not defined, the default value will be GET.
\n\n - data
\n - This is the name-value string that will be sent as the\n transaction data. If the request is HTTP GET, the data become\n part of querystring. If HTTP POST, the data are sent in the\n message body.
\n\n - xdr
\n - Defines the transport to be used for cross-domain requests.\n By setting this property, the transaction will use the specified\n transport instead of XMLHttpRequest. The properties of the\n transport object are:\n
\n - use
\n - The transport to be used: 'flash' or 'native'
\n - dataType
\n - Set the value to 'XML' if that is the expected response\n content type.
\n
\n\n - form
\n - Form serialization configuration object. Its properties are:\n
\n - id
\n - Node object or id of HTML form
\n - useDisabled
\n - `true` to also serialize disabled form field values\n (defaults to `false`)
\n
\n\n - on
\n - Assigns transaction event subscriptions. Available events are:\n
\n - start
\n - Fires when a request is sent to a resource.
\n - complete
\n - Fires when the transaction is complete.
\n - success
\n - Fires when the HTTP response status is within the 2xx\n range.
\n - failure
\n - Fires when the HTTP response status is outside the 2xx\n range, if an exception occurs, if the transation is aborted,\n or if the transaction exceeds a configured `timeout`.
\n - end
\n - Fires at the conclusion of the transaction\n lifecycle, after `success` or `failure`.
\n
\n\n Callback functions for `start` and `end` receive the id of the\n transaction as a first argument. For `complete`, `success`, and\n `failure`, callbacks receive the id and the response object\n (usually the XMLHttpRequest instance). If the `arguments`\n property was included in the configuration object passed to\n `Y.io()`, the configured data will be passed to all callbacks as\n the last argument.
\n \n\n - sync
\n - Pass `true` to make a same-domain transaction synchronous.\n CAVEAT: This will negatively impact the user\n experience. Have a very good reason if you intend to use\n this.
\n\n - context
\n - The \"`this'\" object for all configured event handlers. If a\n specific context is needed for individual callbacks, bind the\n callback to a context using `Y.bind()`.
\n\n - headers
\n - Object map of transaction headers to send to the server. The\n object keys are the header names and the values are the header\n values.
\n\n - timeout
\n - Millisecond threshold for the transaction before being\n automatically aborted.
\n\n - arguments
\n - User-defined data passed to all registered event handlers.\n This value is available as the second argument in the \"start\" and\n \"end\" event handlers. It is the third argument in the \"complete\",\n \"success\", and \"failure\" event handlers. Be sure to quote\n this property name in the transaction configuration as\n \"arguments\" is a reserved word in JavaScript (e.g.\n `Y.io({ ..., \"arguments\": stuff })`).
\n
",
"itemtype": "method",
"name": "io",
"static": 1,
"params": [
{
"name": "url",
"description": "qualified path to transaction resource.",
"type": "String"
},
{
"name": "config",
"description": "configuration object for the transaction.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "YUI",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-base.js",
"line": 811,
"description": "Method for setting and deleting IO HTTP headers to be sent with every\nrequest.\n\nHosted as a property on the `io` function (e.g. `Y.io.header`).",
"itemtype": "method",
"name": "header",
"params": [
{
"name": "name",
"description": "HTTP header",
"type": "String"
},
{
"name": "value",
"description": "HTTP header value",
"type": "String"
}
],
"static": 1,
"class": "YUI",
"module": "io-base"
},
{
"file": "lib/yui3/src/io/js/io-form.js",
"line": 12,
"description": "Method to enumerate through an HTML form's elements collection\nand return a string comprised of key-value pairs.",
"itemtype": "method",
"name": "_serialize",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "c",
"description": "- YUI form node or HTML form id.",
"type": "Object"
},
{
"name": "s",
"description": "- Key-value data defined in the configuration object.",
"type": "String"
}
],
"return": {
"description": "",
"type": "String"
},
"class": "IO",
"module": "io-base",
"submodule": "io-form"
},
{
"file": "lib/yui3/src/io/js/io-queue.js",
"line": 11,
"description": "Array of transactions queued for processing",
"itemtype": "property",
"name": "_q",
"access": "private",
"tagname": "",
"static": 1,
"type": "{Object}",
"class": "IO",
"module": "io-base",
"submodule": "io-queue"
},
{
"file": "lib/yui3/src/io/js/io-queue.js",
"line": 22,
"description": "Property to determine whether the queue is set to\n1 (active) or 0 (inactive). When inactive, transactions\nwill be stored in the queue until the queue is set to active.",
"itemtype": "property",
"name": "_qState",
"access": "private",
"tagname": "",
"static": 1,
"type": "{Number}",
"class": "IO",
"module": "io-base",
"submodule": "io-queue"
},
{
"file": "lib/yui3/src/io/js/io-queue.js",
"line": 34,
"description": "Method Process the first transaction from the\nqueue in FIFO order.",
"itemtype": "method",
"name": "_qShift",
"access": "private",
"tagname": "",
"static": 1,
"class": "IO",
"module": "io-base",
"submodule": "io-queue"
},
{
"file": "lib/yui3/src/io/js/io-queue.js",
"line": 51,
"description": "Method for queueing a transaction before the request is sent to the\nresource, to ensure sequential processing.",
"itemtype": "method",
"name": "queue",
"static": 1,
"return": {
"description": "",
"type": "Object"
},
"class": "IO",
"module": "io-base",
"submodule": "io-queue"
},
{
"file": "lib/yui3/src/io/js/io-queue.js",
"line": 85,
"description": "Method for promoting a transaction to the top of the queue.",
"itemtype": "method",
"name": "promote",
"static": 1,
"class": "IO",
"module": "io-base",
"submodule": "io-queue"
},
{
"file": "lib/yui3/src/io/js/io-queue.js",
"line": 95,
"description": "Method for removing a specific, pending transaction from\nthe queue.",
"itemtype": "method",
"name": "remove",
"access": "private",
"tagname": "",
"static": 1,
"class": "IO",
"module": "io-base",
"submodule": "io-queue"
},
{
"file": "lib/yui3/src/io/js/io-queue.js",
"line": 117,
"description": "Method for setting queue processing to inactive.\nTransaction requests to YUI.io.queue() will be stored in the queue, but\nnot processed until the queue is reset to \"active\".",
"itemtype": "method",
"name": "_stop",
"access": "private",
"tagname": "",
"static": 1,
"class": "IO",
"module": "io-base",
"submodule": "io-queue"
},
{
"file": "lib/yui3/src/io/js/io-queue.js",
"line": 131,
"description": "Method to query the current size of the queue.",
"itemtype": "method",
"name": "_size",
"access": "private",
"tagname": "",
"static": 1,
"return": {
"description": "",
"type": "Number"
},
"class": "IO",
"module": "io-base",
"submodule": "io-queue"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 14,
"description": "Creates the iframe transported used in file upload\ntransactions, and binds the response event handler.",
"itemtype": "method",
"name": "_cFrame",
"access": "private",
"tagname": "",
"params": [
{
"name": "o",
"description": "Transaction object generated by _create().",
"type": "Object"
},
{
"name": "c",
"description": "Configuration object passed to YUI.io().",
"type": "Object"
},
{
"name": "io",
"description": "",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 34,
"description": "Removes the iframe transport used in the file upload \ntransaction.",
"itemtype": "method",
"name": "_dFrame",
"access": "private",
"tagname": "",
"params": [
{
"name": "id",
"description": "The transaction ID used in the iframe's creation.",
"type": "Number"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 49,
"description": "Parses the POST data object and creates hidden form elements\nfor each key-value, and appends them to the HTML form object.",
"itemtype": "method",
"name": "appendData",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "f",
"description": "HTML form object.",
"type": "Object"
},
{
"name": "s",
"description": "The key-value POST data.",
"type": "String"
}
],
"return": {
"description": "e Array of created fields.",
"type": "Array"
},
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 82,
"description": "Removes the custom fields created to pass additional POST\ndata, along with the HTML form fields.",
"itemtype": "method",
"name": "_removeData",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "f",
"description": "HTML form object.",
"type": "Object"
},
{
"name": "o",
"description": "HTML form fields created from configuration.data.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 99,
"description": "Sets the appropriate attributes and values to the HTML\nform, in preparation of a file upload transaction.",
"itemtype": "method",
"name": "_setAttrs",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "f",
"description": "HTML form object.",
"type": "Object"
},
{
"name": "id",
"description": "The Transaction ID.",
"type": "Object"
},
{
"name": "uri",
"description": "Qualified path to transaction resource.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 116,
"description": "Reset the HTML form attributes to their original values.",
"itemtype": "method",
"name": "_resetAttrs",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "f",
"description": "HTML form object.",
"type": "Object"
},
{
"name": "a",
"description": "Object of original attributes.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 135,
"description": "Starts timeout count if the configuration object\nhas a defined timeout property.",
"itemtype": "method",
"name": "_startTimeout",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "o",
"description": "Transaction object generated by _create().",
"type": "Object"
},
{
"name": "c",
"description": "Configuration object passed to YUI.io().",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 158,
"description": "Clears the timeout interval started by _startTimeout().",
"itemtype": "method",
"name": "_clearTimeout",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "id",
"description": "- Transaction ID.",
"type": "Number"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 172,
"description": "Bound to the iframe's Load event and processes\nthe response data.",
"itemtype": "method",
"name": "_uploadComplete",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "o",
"description": "The transaction object",
"type": "Object"
},
{
"name": "c",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-upload-iframe.js",
"line": 216,
"description": "Uploads HTML form data, inclusive of files/attachments,\nusing the iframe created in _create to facilitate the transaction.",
"itemtype": "method",
"name": "_upload",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "o",
"description": "The transaction object",
"type": "Object"
},
{
"name": "uri",
"description": "Qualified path to transaction resource.",
"type": "Object"
},
{
"name": "c",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-upload-iframe"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 9,
"description": "Fires when the XDR transport is ready for use.",
"itemtype": "event",
"name": "io:xdrReady",
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 15,
"description": "Map of stored configuration objects when using \nFlash as the transport for cross-domain requests.",
"itemtype": "property",
"name": "_cB",
"access": "private",
"tagname": "",
"type": "{Object}",
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 25,
"description": "Map of transaction simulated readyState values\nwhen XDomainRequest is the transport.",
"itemtype": "property",
"name": "_rS",
"access": "private",
"tagname": "",
"type": "{Object}",
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 42,
"description": "Method that creates the Flash transport swf.",
"itemtype": "method",
"name": "_swf",
"access": "private",
"tagname": "",
"params": [
{
"name": "uri",
"description": "- location of io.swf.",
"type": "String"
},
{
"name": "yid",
"description": "- YUI sandbox id.",
"type": "String"
},
{
"name": "yid",
"description": "- IO instance id.",
"type": "String"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 64,
"description": "Creates a response object for XDR transactions, for success\nand failure cases.",
"itemtype": "method",
"name": "_data",
"access": "private",
"tagname": "",
"params": [
{
"name": "o",
"description": "- Transaction object generated by _create() in io-base.",
"type": "Object"
},
{
"name": "u",
"description": "- Configuration xdr.use.",
"type": "Boolean"
},
{
"name": "d",
"description": "- Configuration xdr.dataType.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 87,
"description": "Method for intiating an XDR transaction abort.",
"itemtype": "method",
"name": "_abort",
"access": "private",
"tagname": "",
"params": [
{
"name": "o",
"description": "- Transaction object generated by _create() in io-base.",
"type": "Object"
},
{
"name": "c",
"description": "- configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 99,
"description": "Method for determining if an XDR transaction has completed\nand all data are received.",
"itemtype": "method",
"name": "_isInProgress",
"access": "private",
"tagname": "",
"params": [
{
"name": "o",
"description": "- Transaction object generated by _create() in io-base.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 113,
"description": "Map of io transports.",
"itemtype": "property",
"name": "_transport",
"access": "private",
"tagname": "",
"type": "{Object}",
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 122,
"description": "Sets event handlers for XDomainRequest transactions.",
"itemtype": "method",
"name": "_ieEvt",
"access": "private",
"tagname": "",
"static": 1,
"params": [
{
"name": "o",
"description": "- Transaction object generated by _create() in io-base.",
"type": "Object"
},
{
"name": "c",
"description": "- configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 154,
"description": "Method for accessing the transport's interface for making a\ncross-domain transaction.",
"itemtype": "method",
"name": "xdr",
"params": [
{
"name": "uri",
"description": "- qualified path to transaction resource.",
"type": "String"
},
{
"name": "o",
"description": "- Transaction object generated by _create() in io-base.",
"type": "Object"
},
{
"name": "c",
"description": "- configuration object for the transaction.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 205,
"description": "Response controller for cross-domain requests when using the\nFlash transport or IE8's XDomainRequest object.",
"itemtype": "method",
"name": "xdrResponse",
"params": [
{
"name": "e",
"description": "Event name",
"type": "String"
},
{
"name": "o",
"description": "Transaction object generated by _create() in io-base.",
"type": "Object"
},
{
"name": "c",
"description": "Configuration object for the transaction.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Object"
},
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 245,
"description": "Fires event \"io:xdrReady\"",
"itemtype": "method",
"name": "_xdrReady",
"access": "private",
"tagname": "",
"params": [
{
"name": "yid",
"description": "- YUI sandbox id.",
"type": "Number"
},
{
"name": "uid",
"description": "- IO instance id.",
"type": "Number"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 257,
"description": "Initializes the desired transport.",
"itemtype": "method",
"name": "transport",
"params": [
{
"name": "o",
"description": "- object of transport configurations.",
"type": "Object"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 272,
"description": "Fires event \"io:xdrReady\"",
"itemtype": "method",
"name": "xdrReady",
"access": "protected",
"tagname": "",
"static": 1,
"params": [
{
"name": "yid",
"description": "- YUI sandbox id.",
"type": "Number"
},
{
"name": "uid",
"description": "- IO instance id.",
"type": "Number"
}
],
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/io/js/io-xdr.js",
"line": 298,
"description": "Delay value to calling the Flash transport, in the\nevent io.swf has not finished loading. Once the E_XDR_READY\nevent is fired, this value will be set to 0.",
"itemtype": "property",
"name": "delay",
"static": 1,
"type": "{Number}",
"class": "IO",
"module": "io-base",
"submodule": "io-xdr"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 44,
"description": "Alias to native browser implementation of the JSON object if available.",
"itemtype": "property",
"name": "Native",
"type": "{Object}",
"access": "private",
"tagname": "",
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 56,
"description": "Replace certain Unicode characters that JavaScript may handle incorrectly\nduring eval--either by deleting them or treating them as line\nendings--with escape sequences.\nIMPORTANT NOTE: This regex will be used to modify the input if a match is\nfound.",
"itemtype": "property",
"name": "_UNICODE_EXCEPTIONS",
"type": "{RegExp}",
"access": "private",
"tagname": "",
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 70,
"description": "First step in the safety evaluation. Regex used to replace all escape\nsequences (i.e. \"\\\\\", etc) with '@' characters (a non-JSON character).",
"itemtype": "property",
"name": "_ESCAPES",
"type": "{RegExp}",
"access": "private",
"tagname": "",
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 80,
"description": "Second step in the safety evaluation. Regex used to replace all simple\nvalues with ']' characters.",
"itemtype": "property",
"name": "_VALUES",
"type": "{RegExp}",
"access": "private",
"tagname": "",
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 90,
"description": "Third step in the safety evaluation. Regex used to remove all open\nsquare brackets following a colon, comma, or at the beginning of the\nstring.",
"itemtype": "property",
"name": "_BRACKETS",
"type": "{RegExp}",
"access": "private",
"tagname": "",
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 101,
"description": "Final step in the safety evaluation. Regex used to test the string left\nafter all previous replacements for invalid characters.",
"itemtype": "property",
"name": "_UNSAFE",
"type": "{RegExp}",
"access": "private",
"tagname": "",
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 111,
"description": "Replaces specific unicode characters with their appropriate \\unnnn\nformat. Some browsers ignore certain characters during eval.",
"itemtype": "method",
"name": "escapeException",
"params": [
{
"name": "c",
"description": "Unicode character",
"type": "String"
}
],
"return": {
"description": "the \\unnnn escapement of the character",
"type": "String"
},
"access": "private",
"tagname": "",
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 124,
"description": "Traverses nested objects, applying a reviver function to each (key,value)\nfrom the scope if the key:value's containing object. The value returned\nfrom the function will replace the original value in the key:value pair.\nIf the value returned is undefined, the key will be omitted from the\nreturned object.",
"itemtype": "method",
"name": "_revive",
"params": [
{
"name": "data",
"description": "Any JavaScript data",
"type": "MIXED"
},
{
"name": "reviver",
"description": "filter or mutation function",
"type": "Function"
}
],
"return": {
"description": "The results of the filtered data",
"type": "MIXED"
},
"access": "private",
"tagname": "",
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 158,
"description": "Parse a JSON string, returning the native JavaScript representation.",
"params": [
{
"name": "s",
"description": "JSON string data",
"type": "String"
},
{
"name": "reviver",
"description": "(optional) function(k,v) passed each key value\n pair of object literals, allowing pruning or altering values",
"type": "Function"
}
],
"return": {
"description": "the native JavaScript representation of the JSON string",
"type": "MIXED"
},
"throws": [
"SyntaxError"
],
"itemtype": "method",
"name": "parse",
"static": 1,
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/parse.js",
"line": 214,
"description": "Leverage native JSON parse if the browser has a native implementation.\nIn general, this is a good idea. See the Known Issues section in the\nJSON user guide for caveats. The default value is true for browsers with\nnative JSON support.",
"itemtype": "property",
"name": "useNativeParse",
"type": "Boolean",
"default": "true",
"static": 1,
"class": "JSON",
"module": "json",
"submodule": "json-parse"
},
{
"file": "lib/yui3/src/json/js/stringify.js",
"line": 248,
"description": "Leverage native JSON stringify if the browser has a native\nimplementation. In general, this is a good idea. See the Known Issues\nsection in the JSON user guide for caveats. The default value is true\nfor browsers with native JSON support.",
"itemtype": "property",
"name": "useNativeStringify",
"type": "Boolean",
"default": "true",
"static": 1,
"class": "JSON",
"module": "json",
"submodule": "json-stringify"
},
{
"file": "lib/yui3/src/json/js/stringify.js",
"line": 261,
"description": "Serializes a Date instance as a UTC date string. Used internally by\nstringify. Override this method if you need Dates serialized in a\ndifferent format.",
"itemtype": "method",
"name": "dateToString",
"params": [
{
"name": "d",
"description": "The Date to serialize",
"type": "Date"
}
],
"return": {
"description": "stringified Date in UTC format YYYY-MM-DDTHH:mm:SSZ",
"type": "String"
},
"deprecated": true,
"deprecationMessage": "Use a replacer function",
"static": 1,
"class": "JSON",
"module": "json",
"submodule": "json-stringify"
},
{
"file": "lib/yui3/src/json/js/stringify.js",
"line": 285,
"description": "Converts an arbitrary value to a JSON string representation.
\n\nObjects with cyclical references will trigger an exception.
\n\nIf a whitelist is provided, only matching object keys will be\nincluded. Alternately, a replacer function may be passed as the\nsecond parameter. This function is executed on every value in the\ninput, and its return value will be used in place of the original value.\nThis is useful to serialize specialized objects or class instances.
\n\nIf a positive integer or non-empty string is passed as the third\nparameter, the output will be formatted with carriage returns and\nindentation for readability. If a String is passed (such as \"\\t\") it\nwill be used once for each indentation level. If a number is passed,\nthat number of spaces will be used.
",
"itemtype": "method",
"name": "stringify",
"params": [
{
"name": "o",
"description": "any arbitrary value to convert to JSON string",
"type": "MIXED"
},
{
"name": "w",
"description": "(optional) whitelist of acceptable object\n keys to include, or a replacer function to modify the\n raw value before serialization",
"type": "Array|Function"
},
{
"name": "ind",
"description": "(optional) indentation character or depth of\n spaces to format the output.",
"type": "Number|String"
}
],
"return": {
"description": "JSON string representation of the input",
"type": "String"
},
"static": 1,
"class": "JSON",
"module": "json",
"submodule": "json-stringify"
},
{
"file": "lib/yui3/src/json/js/stringify.js",
"line": 317,
"description": "Number of occurrences of a special character within a single call to\nstringify that should trigger promotion of that character to a dedicated\npreprocess step for future calls. This is only used in environments\nthat don't support native JSON, or when useNativeStringify is set to\nfalse.
\n\nSo, if set to 50 and an object is passed to stringify that includes\nstrings containing the special character \\x07 more than 50 times,\nsubsequent calls to stringify will process object strings through a\nfaster serialization path for \\x07 before using the generic, slower,\nreplacement process for all special characters.
\n\nTo prime the preprocessor cache, set this value to 1, then call\nY.JSON.stringify(\"(all special characters to\ncache)\");, then return this setting to a more conservative\nvalue.
\n\nSpecial characters \\ \" \\b \\t \\n \\f \\r are already cached.
",
"itemtype": "property",
"name": "charCacheThreshold",
"static": 1,
"default": "100",
"type": "{Number}",
"class": "JSON",
"module": "json",
"submodule": "json-stringify"
},
{
"file": "lib/yui3/src/json/tests/src/json-parse.js",
"line": 60,
"class": "JSONPRequest",
"module": "json"
},
{
"file": "lib/yui3/src/json/tests/src/json-parse.js",
"line": 62,
"class": "JSONPRequest",
"module": "json"
},
{
"file": "lib/yui3/src/json/tests/json-parse-tests.js",
"line": 62,
"class": "JSONPRequest",
"module": "json"
},
{
"file": "lib/yui3/src/json/tests/json-parse-tests.js",
"line": 64,
"class": "JSONPRequest",
"module": "json"
},
{
"file": "lib/yui3/src/json/tests/json-tests.js",
"line": 62,
"class": "JSONPRequest",
"module": "json"
},
{
"file": "lib/yui3/src/json/tests/json-tests.js",
"line": 64,
"class": "JSONPRequest",
"module": "json"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp-url.js",
"line": 16,
"description": "RegExp used by the default URL formatter to insert the generated callback\nname into the JSONP url. Looks for a query param callback=. If a value\nis assigned, it will be clobbered.",
"itemtype": "property",
"name": "_pattern",
"type": "RegExp",
"default": "/\\bcallback=.*?(?=&|$)/i",
"access": "protected",
"tagname": "",
"class": "JSONPRequest",
"module": "jsonp",
"submodule": "jsonp-url"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp-url.js",
"line": 28,
"description": "Template used by the default URL formatter to add the callback function\nname to the url.",
"itemtype": "property",
"name": "_template",
"type": "String",
"default": "\"callback={callback}\"",
"access": "protected",
"tagname": "",
"class": "JSONPRequest",
"module": "jsonp",
"submodule": "jsonp-url"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp-url.js",
"line": 39,
"description": "Parses the url for a callback named explicitly in the string.\nOverride this if the target JSONP service uses a different query\nparameter or url format.
\n\nIf the callback is declared inline, the corresponding function will\nbe returned. Otherwise null.
",
"itemtype": "method",
"name": "_defaultCallback",
"params": [
{
"name": "url",
"description": "the url to search in",
"type": "String"
}
],
"return": {
"description": "the callback function if found, or null",
"type": "Function"
},
"access": "protected",
"tagname": "",
"class": "JSONPRequest",
"module": "jsonp",
"submodule": "jsonp-url"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp-url.js",
"line": 93,
"description": "URL formatter that looks for callback= in the url and appends it\nif not present. The supplied proxy name will be assigned to the query\nparam. Override this method by passing a function as the\n"format" property in the config object to the constructor.",
"itemtype": "method",
"name": "_format",
"params": [
{
"name": "url",
"description": "the original url",
"type": "String"
},
{
"name": "proxy",
"description": "the function name that will be used as a proxy to\n the configured callback methods.",
"type": "String"
}
],
"return": {
"description": "fully qualified JSONP url",
"type": "String"
},
"access": "protected",
"tagname": "",
"class": "JSONPRequest",
"module": "jsonp",
"submodule": "jsonp-url"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp.js",
"line": 45,
"description": "Set up the success and failure handlers and the regex pattern used\nto insert the temporary callback name in the url.",
"itemtype": "method",
"name": "_init",
"params": [
{
"name": "url",
"description": "the url of the JSONP service",
"type": "String"
},
{
"name": "callback",
"description": "Optional success callback or config\n object containing success and failure functions and\n the url regex.",
"type": "Object|Function"
}
],
"access": "protected",
"tagname": "",
"class": "JSONPRequest",
"module": "jsonp"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp.js",
"line": 59,
"description": "Map of the number of requests currently pending responses per\ngenerated proxy. Used to ensure the proxy is not flushed if the\nrequest times out and there is a timeout handler and success\nhandler, and used by connections configured to allowCache to make\nsure the proxy isn't deleted until the last response has returned.",
"itemtype": "property",
"name": "_requests",
"access": "private",
"tagname": "",
"type": "{Object}",
"class": "JSONPRequest",
"module": "jsonp"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp.js",
"line": 72,
"description": "Map of the number of timeouts received from the destination url\nby generated proxy. Used to ensure the proxy is not flushed if the\nrequest times out and there is a timeout handler and success\nhandler, and used by connections configured to allowCache to make\nsure the proxy isn't deleted until the last response has returned.",
"itemtype": "property",
"name": "_timeouts",
"access": "private",
"tagname": "",
"type": "{Object}",
"class": "JSONPRequest",
"module": "jsonp"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp.js",
"line": 105,
"description": "Override this method to provide logic to default the success callback if\nit is not provided at construction. This is overridden by jsonp-url to\nparse the callback from the url string.",
"itemtype": "method",
"name": "_defaultCallback",
"params": [
{
"name": "url",
"description": "the url passed at construction",
"type": "String"
},
{
"name": "config",
"description": "(optional) the config object passed at\n construction",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Function"
},
"class": "JSONPRequest",
"module": "jsonp"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp.js",
"line": 118,
"description": "Issues the JSONP request.",
"itemtype": "method",
"name": "send",
"params": [
{
"name": "args",
"description": "any additional arguments to pass to the url formatter\n beyond the base url and the proxy function name",
"type": "Any",
"multiple": true
}
],
"chainable": 1,
"class": "JSONPRequest",
"module": "jsonp"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp.js",
"line": 207,
"description": "Default url formatter. Looks for callback= in the url and appends it\nif not present. The supplied proxy name will be assigned to the query\nparam. Override this method by passing a function as the\n"format" property in the config object to the constructor.",
"itemtype": "method",
"name": "_format",
"params": [
{
"name": "url",
"description": "the original url",
"type": "String"
},
{
"name": "proxy",
"description": "the function name that will be used as a proxy to\n the configured callback methods.",
"type": "String"
},
{
"name": "args",
"description": "additional args passed to send()",
"type": "Any",
"multiple": true
}
],
"return": {
"description": "fully qualified JSONP url",
"type": "String"
},
"access": "protected",
"tagname": "",
"class": "JSONPRequest",
"module": "jsonp"
},
{
"file": "lib/yui3/src/jsonp/js/jsonp.js",
"line": 228,
"itemtype": "method",
"name": "jsonp",
"params": [
{
"name": "url",
"description": "the url of the JSONP service with the {callback}\n placeholder where the callback function name typically goes.",
"type": "String"
},
{
"name": "c",
"description": "Callback function accepting the JSON payload\n as its argument, or a configuration object (see above).",
"type": "Function|Object"
},
{
"name": "args",
"description": "additional arguments to pass to send()",
"type": "Any",
"multiple": true
}
],
"return": {
"description": "",
"type": "JSONPRequest"
},
"static": 1,
"class": "YUI",
"module": "jsonp"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 50,
"description": "The component metadata is stored in Y.Env.meta.\nPart of the loader module.",
"itemtype": "property",
"name": "meta",
"class": "YUI",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 169,
"description": "Internal callback to handle multiple internal insert() calls\nso that css is inserted prior to js",
"itemtype": "property",
"name": "_internalCallback",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 177,
"description": "Callback that will be executed when the loader is finished\nwith an insert",
"itemtype": "method",
"name": "onSuccess",
"type": "function",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 185,
"description": "Callback that will be executed if there is a failure",
"itemtype": "method",
"name": "onFailure",
"type": "function",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 192,
"description": "Callback for the 'CSSComplete' event. When loading YUI components\nwith CSS the CSS is loaded first, then the script. This provides\na moment you can tie into to improve the presentation of the page\nwhile the script is loading.",
"itemtype": "method",
"name": "onCSS",
"type": "function",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 202,
"description": "Callback executed each time a script or css file is loaded",
"itemtype": "method",
"name": "onProgress",
"type": "function",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 209,
"description": "Callback that will be executed if a timeout occurs",
"itemtype": "method",
"name": "onTimeout",
"type": "function",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 216,
"description": "The execution context for all callbacks",
"itemtype": "property",
"name": "context",
"default": "{YUI} the YUI instance",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 223,
"description": "Data that is passed to all callbacks",
"itemtype": "property",
"name": "data",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 229,
"description": "Node reference or id where new nodes should be inserted before",
"itemtype": "property",
"name": "insertBefore",
"type": "string|HTMLElement",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 236,
"description": "The charset attribute for inserted nodes",
"itemtype": "property",
"name": "charset",
"type": "string",
"deprecated": true,
"deprecationMessage": ", use cssAttributes or jsAttributes.",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 244,
"description": "An object literal containing attributes to add to link nodes",
"itemtype": "property",
"name": "cssAttributes",
"type": "object",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 251,
"description": "An object literal containing attributes to add to script nodes",
"itemtype": "property",
"name": "jsAttributes",
"type": "object",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 258,
"description": "The base directory.",
"itemtype": "property",
"name": "base",
"type": "string",
"default": "http://yui.yahooapis.com/[YUI VERSION]/build/",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 266,
"description": "Base path for the combo service",
"itemtype": "property",
"name": "comboBase",
"type": "string",
"default": "http://yui.yahooapis.com/combo?",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 280,
"description": "If configured, the loader will attempt to use the combo\nservice for YUI resources and configured external resources.",
"itemtype": "property",
"name": "combine",
"type": "boolean",
"default": "true if a base dir isn't in the config",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 290,
"description": "The default seperator to use between files in a combo URL",
"itemtype": "property",
"name": "comboSep",
"type": "{String}",
"default": "Ampersand",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 297,
"description": "Max url length for combo urls. The default is 2048. This is the URL\nlimit for the Yahoo! hosted combo servers. If consuming\na different combo service that has a different URL limit\nit is possible to override this default by supplying\nthe maxURLLength config option. The config option will\nonly take effect if lower than the default.",
"itemtype": "property",
"name": "maxURLLength",
"type": "int",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 310,
"description": "Ignore modules registered on the YUI global",
"itemtype": "property",
"name": "ignoreRegistered",
"default": "false",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 317,
"description": "Root path to prepend to module path for the combo\nservice",
"itemtype": "property",
"name": "root",
"type": "string",
"default": "[YUI VERSION]/build/",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 326,
"description": "Timeout value in milliseconds. If set, self value will be used by\nthe get utility. the timeout event will fire if\na timeout occurs.",
"itemtype": "property",
"name": "timeout",
"type": "int",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 335,
"description": "A list of modules that should not be loaded, even if\nthey turn up in the dependency tree",
"itemtype": "property",
"name": "ignore",
"type": "string[]",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 343,
"description": "A list of modules that should always be loaded, even\nif they have already been inserted into the page.",
"itemtype": "property",
"name": "force",
"type": "string[]",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 353,
"description": "Should we allow rollups",
"itemtype": "property",
"name": "allowRollup",
"type": "boolean",
"default": "false",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 361,
"description": "A filter to apply to result urls. This filter will modify the default\npath for all modules. The default path for the YUI library is the\nminified version of the files (e.g., event-min.js). The filter property\ncan be a predefined filter or a custom filter. The valid predefined\nfilters are:\n\n - DEBUG
\n - Selects the debug versions of the library (e.g., event-debug.js).\n This option will automatically include the Logger widget
\n - RAW
\n - Selects the non-minified version of the library (e.g., event.js).\n
\n
\nYou can also define a custom filter, which must be an object literal\ncontaining a search expression and a replace string:\n\n myFilter: {\n 'searchExp': \"-min\\\\.js\",\n 'replaceStr': \"-debug.js\"\n }\n",
"itemtype": "property",
"name": "filter",
"type": "string| {searchExp: string, replaceStr: string}",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 388,
"description": "per-component filter specification. If specified for a given\ncomponent, this overrides the filter config.",
"itemtype": "property",
"name": "filters",
"type": "object",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 396,
"description": "The list of requested modules",
"itemtype": "property",
"name": "required",
"type": "{string: boolean}",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 403,
"description": "If a module name is predefined when requested, it is checked againsts\nthe patterns provided in this property. If there is a match, the\nmodule is added with the default configuration.\n\nAt the moment only supporting module prefixes, but anticipate\nsupporting at least regular expressions.",
"itemtype": "property",
"name": "patterns",
"type": "Object",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 416,
"description": "The library metadata",
"itemtype": "property",
"name": "moduleInfo",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 425,
"description": "Provides the information used to skin the skinnable components.\nThe following skin definition would result in 'skin1' and 'skin2'\nbeing loaded for calendar (if calendar was requested), and\n'sam' for all other skinnable components:\n\n \n skin: {\n\n // The default skin, which is automatically applied if not\n // overriden by a component-specific skin definition.\n // Change this in to apply a different skin globally\n defaultSkin: 'sam',\n\n // This is combined with the loader base property to get\n // the default root directory for a skin. ex:\n // http://yui.yahooapis.com/2.3.0/build/assets/skins/sam/\n base: 'assets/skins/',\n\n // Any component-specific overrides can be specified here,\n // making it possible to load different skins for different\n // components. It is possible to load more than one skin\n // for a given component as well.\n overrides: {\n calendar: ['skin1', 'skin2']\n }\n }\n ",
"itemtype": "property",
"name": "skin",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 508,
"description": "List of rollup files found in the library metadata",
"itemtype": "property",
"name": "rollups",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 514,
"description": "Whether or not to load optional dependencies for\nthe requested modules",
"itemtype": "property",
"name": "loadOptional",
"type": "boolean",
"default": "false",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 523,
"description": "All of the derived dependencies in sorted order, which\nwill be populated when either calculate() or insert()\nis called",
"itemtype": "property",
"name": "sorted",
"type": "string[]",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 532,
"description": "Set when beginning to compute the dependency tree.\nComposed of what YUI reports to be loaded combined\nwith what has been loaded by any instance on the page\nwith the version number specified in the metadata.",
"itemtype": "property",
"name": "loaded",
"type": "{string: boolean}",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 549,
"description": "Flag to indicate the dependency tree needs to be recomputed\nif insert is called again.",
"itemtype": "property",
"name": "dirty",
"type": "boolean",
"default": "true",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 558,
"description": "List of modules inserted by the utility",
"itemtype": "property",
"name": "inserted",
"type": "{string: boolean}",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 565,
"description": "List of skipped modules during insert() because the module\nwas not defined",
"itemtype": "property",
"name": "skipped",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 688,
"description": "Apply a new config to the Loader instance",
"itemtype": "method",
"name": "_config",
"params": [
{
"name": "o",
"description": "The new configuration",
"type": "Object"
}
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 748,
"description": "Returns the skin module name for the specified skin name. If a\nmodule name is supplied, the returned skin module name is\nspecific to the module passed in.",
"itemtype": "method",
"name": "formatSkin",
"params": [
{
"name": "skin",
"description": "the name of the skin.",
"type": "String"
},
{
"name": "mod",
"description": "optional: the name of a module to skin.",
"type": "String"
}
],
"return": {
"description": "the full skin module name.",
"type": "String"
},
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 766,
"description": "Adds the skin def to the module info",
"itemtype": "method",
"name": "_addSkin",
"params": [
{
"name": "skin",
"description": "the name of the skin.",
"type": "String"
},
{
"name": "mod",
"description": "the name of the module.",
"type": "String"
},
{
"name": "parent",
"description": "parent module if this is a skin of a\nsubmodule or plugin.",
"type": "String"
}
],
"return": {
"description": "the module name for the skin.",
"type": "String"
},
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 812,
"description": "Add a new module group\n\n - name:
- required, the group name
\n - base:
- The base dir for this module group
\n - root:
- The root path to add to each combo\n resource path
\n - combine:
- combo handle
\n - comboBase:
- combo service base path
\n - modules:
- the group of modules
\n
",
"itemtype": "method",
"name": "addGroup",
"params": [
{
"name": "o",
"description": "An object containing the module data.",
"type": "Object"
},
{
"name": "name",
"description": "the group name.",
"type": "String"
}
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 849,
"description": "Add a new module to the component metadata.\n\n - name:
- required, the component name
\n - type:
- required, the component type (js or css)\n
\n - path:
- required, the path to the script from\n \"base\"
\n - requires:
- array of modules required by this\n component
\n - optional:
- array of optional modules for this\n component
\n - supersedes:
- array of the modules this component\n replaces
\n - after:
- array of modules the components which, if\n present, should be sorted above this one
\n - after_map:
- faster alternative to 'after' -- supply\n a hash instead of an array
\n - rollup:
- the number of superseded modules required\n for automatic rollup
\n - fullpath:
- If fullpath is specified, this is used\n instead of the configured base + path
\n - skinnable:
- flag to determine if skin assets should\n automatically be pulled in
\n - submodules:
- a hash of submodules
\n - group:
- The group the module belongs to -- this\n is set automatically when it is added as part of a group\n configuration.
\n - lang:
\n - array of BCP 47 language tags of languages for which this\n module has localized resource bundles,\n e.g., [\"en-GB\",\"zh-Hans-CN\"]
\n - condition:
\n - Specifies that the module should be loaded automatically if\n a condition is met. This is an object with up to three fields:\n [trigger] - the name of a module that can trigger the auto-load\n [test] - a function that returns true when the module is to be\n loaded.\n [when] - specifies the load order of the conditional module\n with regard to the position of the trigger module.\n This should be one of three values: 'before', 'after', or\n 'instead'. The default is 'after'.\n
\n - testresults:
- a hash of test results from Y.Features.all()
\n
",
"itemtype": "method",
"name": "addModule",
"params": [
{
"name": "o",
"description": "An object containing the module data.",
"type": "Object"
},
{
"name": "name",
"description": "the module name (optional), required if not\nin the module data.",
"type": "String"
}
],
"return": {
"description": "the module definition or null if\nthe object passed in did not provide all required attributes.",
"type": "Object"
},
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1120,
"description": "Add a requirement for one or more module",
"itemtype": "method",
"name": "require",
"params": [
{
"name": "what",
"description": "the modules to load.",
"type": "String[] | string*"
}
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1132,
"description": "Grab all the items that were asked for, check to see if the Loader\nmeta-data contains a \"use\" array. If it doesm remove the asked item and replace it with \nthe content of the \"use\".\nThis will make asking for: \"dd\"\nActually ask for: \"dd-ddm-base,dd-ddm,dd-ddm-drop,dd-drag,dd-proxy,dd-constrain,dd-drop,dd-scroll,dd-drop-plugin\"",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_explodeRollups",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1166,
"description": "Explodes the required array to remove aliases and replace them with real modules",
"itemtype": "method",
"name": "filterRequires",
"params": [
{
"name": "r",
"description": "The original requires array",
"type": "Array"
}
],
"return": {
"description": "The new array of exploded requirements",
"type": "Array"
},
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1200,
"description": "Returns an object containing properties for all modules required\nin order to load the requested module",
"itemtype": "method",
"name": "getRequires",
"params": [
{
"name": "mod",
"description": "The module definition from moduleInfo.",
"type": "Object"
}
],
"return": {
"description": "the expanded requirement list.",
"type": "Array"
},
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1407,
"description": "Returns a hash of module names the supplied module satisfies.",
"itemtype": "method",
"name": "getProvides",
"params": [
{
"name": "name",
"description": "The name of the module.",
"type": "String"
}
],
"return": {
"description": "what this module provides.",
"type": "Object"
},
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1439,
"description": "Calculates the dependency tree, the result is stored in the sorted\nproperty.",
"itemtype": "method",
"name": "calculate",
"params": [
{
"name": "o",
"description": "optional options object.",
"type": "Object"
},
{
"name": "type",
"description": "optional argument to prune modules.",
"type": "String"
}
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1468,
"description": "Creates a \"psuedo\" package for languages provided in the lang array",
"itemtype": "method",
"name": "_addLangPack",
"params": [
{
"name": "lang",
"description": "The language to create",
"type": "String"
},
{
"name": "m",
"description": "The module definition to create the language pack around",
"type": "Object"
},
{
"name": "packName",
"description": "The name of the package (e.g: lang/datatype-date-en-US)",
"type": "String"
}
],
"return": {
"description": "The module definition",
"type": "Object"
},
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1502,
"description": "Investigates the current YUI configuration on the page. By default,\nmodules already detected will not be loaded again unless a force\noption is encountered. Called by calculate()",
"itemtype": "method",
"name": "_setup",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1569,
"description": "Builds a module name for a language pack",
"itemtype": "method",
"name": "getLangPackName",
"params": [
{
"name": "lang",
"description": "the language code.",
"type": "String"
},
{
"name": "mname",
"description": "the module to build it for.",
"type": "String"
}
],
"return": {
"description": "the language pack module name.",
"type": "String"
},
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1579,
"description": "Inspects the required modules list looking for additional\ndependencies. Expands the required list to include all\nrequired modules. Called by calculate()",
"itemtype": "method",
"name": "_explode",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1617,
"description": "Get's the loader meta data for the requested module",
"itemtype": "method",
"name": "getModule",
"params": [
{
"name": "mname",
"description": "The module name to get",
"type": "String"
}
],
"return": {
"description": "The module metadata",
"type": "Object"
},
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1671,
"description": "Remove superceded modules and loaded modules. Called by\ncalculate() after we have the mega list of all dependencies",
"itemtype": "method",
"name": "_reduce",
"return": {
"description": "the reduced dependency hash.",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1711,
"description": "Handles the queue when a module has been loaded for all cases",
"itemtype": "method",
"name": "_finish",
"access": "private",
"tagname": "",
"params": [
{
"name": "msg",
"description": "The message from Loader",
"type": "String"
},
{
"name": "success",
"description": "A boolean denoting success or failure",
"type": "Boolean"
}
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1734,
"description": "The default Loader onSuccess handler, calls this.onSuccess with a payload",
"itemtype": "method",
"name": "_onSuccess",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1773,
"description": "The default Loader onFailure handler, calls this.onFailure with a payload",
"itemtype": "method",
"name": "_onFailure",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1791,
"description": "The default Loader onTimeout handler, calls this.onTimeout with a payload",
"itemtype": "method",
"name": "_onTimeout",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1809,
"description": "Sorts the dependency tree. The last step of calculate()",
"itemtype": "method",
"name": "_sort",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1879,
"description": "(Unimplemented)",
"itemtype": "method",
"name": "partial",
"unimplemented": [
""
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1888,
"description": "Handles the actual insertion of script/link tags",
"itemtype": "method",
"name": "_insert",
"params": [
{
"name": "source",
"description": "The YUI instance the request came from",
"type": "Object"
},
{
"name": "o",
"description": "The metadata to include",
"type": "Object"
},
{
"name": "type",
"description": "JS or CSS",
"type": "String"
},
{
"name": "skipcalc",
"description": "Do a Loader.calculate on the meta",
"type": "Boolean",
"optional": true,
"optdefault": "false"
}
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1961,
"description": "Once a loader operation is completely finished, process any additional queued items.",
"itemtype": "method",
"name": "_continue",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1973,
"description": "inserts the requested modules and their dependencies.\ntype can be \"js\" or \"css\". Both script and\ncss are inserted if type is not provided.",
"itemtype": "method",
"name": "insert",
"params": [
{
"name": "o",
"description": "optional options object.",
"type": "Object"
},
{
"name": "type",
"description": "the type of dependency to insert.",
"type": "String"
}
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 1993,
"description": "Executed every time a module is loaded, and if we are in a load\ncycle, we attempt to load the next script. Public so that it\nis possible to call this if using a method other than\nY.register to determine when scripts are fully loaded",
"itemtype": "method",
"name": "loadNext",
"params": [
{
"name": "mname",
"description": "optional the name of the module that has\nbeen loaded (which is usually why it is time to load the next\none).",
"type": "String"
}
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 2266,
"description": "Apply filter defined for this instance to a url/path",
"itemtype": "method",
"name": "_filter",
"params": [
{
"name": "u",
"description": "the string to filter.",
"type": "String"
},
{
"name": "name",
"description": "the name of the module, if we are processing\na single module as opposed to a combined url.",
"type": "String"
}
],
"return": {
"description": "the filtered string.",
"type": "String"
},
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 2299,
"description": "Generates the full url for a module",
"itemtype": "method",
"name": "_url",
"params": [
{
"name": "path",
"description": "the path fragment.",
"type": "String"
},
{
"name": "name",
"description": "The name of the module",
"type": "String"
},
{
"name": "base",
"description": "The base url to use",
"type": "String",
"optional": true,
"optdefault": "self.base"
}
],
"return": {
"description": "the full url.",
"type": "String"
},
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 2311,
"description": "Returns an Object hash of file arrays built from `loader.sorted` or from an arbitrary list of sorted modules.",
"itemtype": "method",
"name": "resolve",
"params": [
{
"name": "calc",
"description": "Perform a loader.calculate() before anything else",
"type": "Boolean",
"optional": true,
"optdefault": "false"
},
{
"name": "s",
"description": "An override for the loader.sorted array",
"type": "Array",
"optional": true,
"optdefault": "loader.sorted"
}
],
"return": {
"description": "Object hash (js and css) of two arrays of file lists",
"type": "Object"
},
"example": [
" This method can be used as an off-line dep calculator\n\n var Y = YUI();\n var loader = new Y.Loader({\n filter: 'debug',\n base: '../../',\n root: 'build/',\n combine: true,\n require: ['node', 'dd', 'console']\n });\n var out = loader.resolve(true);\n"
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/loader.js",
"line": 2356,
"description": "Returns an Object hash of hashes built from `loader.sorted` or from an arbitrary list of sorted modules.",
"itemtype": "method",
"name": "hash",
"access": "private",
"tagname": "",
"params": [
{
"name": "calc",
"description": "Perform a loader.calculate() before anything else",
"type": "Boolean",
"optional": true,
"optdefault": "false"
},
{
"name": "s",
"description": "An override for the loader.sorted array",
"type": "Array",
"optional": true,
"optdefault": "loader.sorted"
}
],
"return": {
"description": "Object hash (js and css) of two object hashes of file lists, with the module name as the key",
"type": "Object"
},
"example": [
" This method can be used as an off-line dep calculator\n\n var Y = YUI();\n var loader = new Y.Loader({\n filter: 'debug',\n base: '../../',\n root: 'build/',\n combine: true,\n require: ['node', 'dd', 'console']\n });\n var out = loader.hash(true);\n"
],
"class": "Loader",
"module": "loader",
"submodule": "loader-base"
},
{
"file": "lib/yui3/src/loader/js/rollup.js",
"line": 8,
"description": "Look for rollup packages to determine if all of the modules a\nrollup supersedes are required. If so, include the rollup to\nhelp reduce the total number of connections required. Called\nby calculate(). This is an optional feature, and requires the\nappropriate submodule to function.",
"itemtype": "method",
"name": "_rollup",
"access": "private",
"tagname": "",
"class": "Loader",
"module": "loader",
"submodule": "rollup"
},
{
"file": "lib/yui3/src/node/js/align-plugin.js",
"line": 25,
"description": "Aligns node with a point on another node or region.\nPossible alignment points are:\n\n - tl
\n - top left
\n - tr
\n - top right
\n - bl
\n - bottom left
\n - br
\n - bottom right
\n - tc
\n - top center
\n - bc
\n - bottom center
\n - rc
\n - right center
\n - lc
\n - left center
\n - cc
\n - center center
\n
",
"itemtype": "method",
"name": "to",
"params": [
{
"name": "region",
"description": "The node or\nregion to align with. Defaults to the viewport region.",
"type": "String || Node || HTMLElement || Object"
},
{
"name": "regionPoint",
"description": "The point of the region to align with.",
"type": "String"
},
{
"name": "point",
"description": "The point of the node aligned to the region.",
"type": "String"
},
{
"name": "resize",
"description": "Whether or not the node should re-align when\nthe window is resized. Defaults to false.",
"type": "Boolean"
}
],
"class": "Plugin.Align",
"module": "align-plugin"
},
{
"file": "lib/yui3/src/node/js/align-plugin.js",
"line": 123,
"description": "Aligns the center of a node to the center of another node or region.",
"itemtype": "method",
"name": "center",
"params": [
{
"name": "region",
"description": "optional The node or\nregion to align with. Defaults to the viewport region.\nthe window is resized. If centering to viewport, this defaults\nto true, otherwise default is false.",
"type": "Node || HTMLElement || Object"
}
],
"class": "Plugin.Align",
"module": "align-plugin"
},
{
"file": "lib/yui3/src/node/js/align-plugin.js",
"line": 136,
"description": "Removes the resize handler, if any. This is called automatically\nwhen unplugged from the host node.",
"itemtype": "method",
"name": "destroy",
"class": "Plugin.Align",
"module": "align-plugin"
},
{
"file": "lib/yui3/src/node/js/node-attrs.js",
"line": 9,
"description": "Static collection of configuration attributes for special handling",
"itemtype": "property",
"name": "ATTRS",
"static": 1,
"type": "object",
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-attrs.js",
"line": 16,
"description": "Allows for getting and setting the text of an element.\nFormatting is preserved and special characters are treated literally.",
"itemtype": "config",
"name": "text",
"type": "String",
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-attrs.js",
"line": 33,
"description": "Allows for getting and setting the text of an element.\nFormatting is preserved and special characters are treated literally.",
"itemtype": "config",
"name": "for",
"type": "String",
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-attrs.js",
"line": 56,
"description": "Returns a NodeList instance of all HTMLElement children.",
"readonly": "",
"itemtype": "config",
"name": "children",
"type": "NodeList",
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-attrs.js",
"line": 95,
"description": "Allows setting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",
"itemtype": "method",
"name": "setAttribute",
"chainable": 1,
"params": [
{
"name": "name",
"description": "The attribute name",
"type": "String"
},
{
"name": "value",
"description": "The value to set",
"type": "String"
}
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-attrs.js",
"line": 106,
"description": "Allows getting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",
"itemtype": "method",
"name": "getAttribute",
"params": [
{
"name": "name",
"description": "The attribute name",
"type": "String"
}
],
"return": {
"description": "The attribute value",
"type": "String"
},
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 7,
"description": "Determines whether each node has the given className.",
"itemtype": "method",
"name": "hasClass",
"params": [
{
"name": "className",
"description": "the class name to search for",
"type": "String"
}
],
"return": {
"description": "Whether or not the element has the specified class",
"type": "Boolean"
},
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 16,
"description": "Adds a class name to each node.",
"itemtype": "method",
"name": "addClass",
"params": [
{
"name": "className",
"description": "the class name to add to the node's class attribute",
"type": "String"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 24,
"description": "Removes a class name from each node.",
"itemtype": "method",
"name": "removeClass",
"params": [
{
"name": "className",
"description": "the class name to remove from the node's class attribute",
"type": "String"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 32,
"description": "Replace a class with another class for each node.\nIf no oldClassName is present, the newClassName is simply added.",
"itemtype": "method",
"name": "replaceClass",
"params": [
{
"name": "oldClassName",
"description": "the class name to be replaced",
"type": "String"
},
{
"name": "newClassName",
"description": "the class name that will be replacing the old class name",
"type": "String"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 42,
"description": "If the className exists on the node it is removed, if it doesn't exist it is added.",
"itemtype": "method",
"name": "toggleClass",
"params": [
{
"name": "className",
"description": "the class name to be toggled",
"type": "String"
},
{
"name": "force",
"description": "Option to force adding or removing the class.",
"type": "Boolean"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 53,
"description": "Determines whether each node has the given className.",
"itemtype": "method",
"name": "hasClass",
"see": [
"Node.hasClass"
],
"params": [
{
"name": "className",
"description": "the class name to search for",
"type": "String"
}
],
"return": {
"description": "An array of booleans for each node bound to the NodeList.",
"type": "Array"
},
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 62,
"description": "Adds a class name to each node.",
"itemtype": "method",
"name": "addClass",
"see": [
"Node.addClass"
],
"params": [
{
"name": "className",
"description": "the class name to add to the node's class attribute",
"type": "String"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 70,
"description": "Removes a class name from each node.",
"itemtype": "method",
"name": "removeClass",
"see": [
"Node.removeClass"
],
"params": [
{
"name": "className",
"description": "the class name to remove from the node's class attribute",
"type": "String"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 78,
"description": "Replace a class with another class for each node.\nIf no oldClassName is present, the newClassName is simply added.",
"itemtype": "method",
"name": "replaceClass",
"see": [
"Node.replaceClass"
],
"params": [
{
"name": "oldClassName",
"description": "the class name to be replaced",
"type": "String"
},
{
"name": "newClassName",
"description": "the class name that will be replacing the old class name",
"type": "String"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-class.js",
"line": 88,
"description": "If the className exists on the node it is removed, if it doesn't exist it is added.",
"itemtype": "method",
"name": "toggleClass",
"see": [
"Node.toggleClass"
],
"params": [
{
"name": "className",
"description": "the class name to be toggled",
"type": "String"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 60,
"description": "The underlying DOM node bound to the Y.Node instance",
"itemtype": "property",
"name": "_node",
"access": "private",
"tagname": "",
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 108,
"description": "The name of the component",
"static": 1,
"itemtype": "property",
"name": "NAME",
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 123,
"description": "A list of Node instances that have been created",
"access": "private",
"tagname": "",
"itemtype": "property",
"name": "_instances",
"static": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 132,
"description": "Retrieves the DOM node bound to a Node instance",
"itemtype": "method",
"name": "getDOMNode",
"static": 1,
"params": [
{
"name": "node",
"description": "The Node instance or an HTMLNode",
"type": "Node | HTMLNode"
}
],
"return": {
"description": "The DOM node bound to the Node instance. If a DOM node is passed\nas the node argument, it is simply returned.",
"type": "HTMLNode"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 148,
"description": "Checks Node return values and wraps DOM Nodes as Y.Node instances\nand DOM Collections / Arrays as Y.NodeList instances.\nOther return values just pass thru. If undefined is returned (e.g. no return)\nthen the Node instance is returned for chainability.",
"itemtype": "method",
"name": "scrubVal",
"static": 1,
"params": [
{
"name": "node",
"description": "The Node instance or an HTMLNode",
"type": "Any"
}
],
"return": {
"description": "Depends on what is returned from the DOM node.",
"type": "Node | NodeList | Any"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 178,
"description": "Adds methods to the Y.Node prototype, routing through scrubVal.",
"itemtype": "method",
"name": "addMethod",
"static": 1,
"params": [
{
"name": "name",
"description": "The name of the method to add",
"type": "String"
},
{
"name": "fn",
"description": "The function that becomes the method",
"type": "Function"
},
{
"name": "context",
"description": "An optional context to call the method with\n(defaults to the Node instance)",
"type": "Object"
}
],
"return": {
"description": "Depends on what is returned from the DOM node.",
"type": "Any"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 219,
"description": "Imports utility methods to be added as Y.Node methods.",
"itemtype": "method",
"name": "importMethod",
"static": 1,
"params": [
{
"name": "host",
"description": "The object that contains the method to import.",
"type": "Object"
},
{
"name": "name",
"description": "The name of the method to import",
"type": "String"
},
{
"name": "altName",
"description": "An optional name to use in place of the host name",
"type": "String"
},
{
"name": "context",
"description": "An optional context to call the method with",
"type": "Object"
}
],
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 240,
"description": "Retrieves a NodeList based on the given CSS selector.",
"itemtype": "method",
"name": "all",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "A NodeList instance for the matching HTMLCollection/Array.",
"type": "NodeList"
},
"class": "YUI",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 249,
"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector. Returns null if no match found.\nNote: For chaining purposes you may want to\nuse Y.all, which returns a NodeList when no match is found.",
"itemtype": "method",
"name": "one",
"params": [
{
"name": "node",
"description": "a node or Selector",
"type": "String | HTMLElement"
}
],
"return": {
"description": "a Node instance or null if no match found.",
"type": "Node | null"
},
"class": "YUI",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 260,
"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector. Returns null if no match found.\nNote: For chaining purposes you may want to\nuse Y.all, which returns a NodeList when no match is found.",
"itemtype": "method",
"name": "one",
"static": 1,
"params": [
{
"name": "node",
"description": "a node or Selector",
"type": "String | HTMLElement"
}
],
"return": {
"description": "a Node instance or null if no match found.",
"type": "Node | null"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 302,
"description": "The default setter for DOM properties\nCalled with instance context (this === the Node instance)",
"itemtype": "method",
"name": "DEFAULT_SETTER",
"static": 1,
"params": [
{
"name": "name",
"description": "The attribute/property being set",
"type": "String"
},
{
"name": "val",
"description": "The value to be set",
"type": "Any"
}
],
"return": {
"description": "The value",
"type": "Any"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 327,
"description": "The default getter for DOM properties\nCalled with instance context (this === the Node instance)",
"itemtype": "method",
"name": "DEFAULT_GETTER",
"static": 1,
"params": [
{
"name": "name",
"description": "The attribute/property to look up",
"type": "String"
}
],
"return": {
"description": "The current value",
"type": "Any"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 349,
"description": "The method called when outputting Node instances as strings",
"itemtype": "method",
"name": "toString",
"return": {
"description": "A string representation of the Node instance",
"type": "String"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 379,
"description": "Returns an attribute value on the Node instance.\nUnless pre-configured (via `Node.ATTRS`), get hands\noff to the underlying DOM node. Only valid\nattributes/properties for the node will be queried.",
"itemtype": "method",
"name": "get",
"params": [
{
"name": "attr",
"description": "The attribute",
"type": "String"
}
],
"return": {
"description": "The current value of the attribute",
"type": "Any"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 405,
"description": "Helper method for get.",
"itemtype": "method",
"name": "_get",
"access": "private",
"tagname": "",
"params": [
{
"name": "attr",
"description": "The attribute",
"type": "String"
}
],
"return": {
"description": "The current value of the attribute",
"type": "Any"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 427,
"description": "Sets an attribute on the Node instance.\nUnless pre-configured (via Node.ATTRS), set hands\noff to the underlying DOM node. Only valid\nattributes/properties for the node will be set.\nTo set custom attributes use setAttribute.",
"itemtype": "method",
"name": "set",
"params": [
{
"name": "attr",
"description": "The attribute to be set.",
"type": "String"
},
{
"name": "val",
"description": "The value to set the attribute to.",
"type": "Any"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 456,
"description": "Sets multiple attributes.",
"itemtype": "method",
"name": "setAttrs",
"params": [
{
"name": "attrMap",
"description": "an object of name/value pairs to set",
"type": "Object"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 474,
"description": "Returns an object containing the values for the requested attributes.",
"itemtype": "method",
"name": "getAttrs",
"params": [
{
"name": "attrs",
"description": "an array of attributes to get values",
"type": "Array"
}
],
"return": {
"description": "An object with attribute name/value pairs.",
"type": "Object"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 493,
"description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.",
"itemtype": "method",
"name": "compareTo",
"params": [
{
"name": "refNode",
"description": "The reference node to compare to the node.",
"type": "HTMLElement | Node"
}
],
"return": {
"description": "True if the nodes match, false if they do not.",
"type": "Boolean"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 509,
"description": "Determines whether the node is appended to the document.",
"itemtype": "method",
"name": "inDoc",
"params": [
{
"name": "doc",
"description": "optional An optional document to check against.\nDefaults to current document.",
"type": "Node|HTMLElement"
}
],
"return": {
"description": "Whether or not this node is appended to the document.",
"type": "Boolean"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 535,
"description": "Returns the nearest ancestor that passes the test applied by supplied boolean method.",
"itemtype": "method",
"name": "ancestor",
"params": [
{
"name": "fn",
"description": "A selector string or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument.",
"type": "String | Function"
},
{
"name": "testSelf",
"description": "optional Whether or not to include the element in the scan",
"type": "Boolean"
},
{
"name": "stopFn",
"description": "optional A selector string or boolean\nmethod to indicate when the search should stop. The search bails when the function\nreturns true or the selector matches.\nIf a function is used, it receives the current node being tested as the only argument.",
"type": "String | Function"
}
],
"return": {
"description": "The matching Node instance or null if not found",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 557,
"description": "Returns the ancestors that pass the test applied by supplied boolean method.",
"itemtype": "method",
"name": "ancestors",
"params": [
{
"name": "fn",
"description": "A selector string or boolean method for testing elements.",
"type": "String | Function"
},
{
"name": "testSelf",
"description": "optional Whether or not to include the element in the scan\nIf a function is used, it receives the current node being tested as the only argument.",
"type": "Boolean"
}
],
"return": {
"description": "A NodeList instance containing the matching elements",
"type": "NodeList"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 573,
"description": "Returns the previous matching sibling.\nReturns the nearest element node sibling if no method provided.",
"itemtype": "method",
"name": "previous",
"params": [
{
"name": "fn",
"description": "A selector or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument.",
"type": "String | Function"
}
],
"return": {
"description": "Node instance or null if not found",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 585,
"description": "Returns the next matching sibling.\nReturns the nearest element node sibling if no method provided.",
"itemtype": "method",
"name": "next",
"params": [
{
"name": "fn",
"description": "A selector or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument.",
"type": "String | Function"
}
],
"return": {
"description": "Node instance or null if not found",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 597,
"description": "Returns all matching siblings.\nReturns all siblings if no method provided.",
"itemtype": "method",
"name": "siblings",
"params": [
{
"name": "fn",
"description": "A selector or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument.",
"type": "String | Function"
}
],
"return": {
"description": "NodeList instance bound to found siblings",
"type": "NodeList"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 609,
"description": "Retrieves a Node instance of nodes based on the given CSS selector.",
"itemtype": "method",
"name": "one",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "A Node instance for the matching HTMLElement.",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 620,
"description": "Retrieves a NodeList based on the given CSS selector.",
"itemtype": "method",
"name": "all",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "A NodeList instance for the matching HTMLCollection/Array.",
"type": "NodeList"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 635,
"description": "Test if the supplied node matches the supplied selector.",
"itemtype": "method",
"name": "test",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "Whether or not the node matches the selector.",
"type": "Boolean"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 646,
"description": "Removes the node from its parent.\nShortcut for myNode.get('parentNode').removeChild(myNode);",
"itemtype": "method",
"name": "remove",
"params": [
{
"name": "destroy",
"description": "whether or not to call destroy() on the node\nafter removal.",
"type": "Boolean"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 669,
"description": "Replace the node with the other node. This is a DOM update only\nand does not change the node bound to the Node instance.\nShortcut for myNode.get('parentNode').replaceChild(newNode, myNode);",
"itemtype": "method",
"name": "replace",
"params": [
{
"name": "newNode",
"description": "Node to be inserted",
"type": "Node | HTMLNode"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 687,
"itemtype": "method",
"name": "replaceChild",
"params": [
{
"name": "node",
"description": "Node to be inserted",
"type": "String | HTMLElement | Node"
},
{
"name": "refNode",
"description": "Node to be replaced",
"type": "HTMLElement | Node"
}
],
"return": {
"description": "The replaced node",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 702,
"description": "Nulls internal node references, removes any plugins and event listeners",
"itemtype": "method",
"name": "destroy",
"params": [
{
"name": "recursivePurge",
"description": "(optional) Whether or not to remove listeners from the\nnode's subtree (default is false)",
"type": "Boolean"
}
],
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 736,
"description": "Invokes a method on the Node instance",
"itemtype": "method",
"name": "invoke",
"params": [
{
"name": "method",
"description": "The name of the method to invoke",
"type": "String"
},
{
"name": "a,",
"description": "b, c, etc. Arguments to invoke the method with.",
"type": "Any"
}
],
"return": {
"description": "Whatever the underly method returns.\nDOM Nodes and Collections return values\nare converted to Node/NodeList instances."
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 762,
"itemtype": "method",
"name": "swap",
"description": "Swap DOM locations with the given node.\nThis does not change which DOM node each Node instance refers to.",
"params": [
{
"name": "otherNode",
"description": "The node to swap with",
"type": "Node"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 791,
"itemtype": "method",
"name": "getData",
"description": "Retrieves arbitrary data stored on a Node instance.\nThis is not stored with the DOM node.",
"params": [
{
"name": "name",
"description": "Optional name of the data field to retrieve.\nIf no name is given, all data is returned.",
"type": "String"
}
],
"return": {
"description": "Whatever is stored at the given field,\nor an object hash of all fields.",
"type": "Any | Object"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 813,
"itemtype": "method",
"name": "setData",
"description": "Stores arbitrary data on a Node instance.\nThis is not stored with the DOM node.",
"params": [
{
"name": "name",
"description": "The name of the field to set. If no name\nis given, name is treated as the data and overrides any existing data.",
"type": "String"
},
{
"name": "val",
"description": "The value to be assigned to the field.",
"type": "Any"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 833,
"itemtype": "method",
"name": "clearData",
"description": "Clears stored data.",
"params": [
{
"name": "name",
"description": "The name of the field to clear. If no name\nis given, all data is cleared.",
"type": "String"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 864,
"description": "Removes and destroys all of the nodes within the node.",
"itemtype": "method",
"name": "empty",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-core.js",
"line": 874,
"description": "Returns the DOM node bound to the Node instance",
"itemtype": "method",
"name": "getDOMNode",
"return": {
"description": "",
"type": "DOMNode"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 9,
"description": "Returns a new dom node using the provided markup string.",
"itemtype": "method",
"name": "create",
"static": 1,
"params": [
{
"name": "html",
"description": "The markup used to create the element",
"type": "String"
},
{
"name": "doc",
"description": "An optional document context",
"type": "HTMLDocument"
}
],
"return": {
"description": "A Node instance bound to a DOM node or fragment",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 26,
"description": "Creates a new Node using the provided markup string.",
"itemtype": "method",
"name": "create",
"params": [
{
"name": "html",
"description": "The markup used to create the element",
"type": "String"
},
{
"name": "doc",
"description": "An optional document context",
"type": "HTMLDocument"
}
],
"return": {
"description": "A Node instance bound to a DOM node or fragment",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 35,
"description": "Inserts the content before the reference node.",
"itemtype": "method",
"name": "insert",
"params": [
{
"name": "content",
"description": "The content to insert",
"type": "String | Node | HTMLElement | NodeList | HTMLCollection"
},
{
"name": "where",
"description": "The position to insert at.\nPossible \"where\" arguments\n\n- Y.Node
\n- The Node to insert before
\n- HTMLElement
\n- The element to insert before
\n- Int
\n- The index of the child element to insert before
\n- \"replace\"
\n- Replaces the existing HTML
\n- \"before\"
\n- Inserts before the existing HTML
\n- \"before\"
\n- Inserts content before the node
\n- \"after\"
\n- Inserts content after the node
\n
",
"type": "Int | Node | HTMLElement | String"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 82,
"description": "Inserts the content as the firstChild of the node.",
"itemtype": "method",
"name": "prepend",
"params": [
{
"name": "content",
"description": "The content to insert",
"type": "String | Node | HTMLElement"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 92,
"description": "Inserts the content as the lastChild of the node.",
"itemtype": "method",
"name": "append",
"params": [
{
"name": "content",
"description": "The content to insert",
"type": "String | Node | HTMLElement"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 102,
"itemtype": "method",
"name": "appendChild",
"params": [
{
"name": "node",
"description": "Node to be appended",
"type": "String | HTMLElement | Node"
}
],
"return": {
"description": "The appended node",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 111,
"itemtype": "method",
"name": "insertBefore",
"params": [
{
"name": "newNode",
"description": "Node to be appended",
"type": "String | HTMLElement | Node"
},
{
"name": "refNode",
"description": "Node to be inserted before",
"type": "HTMLElement | Node"
}
],
"return": {
"description": "The inserted node",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 121,
"description": "Appends the node to the given node.",
"itemtype": "method",
"name": "appendTo",
"params": [
{
"name": "node",
"description": "The node to append to",
"type": "Node | HTMLElement"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 132,
"description": "Replaces the node's current content with the content.",
"itemtype": "method",
"name": "setContent",
"params": [
{
"name": "content",
"description": "The content to insert",
"type": "String | Node | HTMLElement | NodeList | HTMLCollection"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 143,
"description": "Returns the node's current content (e.g. innerHTML)",
"itemtype": "method",
"name": "getContent",
"return": {
"description": "The current content",
"type": "String"
},
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 154,
"description": "Called on each Node instance",
"itemtype": "method",
"name": "append",
"see": [
"Node.append"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 162,
"itemtype": "method",
"name": "insert",
"see": [
"Node.insert"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 168,
"description": "Called on each Node instance",
"itemtype": "method",
"name": "appendChild",
"see": [
"Node.appendChild"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 176,
"itemtype": "method",
"name": "insertBefore",
"see": [
"Node.insertBefore"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 182,
"itemtype": "method",
"name": "prepend",
"see": [
"Node.prepend"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 188,
"itemtype": "method",
"name": "setContent",
"see": [
"Node.setContent"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-create.js",
"line": 194,
"itemtype": "method",
"name": "getContent",
"see": [
"Node.getContent"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-deprecated.js",
"line": 27,
"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector.",
"itemtype": "method",
"name": "get",
"deprecated": true,
"deprecationMessage": "Use Y.one",
"static": 1,
"params": [
{
"name": "node",
"description": "a node or Selector",
"type": "String | HTMLElement"
},
{
"name": "doc",
"description": "an optional document to scan. Defaults to Y.config.doc.",
"type": "Node | HTMLElement"
}
],
"class": "YUI",
"module": "node",
"submodule": "node-deprecated"
},
{
"file": "lib/yui3/src/node/js/node-deprecated.js",
"line": 38,
"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector.",
"itemtype": "method",
"name": "get",
"deprecated": true,
"deprecationMessage": "Use Y.one",
"static": 1,
"params": [
{
"name": "node",
"description": "a node or Selector",
"type": "String | HTMLElement"
},
{
"name": "doc",
"description": "an optional document to scan. Defaults to Y.config.doc.",
"type": "Node | HTMLElement"
}
],
"class": "Node",
"module": "node",
"submodule": "node-deprecated"
},
{
"file": "lib/yui3/src/node/js/node-deprecated.js",
"line": 55,
"description": "Retrieves a Node instance of nodes based on the given CSS selector.",
"itemtype": "method",
"name": "query",
"deprecated": true,
"deprecationMessage": "Use one()",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "A Node instance for the matching HTMLElement.",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-deprecated"
},
{
"file": "lib/yui3/src/node/js/node-deprecated.js",
"line": 67,
"description": "Retrieves a nodeList based on the given CSS selector.",
"itemtype": "method",
"name": "queryAll",
"deprecated": true,
"deprecationMessage": "Use all()",
"params": [
{
"name": "selector",
"description": "The CSS selector to test against.",
"type": "String"
}
],
"return": {
"description": "A NodeList instance for the matching HTMLCollection/Array.",
"type": "NodeList"
},
"class": "Node",
"module": "node",
"submodule": "node-deprecated"
},
{
"file": "lib/yui3/src/node/js/node-deprecated.js",
"line": 79,
"description": "Applies the given function to each Node in the NodeList.",
"itemtype": "method",
"name": "each",
"deprecated": true,
"deprecationMessage": "Use NodeList",
"params": [
{
"name": "fn",
"description": "The function to apply",
"type": "Function"
},
{
"name": "context",
"description": "optional An optional context to apply the function with\nDefault context is the NodeList instance",
"type": "Object"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-deprecated"
},
{
"file": "lib/yui3/src/node/js/node-deprecated.js",
"line": 94,
"description": "Retrieves the Node instance at the given index.",
"itemtype": "method",
"name": "item",
"deprecated": true,
"deprecationMessage": "Use NodeList",
"params": [
{
"name": "index",
"description": "The index of the target Node.",
"type": "Number"
}
],
"return": {
"description": "The Node instance at the given index.",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-deprecated"
},
{
"file": "lib/yui3/src/node/js/node-deprecated.js",
"line": 107,
"description": "Returns the current number of items in the Node.",
"itemtype": "method",
"name": "size",
"deprecated": true,
"deprecationMessage": "Use NodeList",
"return": {
"description": "The number of items in the Node.",
"type": "Int"
},
"class": "Node",
"module": "node",
"submodule": "node-deprecated"
},
{
"file": "lib/yui3/src/node/js/node-event-delegate.js",
"line": 7,
"description": "Sets up a delegation listener for an event occurring inside the Node.\nThe delegated event will be verified against a supplied selector or\nfiltering function to test if the event references at least one node that\nshould trigger the subscription callback.
\n\nSelector string filters will trigger the callback if the event originated\nfrom a node that matches it or is contained in a node that matches it.\nFunction filters are called for each Node up the parent axis to the\nsubscribing container node, and receive at each level the Node and the event\nobject. The function should return true (or a truthy value) if that Node\nshould trigger the subscription callback. Note, it is possible for filters\nto match multiple Nodes for a single event. In this case, the delegate\ncallback will be executed for each matching Node.
\n\nFor each matching Node, the callback will be executed with its 'this'\nobject set to the Node matched by the filter (unless a specific context was\nprovided during subscription), and the provided event's\ncurrentTarget will also be set to the matching Node. The\ncontaining Node from which the subscription was originally made can be\nreferenced as e.container.",
"itemtype": "method",
"name": "delegate",
"params": [
{
"name": "type",
"description": "the event type to delegate",
"type": "String"
},
{
"name": "fn",
"description": "the callback function to execute. This function\n will be provided the event object for the delegated event.",
"type": "Function"
},
{
"name": "spec",
"description": "a selector that must match the target of the\n event or a function to test target and its parents for a match",
"type": "String|Function"
},
{
"name": "context",
"description": "optional argument that specifies what 'this' refers to.",
"type": "Object"
},
{
"name": "args",
"description": "0..n additional arguments to pass on to the callback function.\n These arguments will be added after the event object.",
"type": "Any",
"multiple": true
}
],
"return": {
"description": "the detach handle",
"type": "EventHandle"
},
"class": "Node",
"module": "node",
"submodule": "node-event-delegate"
},
{
"file": "lib/yui3/src/node/js/node-event-simulate.js",
"line": 7,
"description": "Simulates an event on the node.",
"params": [
{
"name": "type",
"description": "The type of event to simulate (i.e., \"click\").",
"type": "String"
},
{
"name": "options",
"description": "(Optional) Extra options to copy onto the event object.",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "simulate",
"class": "Node",
"module": "node",
"submodule": "node-event-simulate"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 8,
"description": "List of events that route to DOM events",
"static": 1,
"itemtype": "property",
"name": "DOM_EVENTS",
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 69,
"description": "Removes event listeners from the node and (optionally) its subtree",
"itemtype": "method",
"name": "purge",
"params": [
{
"name": "recurse",
"description": "(optional) Whether or not to remove listeners from the\nnode's subtree",
"type": "Boolean"
},
{
"name": "type",
"description": "(optional) Only remove listeners of the specified type",
"type": "String"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 101,
"description": "Subscribe a callback function for each `Node` in the collection to execute\nin response to a DOM event.\n\nNOTE: Generally, the `on()` method should be avoided on `NodeLists`, in\nfavor of using event delegation from a parent Node. See the Event user\nguide for details.\n\nMost DOM events are associated with a preventable default behavior, such as\nlink clicks navigating to a new page. Callbacks are passed a\n`DOMEventFacade` object as their first argument (usually called `e`) that\ncan be used to prevent this default behavior with `e.preventDefault()`. See\nthe `DOMEventFacade` API for all available properties and methods on the\nobject.\n\nBy default, the `this` object will be the `NodeList` that the subscription\ncame from, not the `Node` that received the event. Use\n`e.currentTarget` to refer to the `Node`.\n\nReturning `false` from a callback is supported as an alternative to calling\n`e.preventDefault(); e.stopPropagation();`. However, it is recommended to\nuse the event methods.",
"example": [
"\n\n Y.all(\".sku\").on(\"keydown\", function (e) {\n if (e.keyCode === 13) {\n e.preventDefault();\n\n // Use e.currentTarget to refer to the individual Node\n var item = Y.MyApp.searchInventory( e.currentTarget.get('value') );\n // etc ...\n }\n });"
],
"itemtype": "method",
"name": "on",
"params": [
{
"name": "type",
"description": "The name of the event",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching that\n subscription",
"type": "EventHandle"
},
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 149,
"description": "Applies an one-time event listener to each Node bound to the NodeList.",
"itemtype": "method",
"name": "once",
"params": [
{
"name": "type",
"description": "The event being listened for",
"type": "String"
},
{
"name": "fn",
"description": "The handler to call when the event fires",
"type": "Function"
},
{
"name": "context",
"description": "The context to call the handler with.\nDefault is the NodeList instance.",
"type": "Object"
}
],
"return": {
"description": "A subscription handle capable of detaching that\n subscription",
"type": "EventHandle"
},
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 164,
"description": "Applies an event listener to each Node bound to the NodeList.\nThe handler is called only after all on() handlers are called\nand the event is not prevented.",
"itemtype": "method",
"name": "after",
"params": [
{
"name": "type",
"description": "The event being listened for",
"type": "String"
},
{
"name": "fn",
"description": "The handler to call when the event fires",
"type": "Function"
},
{
"name": "context",
"description": "The context to call the handler with.\nDefault is the NodeList instance.",
"type": "Object"
}
],
"return": {
"description": "A subscription handle capable of detaching that\n subscription",
"type": "EventHandle"
},
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 181,
"description": "Applies an one-time event listener to each Node bound to the NodeList\nthat will be called only after all on() handlers are called and the\nevent is not prevented.",
"itemtype": "method",
"name": "onceAfter",
"params": [
{
"name": "type",
"description": "The event being listened for",
"type": "String"
},
{
"name": "fn",
"description": "The handler to call when the event fires",
"type": "Function"
},
{
"name": "context",
"description": "The context to call the handler with.\nDefault is the NodeList instance.",
"type": "Object"
}
],
"return": {
"description": "A subscription handle capable of detaching that\n subscription",
"type": "EventHandle"
},
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 201,
"description": "Called on each Node instance",
"itemtype": "method",
"name": "detach",
"see": [
"Node.detach"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 209,
"itemtype": "method",
"name": "detachAll",
"see": [
"Node.detachAll"
],
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-event.js",
"line": 217,
"description": "Subscribe a callback function to execute in response to a DOM event or custom\nevent.\n\nMost DOM events are associated with a preventable default behavior such as\nlink clicks navigating to a new page. Callbacks are passed a `DOMEventFacade`\nobject as their first argument (usually called `e`) that can be used to\nprevent this default behavior with `e.preventDefault()`. See the\n`DOMEventFacade` API for all available properties and methods on the object.\n\nIf the event name passed as the first parameter is not a whitelisted DOM event,\nit will be treated as a custom event subscriptions, allowing\n`node.fire('customEventName')` later in the code. Refer to the Event user guide\nfor the full DOM event whitelist.\n\nBy default, the `this` object in the callback will refer to the subscribed\n`Node`.\n\nReturning `false` from a callback is supported as an alternative to calling\n`e.preventDefault(); e.stopPropagation();`. However, it is recommended to use\nthe event methods.",
"example": [
"\n\n Y.one(\"#my-form\").on(\"submit\", function (e) {\n e.preventDefault();\n\n // proceed with ajax form submission instead...\n });"
],
"itemtype": "method",
"name": "on",
"params": [
{
"name": "type",
"description": "The name of the event",
"type": "String"
},
{
"name": "fn",
"description": "The callback to execute in response to the event",
"type": "Function"
},
{
"name": "context",
"description": "Override `this` object in callback",
"type": "Object",
"optional": true
},
{
"name": "arg*",
"description": "0..n additional arguments to supply to the subscriber",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A subscription handle capable of detaching that\n subscription",
"type": "EventHandle"
},
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 7,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "removeChild",
"params": [
{
"name": "node",
"description": "Node to be removed",
"type": "HTMLElement | Node"
}
],
"return": {
"description": "The removed node",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 16,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "hasChildNodes",
"return": {
"description": "Whether or not the node has any childNodes",
"type": "Boolean"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 23,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "cloneNode",
"params": [
{
"name": "deep",
"description": "Whether or not to perform a deep clone, which includes\nsubtree and attributes",
"type": "Boolean"
}
],
"return": {
"description": "The clone",
"type": "Node"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 32,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "hasAttribute",
"params": [
{
"name": "attribute",
"description": "The attribute to test for",
"type": "String"
}
],
"return": {
"description": "Whether or not the attribute is present",
"type": "Boolean"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 40,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "scrollIntoView",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 47,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "getElementsByTagName",
"params": [
{
"name": "tagName",
"description": "The tagName to collect",
"type": "String"
}
],
"return": {
"description": "A NodeList representing the HTMLCollection",
"type": "NodeList"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 55,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "focus",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 62,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "blur",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 69,
"description": "Passes through to DOM method.\nOnly valid on FORM elements",
"itemtype": "method",
"name": "submit",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 77,
"description": "Passes through to DOM method.\nOnly valid on FORM elements",
"itemtype": "method",
"name": "reset",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 85,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "select",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 92,
"description": "Passes through to DOM method.\nOnly valid on TABLE elements",
"itemtype": "method",
"name": "createCaption",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 108,
"description": "Passes through to DOM method.",
"itemtype": "method",
"name": "removeAttribute",
"params": [
{
"name": "attribute",
"description": "The attribute to be removed",
"type": "String"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 125,
"description": "Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.",
"itemtype": "method",
"name": "contains",
"params": [
{
"name": "needle",
"description": "The possible node or descendent",
"type": "Node | HTMLElement"
}
],
"return": {
"description": "Whether or not this node is the needle its ancestor",
"type": "Boolean"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 132,
"description": "Allows setting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",
"itemtype": "method",
"name": "setAttribute",
"chainable": 1,
"params": [
{
"name": "name",
"description": "The attribute name",
"type": "String"
},
{
"name": "value",
"description": "The value to set",
"type": "String"
}
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 143,
"description": "Allows getting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",
"itemtype": "method",
"name": "getAttribute",
"params": [
{
"name": "name",
"description": "The attribute name",
"type": "String"
}
],
"return": {
"description": "The attribute value",
"type": "String"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 154,
"description": "Wraps the given HTML around the node.",
"itemtype": "method",
"name": "wrap",
"params": [
{
"name": "html",
"description": "The markup to wrap around the node.",
"type": "String"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 163,
"description": "Removes the node's parent node.",
"itemtype": "method",
"name": "unwrap",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 170,
"description": "Applies a unique ID to the node if none exists",
"itemtype": "method",
"name": "generateID",
"return": {
"description": "The existing or generated ID",
"type": "String"
},
"class": "Node",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 179,
"description": "Allows getting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",
"itemtype": "method",
"name": "getAttribute",
"see": [
"Node"
],
"params": [
{
"name": "name",
"description": "The attribute name",
"type": "String"
}
],
"return": {
"description": "The attribute value",
"type": "String"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 190,
"description": "Allows setting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.",
"itemtype": "method",
"name": "setAttribute",
"see": [
"Node"
],
"chainable": 1,
"params": [
{
"name": "name",
"description": "The attribute name",
"type": "String"
},
{
"name": "value",
"description": "The value to set",
"type": "String"
}
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 202,
"description": "Allows for removing attributes on DOM nodes.\nThis passes through to the DOM node, allowing for custom attributes.",
"itemtype": "method",
"name": "removeAttribute",
"see": [
"Node"
],
"params": [
{
"name": "name",
"description": "The attribute to remove",
"type": "String"
}
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 211,
"description": "Removes the parent node from node in the list.",
"itemtype": "method",
"name": "unwrap",
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 217,
"description": "Wraps the given HTML around each node.",
"itemtype": "method",
"name": "wrap",
"params": [
{
"name": "html",
"description": "The markup to wrap around the node.",
"type": "String"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-imports.js",
"line": 225,
"description": "Applies a unique ID to each node if none exists",
"itemtype": "method",
"name": "generateID",
"return": {
"description": "The existing or generated ID",
"type": "String"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/node-load.js",
"line": 7,
"description": "The default IO complete handler.",
"itemtype": "method",
"name": "_ioComplete",
"access": "protected",
"tagname": "",
"params": [
{
"name": "code",
"description": "The response code.",
"type": "String"
},
{
"name": "response",
"description": "The response object.",
"type": "Object"
},
{
"name": "args",
"description": "An array containing the callback and selector",
"type": "Array"
}
],
"class": "Node",
"module": "node",
"submodule": "node-load"
},
{
"file": "lib/yui3/src/node/js/node-load.js",
"line": 36,
"description": "Loads content from the given url and replaces the Node's\nexisting content with the remote content.",
"itemtype": "method",
"name": "load",
"params": [
{
"name": "url",
"description": "The URL to load via XMLHttpRequest.",
"type": "String"
},
{
"name": "selector",
"description": "An optional selector representing a subset of an HTML document to load.",
"type": "String"
},
{
"name": "callback",
"description": "An optional function to run after the content has been loaded.",
"type": "Function"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-load"
},
{
"file": "lib/yui3/src/node/js/node-pluginhost.js",
"line": 6,
"description": "Registers plugins to be instantiated at the class level (plugins\nwhich should be plugged into every instance of Node by default).",
"itemtype": "method",
"name": "plug",
"static": 1,
"params": [
{
"name": "plugin",
"description": "Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)",
"type": "Function | Array"
},
{
"name": "config",
"description": "(Optional) If plugin is the plugin class, the configuration for the plugin",
"type": "Object"
}
],
"class": "Node",
"module": "node",
"submodule": "node-pluginhost"
},
{
"file": "lib/yui3/src/node/js/node-pluginhost.js",
"line": 23,
"description": "Unregisters any class level plugins which have been registered by the Node",
"itemtype": "method",
"name": "unplug",
"static": 1,
"params": [
{
"name": "plugin",
"description": "The plugin class, or an array of plugin classes",
"type": "Function | Array"
}
],
"class": "Node",
"module": "node",
"submodule": "node-pluginhost"
},
{
"file": "lib/yui3/src/node/js/node-region.js",
"line": 6,
"description": "Returns a region object for the node",
"itemtype": "config",
"name": "region",
"type": "Node",
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-region.js",
"line": 31,
"description": "Returns a region object for the node's viewport",
"itemtype": "config",
"name": "viewportRegion",
"type": "Node",
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-region.js",
"line": 45,
"description": "Compares the intersection of the node with another node or region",
"itemtype": "method",
"name": "intersect",
"params": [
{
"name": "node2",
"description": "The node or region to compare with.",
"type": "Node|Object"
},
{
"name": "altRegion",
"description": "An alternate region to use (rather than this node's).",
"type": "Object"
}
],
"return": {
"description": "An object representing the intersection of the regions.",
"type": "Object"
},
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-region.js",
"line": 61,
"description": "Determines whether or not the node is within the giving region.",
"itemtype": "method",
"name": "inRegion",
"params": [
{
"name": "node2",
"description": "The node or region to compare with.",
"type": "Node|Object"
},
{
"name": "all",
"description": "Whether or not all of the node must be in the region.",
"type": "Boolean"
},
{
"name": "altRegion",
"description": "An alternate region to use (rather than this node's).",
"type": "Object"
}
],
"return": {
"description": "An object representing the intersection of the regions.",
"type": "Object"
},
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 10,
"description": "Returns the inner width of the viewport (exludes scrollbar).",
"itemtype": "config",
"name": "winWidth",
"type": "{Int}",
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 18,
"description": "Returns the inner height of the viewport (exludes scrollbar).",
"itemtype": "config",
"name": "winHeight",
"type": "{Int}",
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 25,
"description": "Document width",
"itemtype": "config",
"name": "winHeight",
"type": "{Int}",
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 32,
"description": "Document height",
"itemtype": "config",
"name": "docHeight",
"type": "{Int}",
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 39,
"description": "Pixel distance the page has been scrolled horizontally",
"itemtype": "config",
"name": "docScrollX",
"type": "{Int}",
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 46,
"description": "Pixel distance the page has been scrolled vertically",
"itemtype": "config",
"name": "docScrollY",
"type": "{Int}",
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 106,
"description": "Gets the current position of the node in page coordinates.",
"itemtype": "method",
"name": "getXY",
"return": {
"description": "The XY position of the node",
"type": "Array"
},
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 114,
"description": "Set the position of the node in page coordinates, regardless of how the node is positioned.",
"itemtype": "method",
"name": "setXY",
"params": [
{
"name": "xy",
"description": "Contains X & Y values for new position (coordinates are page-based)",
"type": "Array"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 122,
"description": "Gets the current position of the node in page coordinates.",
"itemtype": "method",
"name": "getX",
"return": {
"description": "The X position of the node",
"type": "Int"
},
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 129,
"description": "Set the position of the node in page coordinates, regardless of how the node is positioned.",
"itemtype": "method",
"name": "setX",
"params": [
{
"name": "x",
"description": "X value for new position (coordinates are page-based)",
"type": "Int"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 137,
"description": "Gets the current position of the node in page coordinates.",
"itemtype": "method",
"name": "getY",
"return": {
"description": "The Y position of the node",
"type": "Int"
},
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 144,
"description": "Set the position of the node in page coordinates, regardless of how the node is positioned.",
"itemtype": "method",
"name": "setY",
"params": [
{
"name": "y",
"description": "Y value for new position (coordinates are page-based)",
"type": "Int"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-screen.js",
"line": 152,
"description": "Swaps the XY position of this node with another node.",
"itemtype": "method",
"name": "swapXY",
"params": [
{
"name": "otherNode",
"description": "The node to swap with.",
"type": "Node | HTMLElement"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-screen"
},
{
"file": "lib/yui3/src/node/js/node-style.js",
"line": 9,
"description": "Returns the style's current value.",
"itemtype": "method",
"name": "getStyle",
"params": [
{
"name": "attr",
"description": "The style attribute to retrieve.",
"type": "String"
}
],
"return": {
"description": "The current value of the style property for the element.",
"type": "String"
},
"class": "Node",
"module": "node",
"submodule": "node-style"
},
{
"file": "lib/yui3/src/node/js/node-style.js",
"line": 18,
"description": "Returns the computed value for the given style property.\nUse CSS case (e.g. 'background-color') for multi-word properties.",
"itemtype": "method",
"name": "getComputedStyle",
"params": [
{
"name": "attr",
"description": "The style attribute to retrieve.",
"type": "String"
}
],
"return": {
"description": "The computed value of the style property for the element.",
"type": "String"
},
"class": "Node",
"module": "node",
"submodule": "node-style"
},
{
"file": "lib/yui3/src/node/js/node-style.js",
"line": 28,
"description": "Sets a style property of the node. Use CSS case (e.g. 'background-color')\nfor multi-word properties.",
"itemtype": "method",
"name": "setStyle",
"params": [
{
"name": "attr",
"description": "The style attribute to set.",
"type": "String"
},
{
"name": "val",
"description": "The value.",
"type": "String|Number"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-style"
},
{
"file": "lib/yui3/src/node/js/node-style.js",
"line": 38,
"description": "Sets multiple style properties on the node.",
"itemtype": "method",
"name": "setStyles",
"params": [
{
"name": "hash",
"description": "An object literal of property:value pairs.",
"type": "Object"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-style"
},
{
"file": "lib/yui3/src/node/js/node-style.js",
"line": 47,
"description": "Returns an array of values for each node.",
"itemtype": "method",
"name": "getStyle",
"see": [
"Node.getStyle"
],
"params": [
{
"name": "attr",
"description": "The style attribute to retrieve.",
"type": "String"
}
],
"return": {
"description": "The current values of the style property for the element.",
"type": "Array"
},
"class": "NodeList",
"module": "node",
"submodule": "node-style"
},
{
"file": "lib/yui3/src/node/js/node-style.js",
"line": 56,
"description": "Returns an array of the computed value for each node.",
"itemtype": "method",
"name": "getComputedStyle",
"see": [
"Node.getComputedStyle"
],
"params": [
{
"name": "attr",
"description": "The style attribute to retrieve.",
"type": "String"
}
],
"return": {
"description": "The computed values for each node.",
"type": "Array"
},
"class": "NodeList",
"module": "node",
"submodule": "node-style"
},
{
"file": "lib/yui3/src/node/js/node-style.js",
"line": 64,
"description": "Sets a style property on each node.",
"itemtype": "method",
"name": "setStyle",
"see": [
"Node.setStyle"
],
"params": [
{
"name": "attr",
"description": "The style attribute to set.",
"type": "String"
},
{
"name": "val",
"description": "The value.",
"type": "String|Number"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-style"
},
{
"file": "lib/yui3/src/node/js/node-style.js",
"line": 73,
"description": "Sets multiple style properties on each node.",
"itemtype": "method",
"name": "setStyles",
"see": [
"Node.setStyles"
],
"params": [
{
"name": "hash",
"description": "An object literal of property:value pairs.",
"type": "Object"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-style"
},
{
"file": "lib/yui3/src/node/js/node-view.js",
"line": 9,
"description": "Makes the node visible.\nIf the \"transition\" module is loaded, show optionally\nanimates the showing of the node using either the default\ntransition effect ('fadeIn'), or the given named effect.",
"itemtype": "method",
"name": "show",
"params": [
{
"name": "name",
"description": "A named Transition effect to use as the show effect.",
"type": "String"
},
{
"name": "config",
"description": "Options to use with the transition.",
"type": "Object"
},
{
"name": "callback",
"description": "An optional function to run after the transition completes.",
"type": "Function"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-view.js",
"line": 27,
"description": "The implementation for showing nodes.\nDefault is to toggle the style.display property.",
"itemtype": "method",
"name": "_show",
"access": "protected",
"tagname": "",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-view.js",
"line": 68,
"description": "Hides the node.\nIf the \"transition\" module is loaded, hide optionally\nanimates the hiding of the node using either the default\ntransition effect ('fadeOut'), or the given named effect.",
"itemtype": "method",
"name": "hide",
"params": [
{
"name": "name",
"description": "A named Transition effect to use as the show effect.",
"type": "String"
},
{
"name": "config",
"description": "Options to use with the transition.",
"type": "Object"
},
{
"name": "callback",
"description": "An optional function to run after the transition completes.",
"type": "Function"
}
],
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-view.js",
"line": 85,
"description": "The implementation for hiding nodes.\nDefault is to toggle the style.display property.",
"itemtype": "method",
"name": "_hide",
"access": "protected",
"tagname": "",
"chainable": 1,
"class": "Node",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-view.js",
"line": 98,
"description": "Makes each node visible.\nIf the \"transition\" module is loaded, show optionally\nanimates the showing of the node using either the default\ntransition effect ('fadeIn'), or the given named effect.",
"itemtype": "method",
"name": "show",
"params": [
{
"name": "name",
"description": "A named Transition effect to use as the show effect.",
"type": "String"
},
{
"name": "config",
"description": "Options to use with the transition.",
"type": "Object"
},
{
"name": "callback",
"description": "An optional function to run after the transition completes.",
"type": "Function"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/node-view.js",
"line": 112,
"description": "Hides each node.\nIf the \"transition\" module is loaded, hide optionally\nanimates the hiding of the node using either the default\ntransition effect ('fadeOut'), or the given named effect.",
"itemtype": "method",
"name": "hide",
"params": [
{
"name": "name",
"description": "A named Transition effect to use as the show effect.",
"type": "String"
},
{
"name": "config",
"description": "Options to use with the transition.",
"type": "Object"
},
{
"name": "callback",
"description": "An optional function to run after the transition completes.",
"type": "Function"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-base"
},
{
"file": "lib/yui3/src/node/js/nodelist-array.js",
"line": 9,
"itemtype": "method",
"name": "concat",
"params": [
{
"name": "valueN",
"description": "Arrays/NodeLists and/or values to\nconcatenate to the resulting NodeList",
"type": "NodeList | Array"
}
],
"return": {
"description": "A new NodeList comprised of this NodeList joined with the input.",
"type": "NodeList"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist-array.js",
"line": 17,
"itemtype": "method",
"name": "pop",
"return": {
"description": "The last item in the NodeList.",
"type": "Node"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist-array.js",
"line": 23,
"itemtype": "method",
"name": "push",
"params": [
{
"name": "nodes",
"description": "One or more nodes to add to the end of the NodeList.",
"type": "Node | DOMNode"
}
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist-array.js",
"line": 29,
"itemtype": "method",
"name": "shift",
"return": {
"description": "The first item in the NodeList.",
"type": "Node"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist-array.js",
"line": 35,
"itemtype": "method",
"name": "slice",
"params": [
{
"name": "begin",
"description": "Zero-based index at which to begin extraction.\n As a negative index, start indicates an offset from the end of the sequence. slice(-2) extracts the second-to-last element and the last element in the sequence.",
"type": "Number"
},
{
"name": "end",
"description": "Zero-based index at which to end extraction. slice extracts up to but not including end.\n slice(1,4) extracts the second element through the fourth element (elements indexed 1, 2, and 3).\n As a negative index, end indicates an offset from the end of the sequence. slice(2,-1) extracts the third element through the second-to-last element in the sequence.\n If end is omitted, slice extracts to the end of the sequence.",
"type": "Number"
}
],
"return": {
"description": "A new NodeList comprised of this NodeList joined with the input.",
"type": "NodeList"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist-array.js",
"line": 47,
"itemtype": "method",
"name": "splice",
"params": [
{
"name": "index",
"description": "Index at which to start changing the array. If negative, will begin that many elements from the end.",
"type": "Number"
},
{
"name": "howMany",
"description": "An integer indicating the number of old array elements to remove. If howMany is 0, no elements are removed. In this case, you should specify at least one new element. If no howMany parameter is specified (second syntax above, which is a SpiderMonkey extension), all elements after index are removed.\n{Node | DOMNode| element1, ..., elementN\n The elements to add to the array. If you don't specify any elements, splice simply removes elements from the array.",
"type": "Number"
}
],
"return": {
"description": "The element(s) removed.",
"type": "NodeList"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist-array.js",
"line": 57,
"itemtype": "method",
"name": "unshift",
"params": [
{
"name": "nodes",
"description": "One or more nodes to add to the NodeList.",
"type": "Node | DOMNode"
}
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 39,
"description": "The underlying array of DOM nodes bound to the Y.NodeList instance",
"itemtype": "property",
"name": "_nodes",
"access": "private",
"tagname": "",
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 49,
"description": "Retrieves the DOM nodes bound to a NodeList instance",
"itemtype": "method",
"name": "getDOMNodes",
"static": 1,
"params": [
{
"name": "nodelist",
"description": "The NodeList instance",
"type": "NodeList"
}
],
"return": {
"description": "The array of DOM nodes bound to the NodeList",
"type": "Array"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 124,
"description": "Retrieves the Node instance at the given index.",
"itemtype": "method",
"name": "item",
"params": [
{
"name": "index",
"description": "The index of the target Node.",
"type": "Number"
}
],
"return": {
"description": "The Node instance at the given index.",
"type": "Node"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 135,
"description": "Applies the given function to each Node in the NodeList.",
"itemtype": "method",
"name": "each",
"params": [
{
"name": "fn",
"description": "The function to apply. It receives 3 arguments:\nthe current node instance, the node's index, and the NodeList instance",
"type": "Function"
},
{
"name": "context",
"description": "optional An optional context to apply the function with\nDefault context is the current Node instance",
"type": "Object"
}
],
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 167,
"description": "Executes the function once for each node until a true value is returned.",
"itemtype": "method",
"name": "some",
"params": [
{
"name": "fn",
"description": "The function to apply. It receives 3 arguments:\nthe current node instance, the node's index, and the NodeList instance",
"type": "Function"
},
{
"name": "context",
"description": "optional An optional context to execute the function from.\nDefault context is the current Node instance",
"type": "Object"
}
],
"return": {
"description": "Whether or not the function returned true for any node.",
"type": "Boolean"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 185,
"description": "Creates a documenFragment from the nodes bound to the NodeList instance",
"itemtype": "method",
"name": "toFrag",
"return": {
"description": "a Node instance bound to the documentFragment",
"type": "Node"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 194,
"description": "Returns the index of the node in the NodeList instance\nor -1 if the node isn't found.",
"itemtype": "method",
"name": "indexOf",
"params": [
{
"name": "node",
"description": "the node to search for",
"type": "Node | DOMNode"
}
],
"return": {
"description": "the index of the node value or -1 if not found",
"type": "Int"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 205,
"description": "Filters the NodeList instance down to only nodes matching the given selector.",
"itemtype": "method",
"name": "filter",
"params": [
{
"name": "selector",
"description": "The selector to filter against",
"type": "String"
}
],
"return": {
"description": "NodeList containing the updated collection",
"type": "NodeList"
},
"see": [
"Selector"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 217,
"description": "Creates a new NodeList containing all nodes at every n indices, where\nremainder n % index equals r.\n(zero-based index).",
"itemtype": "method",
"name": "modulus",
"params": [
{
"name": "n",
"description": "The offset to use (return every nth node)",
"type": "Int"
},
{
"name": "r",
"description": "An optional remainder to use with the modulus operation (defaults to zero)",
"type": "Int"
}
],
"return": {
"description": "NodeList containing the updated collection",
"type": "NodeList"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 238,
"description": "Creates a new NodeList containing all nodes at odd indices\n(zero-based index).",
"itemtype": "method",
"name": "odd",
"return": {
"description": "NodeList containing the updated collection",
"type": "NodeList"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 248,
"description": "Creates a new NodeList containing all nodes at even indices\n(zero-based index), including zero.",
"itemtype": "method",
"name": "even",
"return": {
"description": "NodeList containing the updated collection",
"type": "NodeList"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 261,
"description": "Reruns the initial query, when created using a selector query",
"itemtype": "method",
"name": "refresh",
"chainable": 1,
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 300,
"description": "Applies an event listener to each Node bound to the NodeList.",
"itemtype": "method",
"name": "on",
"params": [
{
"name": "type",
"description": "The event being listened for",
"type": "String"
},
{
"name": "fn",
"description": "The handler to call when the event fires",
"type": "Function"
},
{
"name": "context",
"description": "The context to call the handler with.\nDefault is the NodeList instance.",
"type": "Object"
},
{
"name": "context",
"description": "The context to call the handler with.\nparam {mixed} arg* 0..n additional arguments to supply to the subscriber\nwhen the event fires.",
"type": "Object"
}
],
"return": {
"description": "Returns an event handle that can later be use to detach().",
"type": "Object"
},
"see": [
"Event.on"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 317,
"description": "Applies an one-time event listener to each Node bound to the NodeList.",
"itemtype": "method",
"name": "once",
"params": [
{
"name": "type",
"description": "The event being listened for",
"type": "String"
},
{
"name": "fn",
"description": "The handler to call when the event fires",
"type": "Function"
},
{
"name": "context",
"description": "The context to call the handler with.\nDefault is the NodeList instance.",
"type": "Object"
}
],
"return": {
"description": "Returns an event handle that can later be use to detach().",
"type": "Object"
},
"see": [
"Event.on"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 331,
"description": "Applies an event listener to each Node bound to the NodeList.\nThe handler is called only after all on() handlers are called\nand the event is not prevented.",
"itemtype": "method",
"name": "after",
"params": [
{
"name": "type",
"description": "The event being listened for",
"type": "String"
},
{
"name": "fn",
"description": "The handler to call when the event fires",
"type": "Function"
},
{
"name": "context",
"description": "The context to call the handler with.\nDefault is the NodeList instance.",
"type": "Object"
}
],
"return": {
"description": "Returns an event handle that can later be use to detach().",
"type": "Object"
},
"see": [
"Event.on"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 347,
"description": "Returns the current number of items in the NodeList.",
"itemtype": "method",
"name": "size",
"return": {
"description": "The number of items in the NodeList.",
"type": "Int"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 356,
"description": "Determines if the instance is bound to any nodes",
"itemtype": "method",
"name": "isEmpty",
"return": {
"description": "Whether or not the NodeList is bound to any nodes",
"type": "Boolean"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 389,
"description": "Returns the DOM node bound to the Node instance",
"itemtype": "method",
"name": "getDOMNodes",
"return": {
"description": "",
"type": "Array"
},
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 400,
"itemtype": "method",
"name": "destroy",
"see": [
"Node.destroy"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 406,
"itemtype": "method",
"name": "empty",
"see": [
"Node.empty"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 412,
"itemtype": "method",
"name": "remove",
"see": [
"Node.remove"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 418,
"itemtype": "method",
"name": "set",
"see": [
"Node.set"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/nodelist.js",
"line": 428,
"itemtype": "method",
"name": "get",
"see": [
"Node"
],
"class": "NodeList",
"module": "node",
"submodule": "node-core"
},
{
"file": "lib/yui3/src/node/js/shim-plugin.js",
"line": 17,
"description": "Default class used to mark the shim element",
"itemtype": "property",
"name": "CLASS_NAME",
"type": "String",
"static": 1,
"default": "\"yui-node-shim\"",
"class": "Plugin.Shim",
"module": "shim-plugin"
},
{
"file": "lib/yui3/src/node/js/shim-plugin.js",
"line": 28,
"description": "Default markup template used to generate the shim element.",
"itemtype": "property",
"name": "TEMPLATE",
"type": "String",
"static": 1,
"class": "Plugin.Shim",
"module": "shim-plugin"
},
{
"file": "lib/yui3/src/node/js/shim-plugin.js",
"line": 67,
"description": "Updates the size of the shim to fill its container",
"itemtype": "method",
"name": "sync",
"class": "Plugin.Shim",
"module": "shim-plugin"
},
{
"file": "lib/yui3/src/node/js/shim-plugin.js",
"line": 83,
"description": "Removes the shim and destroys the plugin",
"itemtype": "method",
"name": "destroy",
"class": "Plugin.Shim",
"module": "shim-plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 44,
"description": "Drag coefficent for inertial scrolling. The closer to 1 this\nvalue is, the less friction during scrolling.",
"itemtype": "attribute",
"name": "deceleration",
"default": "0.98",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 55,
"description": "Drag coefficient for intertial scrolling at the upper\nand lower boundaries of the scrollview. Set to 0 to \ndisable \"rubber-banding\".",
"itemtype": "attribute",
"name": "bounce",
"type": "Number",
"default": "0.7",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 68,
"description": "The bounce distance in pixels",
"itemtype": "attribute",
"name": "bounceDistance",
"type": "Number",
"default": "150",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 79,
"description": "The minimum flick gesture velocity (px/ms) at which to trigger the flick response",
"itemtype": "attribute",
"name": "minVelocity",
"type": "Number",
"default": "0",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 90,
"description": "The minimum flick gesture distance (px) for which to trigger the flick response",
"itemtype": "attribute",
"name": "minVelocity",
"type": "Number",
"default": "10",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 101,
"description": "The constraining box relative to which the flick animation and bounds should be calculated.",
"itemtype": "attribute",
"name": "boundingBox",
"type": "Node",
"default": "parentNode",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 114,
"description": "The constraining box relative to which the flick animation and bounds should be calculated.",
"itemtype": "attribute",
"name": "boundingBox",
"type": "Node",
"default": "parentNode",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 125,
"description": "The custom duration to apply to the flick animation. By default,\nthe animation duration is controlled by the deceleration factor.",
"itemtype": "attribute",
"name": "duration",
"type": "Number",
"default": "null",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 137,
"description": "The custom transition easing to use for the flick animation. If not\nprovided defaults to internally to Flick.EASING, or Flick.SNAP_EASING based\non whether or not we're animating the flick or bounce step.",
"itemtype": "attribute",
"name": "easing",
"type": "String",
"default": "null",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 151,
"description": "The NAME of the Flick class. Used to prefix events generated\nby the plugin.",
"itemtype": "property",
"name": "NAME",
"static": 1,
"type": "String",
"default": "\"pluginFlick\"",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 162,
"description": "The namespace for the plugin. This will be the property on the node, which will \nreference the plugin instance, when it's plugged in.",
"itemtype": "property",
"name": "NS",
"static": 1,
"type": "String",
"default": "\"flick\"",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 175,
"description": "The initializer lifecycle implementation.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "The user configuration for the plugin",
"type": "Object"
}
],
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 193,
"description": "Sets the min/max boundaries for the flick animation,\nbased on the boundingBox dimensions.",
"itemtype": "method",
"name": "setBounds",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 227,
"description": "Adds the CSS classes, necessary to set up overflow/position properties on the\nnode and boundingBox.",
"itemtype": "method",
"name": "_renderClasses",
"access": "protected",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 239,
"description": "The flick event listener. Kicks off the flick animation.",
"itemtype": "method",
"name": "_onFlick",
"params": [
{
"name": "e",
"description": "The flick event facade, containing e.flick.distance, e.flick.velocity etc.",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 252,
"description": "Executes a single frame in the flick animation",
"itemtype": "method",
"name": "_flickFrame",
"access": "protected",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 335,
"description": "Internal utility method to set the X offset position",
"itemtype": "method",
"name": "_setX",
"params": [
{
"name": "val",
"description": "",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 346,
"description": "Internal utility method to set the Y offset position",
"itemtype": "method",
"name": "_setY",
"params": [
{
"name": "val",
"description": "",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 357,
"description": "Internal utility method to move the node to a given XY position,\nusing transitions, if specified.",
"itemtype": "method",
"name": "_move",
"params": [
{
"name": "x",
"description": "The X offset position",
"type": "Number"
},
{
"name": "y",
"description": "The Y offset position",
"type": "Number"
},
{
"name": "duration",
"description": "The duration to use for the transition animation",
"type": "Number"
},
{
"name": "easing",
"description": "The easing to use for the transition animation.",
"type": "String"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 392,
"description": "Internal utility method to perform the transition step",
"itemtype": "method",
"name": "_anim",
"params": [
{
"name": "x",
"description": "The X offset position",
"type": "Number"
},
{
"name": "y",
"description": "The Y offset position",
"type": "Number"
},
{
"name": "duration",
"description": "The duration to use for the transition animation",
"type": "Number"
},
{
"name": "easing",
"description": "The easing to use for the transition animation.",
"type": "String"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 424,
"description": "Internal utility method to constrain the offset value\nbased on the bounce criteria.",
"itemtype": "method",
"name": "_bounce",
"params": [
{
"name": "x",
"description": "The offset value to constrain.",
"type": "Number"
},
{
"name": "max",
"description": "The max offset value.",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 451,
"description": "Stop the animation timer",
"itemtype": "method",
"name": "_killTimer",
"access": "private",
"tagname": "",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 465,
"description": "The threshold used to determine when the decelerated velocity of the node\nis practically 0.",
"itemtype": "property",
"name": "VELOCITY_THRESHOLD",
"static": 1,
"type": "Number",
"default": "0.015",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 476,
"description": "The duration to use for the bounce snap-back transition",
"itemtype": "property",
"name": "SNAP_DURATION",
"static": 1,
"type": "Number",
"default": "400",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 486,
"description": "The default easing to use for the main flick movement transition",
"itemtype": "property",
"name": "EASING",
"static": 1,
"type": "String",
"default": "'cubic-bezier(0, 0.1, 0, 1.0)'",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 496,
"description": "The default easing to use for the bounce snap-back transition",
"itemtype": "property",
"name": "SNAP_EASING",
"static": 1,
"type": "String",
"default": "'ease-out'",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-flick/js/NodeFlick.js",
"line": 506,
"description": "The default CSS class names used by the plugin",
"itemtype": "property",
"name": "CLASS_NAMES",
"static": 1,
"type": "Object",
"class": "Plugin.Flick",
"module": "node-flick",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 83,
"description": "Boolean indicating that one of the descendants is focused.",
"itemtype": "attribute",
"name": "focused",
"readonly": "",
"default": "false",
"type": "boolean",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 99,
"description": "String representing the CSS selector used to define the descendant Nodes\nwhose focus should be managed.",
"itemtype": "attribute",
"name": "descendants",
"type": "Y.NodeList",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 117,
"description": "
Node, or index of the Node, representing the descendant that is either\nfocused or is focusable (tabIndex attribute is set to 0).\nThe value cannot represent a disabled descendant Node. Use a value of -1\nto remove all descendant Nodes from the default tab flow.\nIf no value is specified, the active descendant will be inferred using\nthe following criteria:
\n\n- Examining the
tabIndex attribute of each descendant and\nusing the first descendant whose tabIndex attribute is set\nto 0 \n- If no default can be inferred then the value is set to either 0 or\nthe index of the first enabled descendant.
\n
",
"itemtype": "attribute",
"name": "activeDescendant",
"type": "Number",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 194,
"description": "Object literal representing the keys to be used to navigate between the\nnext/previous descendant. The format for the attribute's value is\n{ next: \"down:40\", previous: \"down:38\" }. The value for the\n\"next\" and \"previous\" properties are used to attach\nkey event listeners. See\nthe Using the key Event section of\nthe Event documentation for more information on \"key\" event listeners.",
"itemtype": "attribute",
"name": "keys",
"type": "Object",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 219,
"description": "String representing the name of class applied to the focused active\ndescendant Node. Can also be an object literal used to define both the\nclass name, and the Node to which the class should be applied. If using\nan object literal, the format is:\n{ className: \"focus\", fn: myFunction }. The function\nreferenced by the fn property in the object literal will be\npassed a reference to the currently focused active descendant Node.",
"itemtype": "attribute",
"name": "focusClass",
"type": "String|Object",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 234,
"description": "Boolean indicating if focus should be set to the first/last descendant\nwhen the end or beginning of the descendants has been reached.",
"itemtype": "attribute",
"name": "circular",
"type": "Boolean",
"default": "true",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 277,
"itemtype": "method",
"name": "_initDescendants",
"description": "Sets the tabIndex attribute of all of the\ndescendants to -1, except the active descendant, whose\ntabIndex attribute is set to 0.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 388,
"itemtype": "method",
"name": "_isDescendant",
"description": "Determines if the specified Node instance is a descendant\nmanaged by the Focus Manager.",
"params": [
{
"name": "node",
"description": "Node instance to be checked.",
"type": "Node"
}
],
"return": {
"description": "Boolean indicating if the specified Node instance is a\ndescendant managed by the Focus Manager.",
"type": "Boolean"
},
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 404,
"itemtype": "method",
"name": "_removeFocusClass",
"description": "Removes the class name representing focus (as specified by\nthe \"focusClass\" attribute) from the Node instance to which it is\ncurrently applied.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 429,
"itemtype": "method",
"name": "_detachKeyHandler",
"description": "Detaches the \"key\" event handlers used to support the \"keys\"\nattribute.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 451,
"itemtype": "method",
"name": "_preventScroll",
"description": "Prevents the viewport from scolling when the user presses\nthe up, down, left, or right key.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 466,
"itemtype": "method",
"name": "_fireClick",
"description": "Fires the click event if the enter key is pressed while\nfocused on an HTML element that is not natively clickable.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 489,
"itemtype": "method",
"name": "_attachKeyHandler",
"description": "Attaches the \"key\" event handlers used to support the \"keys\"\nattribute.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 538,
"itemtype": "method",
"name": "_detachEventHandlers",
"description": "Detaches all event handlers used by the Focus Manager.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 562,
"itemtype": "method",
"name": "_detachEventHandlers",
"description": "Attaches all event handlers used by the Focus Manager.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 635,
"itemtype": "method",
"name": "_onDocMouseDown",
"description": "\"mousedown\" event handler for the owner document of the\nFocus Manager's Node.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 721,
"itemtype": "method",
"name": "_onDocFocus",
"description": "\"focus\" event handler for the owner document of the\nFocus Manager's Node.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 802,
"itemtype": "method",
"name": "_focusNext",
"description": "Keydown event handler that moves focus to the next\nenabled descendant.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
},
{
"name": "activeDescendant",
"description": "Number representing the index of the\nnext descendant to be focused",
"type": "Number"
}
],
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 849,
"itemtype": "method",
"name": "_focusPrevious",
"description": "Keydown event handler that moves focus to the previous\nenabled descendant.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
},
{
"name": "activeDescendant",
"description": "Number representing the index of the\nnext descendant to be focused.",
"type": "Number"
}
],
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 891,
"itemtype": "method",
"name": "_afterActiveDescendantChange",
"description": "afterChange event handler for the\n\"activeDescendant\" attribute.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the change event.",
"type": "Object"
}
],
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 932,
"itemtype": "method",
"name": "focus",
"description": "Focuses the active descendant and sets the\nfocused attribute to true.",
"params": [
{
"name": "index",
"description": "Optional. Number representing the index of the\ndescendant to be set as the active descendant.",
"type": "Number"
},
{
"name": "index",
"description": "Optional. Node instance representing the\ndescendant to be set as the active descendant.",
"type": "Node"
}
],
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 971,
"itemtype": "method",
"name": "blur",
"description": "Blurs the current active descendant and sets the\nfocused attribute to false.",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 1004,
"itemtype": "method",
"name": "start",
"description": "Enables the Focus Manager.",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 1022,
"itemtype": "method",
"name": "stop",
"description": "Disables the Focus Manager by detaching all event handlers.",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-focusmanager/js/node-focusmanager.js",
"line": 1042,
"itemtype": "method",
"name": "refresh",
"description": "Refreshes the Focus Manager's descendants by re-executing the\nCSS selector query specified by the descendants attribute.",
"class": "plugin.NodeFocusManager",
"module": "node-focusmanager",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 361,
"itemtype": "property",
"name": "SHIM_TEMPLATE_TITLE",
"description": "String representing the value for the title \nattribute for the shim used to prevent <select> elements \nfrom poking through menus in IE 6.",
"default": "\"Menu Stacking Shim\"",
"type": "String",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 372,
"itemtype": "property",
"name": "SHIM_TEMPLATE",
"description": "String representing the HTML used to create the \n<iframe> shim used to prevent \n<select> elements from poking through menus in IE 6.",
"default": ""<iframe frameborder="0" tabindex="-1" \nclass="yui-shim" title="Menu Stacking Shim" \nsrc="javascript:false;"></iframe>"",
"type": "String",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 406,
"description": "Boolean indicating if use of the WAI-ARIA Roles and States should be \nenabled for the menu.",
"itemtype": "attribute",
"name": "useARIA",
"readonly": "",
"writeonce": "",
"default": "true",
"type": "boolean",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 483,
"description": "Boolean indicating if submenus are automatically made visible when the \nuser mouses over the menu's items.",
"itemtype": "attribute",
"name": "autoSubmenuDisplay",
"readonly": "",
"writeonce": "",
"default": "true",
"type": "boolean",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 501,
"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is made visible when the user mouses over the menu's label.",
"itemtype": "attribute",
"name": "submenuShowDelay",
"readonly": "",
"writeonce": "",
"default": "250",
"type": "Number",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 519,
"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is hidden when the user mouses out of a menu label heading in the \ndirection of a submenu.",
"itemtype": "attribute",
"name": "submenuHideDelay",
"readonly": "",
"writeonce": "",
"default": "250",
"type": "Number",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 538,
"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is hidden when the user mouses out of it.",
"itemtype": "attribute",
"name": "mouseOutHideDelay",
"readonly": "",
"writeonce": "",
"default": "750",
"type": "Number",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 562,
"itemtype": "property",
"name": "_rootMenu",
"description": "Node instance representing the root menu in the menu.",
"default": "null",
"access": "protected",
"tagname": "",
"type": "Node",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 572,
"itemtype": "property",
"name": "_activeItem",
"description": "Node instance representing the menu's active descendent: \nthe menuitem or menu label the user is currently interacting with.",
"default": "null",
"access": "protected",
"tagname": "",
"type": "Node",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 583,
"itemtype": "property",
"name": "_activeMenu",
"description": "Node instance representing the menu that is the parent of \nthe menu's active descendent.",
"default": "null",
"access": "protected",
"tagname": "",
"type": "Node",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 594,
"itemtype": "property",
"name": "_hasFocus",
"description": "Boolean indicating if the menu has focus.",
"default": "false",
"access": "protected",
"tagname": "",
"type": "Boolean",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 612,
"itemtype": "property",
"name": "_blockMouseEvent",
"description": "Boolean indicating whether or not to handle the \n\"mouseover\" event.",
"default": "false",
"access": "protected",
"tagname": "",
"type": "Boolean",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 623,
"itemtype": "property",
"name": "_currentMouseX",
"description": "Number representing the current x coordinate of the mouse \ninside the menu.",
"default": "0",
"access": "protected",
"tagname": "",
"type": "Number",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 634,
"itemtype": "property",
"name": "_movingToSubmenu",
"description": "Boolean indicating if the mouse is moving from a menu \nlabel to its corresponding submenu.",
"default": "false",
"access": "protected",
"tagname": "",
"type": "Boolean",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 645,
"itemtype": "property",
"name": "_showSubmenuTimer",
"description": "Timer used to show a submenu.",
"default": "null",
"access": "protected",
"tagname": "",
"type": "Object",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 655,
"itemtype": "property",
"name": "_hideSubmenuTimer",
"description": "Timer used to hide a submenu.",
"default": "null",
"access": "protected",
"tagname": "",
"type": "Object",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 665,
"itemtype": "property",
"name": "_hideAllSubmenusTimer",
"description": "Timer used to hide a all submenus.",
"default": "null",
"access": "protected",
"tagname": "",
"type": "Object",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 675,
"itemtype": "property",
"name": "_firstItem",
"description": "Node instance representing the first item (menuitem or menu \nlabel) in the root menu of a menu.",
"default": "null",
"access": "protected",
"tagname": "",
"type": "Node",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 755,
"itemtype": "method",
"name": "_isRoot",
"description": "Returns a boolean indicating if the specified menu is the \nroot menu in the menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menu",
"description": "Node instance representing a menu.",
"type": "Node"
}
],
"return": {
"description": "Boolean indicating if the specified menu is the root \nmenu in the menu.",
"type": "Boolean"
},
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 771,
"itemtype": "method",
"name": "_getTopmostSubmenu",
"description": "Returns the topmost submenu of a submenu hierarchy.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menu",
"description": "Node instance representing a menu.",
"type": "Node"
}
],
"return": {
"description": "Node instance representing a menu.",
"type": "Node"
},
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 800,
"itemtype": "method",
"name": "_clearActiveItem",
"description": "Clears the menu's active descendent.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 819,
"itemtype": "method",
"name": "_setActiveItem",
"description": "Sets the specified menuitem or menu label as the menu's \nactive descendent.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "item",
"description": "Node instance representing a menuitem or menu label.",
"type": "Node"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 843,
"itemtype": "method",
"name": "_focusItem",
"description": "Focuses the specified menuitem or menu label.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "item",
"description": "Node instance representing a menuitem or menu label.",
"type": "Node"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 872,
"itemtype": "method",
"name": "_showMenu",
"description": "Shows the specified menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menu",
"description": "Node instance representing a menu.",
"type": "Node"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 932,
"itemtype": "method",
"name": "_hideMenu",
"description": "Hides the specified menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menu",
"description": "Node instance representing a menu.",
"type": "Node"
},
{
"name": "activateAndFocusLabel",
"description": "Boolean indicating if the label \nfor the specified \nmenu should be focused and set as active.",
"type": "Boolean"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 976,
"itemtype": "method",
"name": "_hideAllSubmenus",
"description": "Hides all submenus of the specified menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menu",
"description": "Node instance representing a menu.",
"type": "Node"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 995,
"itemtype": "method",
"name": "_cancelShowSubmenuTimer",
"description": "Cancels the timer used to show a submenu.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1013,
"itemtype": "method",
"name": "_cancelHideSubmenuTimer",
"description": "Cancels the timer used to hide a submenu.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1032,
"itemtype": "method",
"name": "_initFocusManager",
"description": "Initializes and updates the Focus Manager so that is is \nalways managing descendants of the active menu.",
"access": "protected",
"tagname": "",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1104,
"itemtype": "method",
"name": "_onActiveDescendantChange",
"description": "\"activeDescendantChange\" event handler for menu's \nFocus Manager.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the Attribute change event.",
"type": "Object"
},
{
"name": "menuNav",
"description": "Object representing the NodeMenuNav instance.",
"type": "NodeMenuNav"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1124,
"itemtype": "method",
"name": "_afterActiveDescendantChange",
"description": "\"activeDescendantChange\" event handler for menu's \nFocus Manager.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the Attribute change event.",
"type": "Object"
},
{
"name": "menuNav",
"description": "Object representing the NodeMenuNav instance.",
"type": "NodeMenuNav"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1144,
"itemtype": "method",
"name": "_onDocFocus",
"description": "\"focus\" event handler for the owner document of the MenuNav.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1215,
"itemtype": "method",
"name": "_onMenuMouseOver",
"description": "\"mouseover\" event handler for a menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menu",
"description": "Node instance representing a menu.",
"type": "Node"
},
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1254,
"itemtype": "method",
"name": "_hideAndFocusLabel",
"description": "Hides all of the submenus of the root menu and focuses the \nlabel of the topmost submenu",
"access": "protected",
"tagname": "",
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1279,
"itemtype": "method",
"name": "_onMenuMouseOut",
"description": "\"mouseout\" event handler for a menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menu",
"description": "Node instance representing a menu.",
"type": "Node"
},
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1334,
"itemtype": "method",
"name": "_onMenuLabelMouseOver",
"description": "\"mouseover\" event handler for a menu label.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menuLabel",
"description": "Node instance representing a menu label.",
"type": "Node"
},
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1402,
"itemtype": "method",
"name": "_onMenuLabelMouseOut",
"description": "\"mouseout\" event handler for a menu label.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menuLabel",
"description": "Node instance representing a menu label.",
"type": "Node"
},
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1461,
"itemtype": "method",
"name": "_onMenuItemMouseOver",
"description": "\"mouseover\" event handler for a menuitem.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menuItem",
"description": "Node instance representing a menuitem.",
"type": "Node"
},
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1490,
"itemtype": "method",
"name": "_onMenuItemMouseOut",
"description": "\"mouseout\" event handler for a menuitem.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "menuItem",
"description": "Node instance representing a menuitem.",
"type": "Node"
},
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1504,
"itemtype": "method",
"name": "_onVerticalMenuKeyDown",
"description": "\"keydown\" event handler for vertical menus.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1650,
"itemtype": "method",
"name": "_onHorizontalMenuKeyDown",
"description": "\"keydown\" event handler for horizontal menus.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1704,
"itemtype": "method",
"name": "_onMouseMove",
"description": "\"mousemove\" event handler for the menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1727,
"itemtype": "method",
"name": "_onMouseOver",
"description": "\"mouseover\" event handler for the menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1795,
"itemtype": "method",
"name": "_onMouseOut",
"description": "\"mouseout\" event handler for the menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 1871,
"itemtype": "method",
"name": "_toggleSubmenuDisplay",
"description": "\"mousedown,\" \"keydown,\" and \"click\" event handler for the \nmenu used to toggle the display of a submenu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 2039,
"itemtype": "method",
"name": "_onKeyPress",
"description": "\"keypress\" event handler for the menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 2065,
"itemtype": "method",
"name": "_onKeyDown",
"description": "\"keydown\" event handler for the menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/node-menunav/js/node-menunav.js",
"line": 2143,
"itemtype": "method",
"name": "_onDocMouseDown",
"description": "\"mousedown\" event handler for the owner document of \nthe menu.",
"access": "protected",
"tagname": "",
"params": [
{
"name": "event",
"description": "Object representing the DOM event.",
"type": "Object"
}
],
"class": "plugin.NodeMenuNav",
"module": "node-menunav",
"namespace": "plugin"
},
{
"file": "lib/yui3/src/oop/js/oop.js",
"line": 31,
"description": "Augments the _receiver_ with prototype properties from the _supplier_. The\nreceiver may be a constructor function or an object. The supplier must be a\nconstructor function.\n\nIf the _receiver_ is an object, then the _supplier_ constructor will be called\nimmediately after _receiver_ is augmented, with _receiver_ as the `this` object.\n\nIf the _receiver_ is a constructor function, then all prototype methods of\n_supplier_ that are copied to _receiver_ will be sequestered, and the\n_supplier_ constructor will not be called immediately. The first time any\nsequestered method is called on the _receiver_'s prototype, all sequestered\nmethods will be immediately copied to the _receiver_'s prototype, the\n_supplier_'s constructor will be executed, and finally the newly unsequestered\nmethod that was called will be executed.\n\nThis sequestering logic sounds like a bunch of complicated voodoo, but it makes\nit cheap to perform frequent augmentation by ensuring that suppliers'\nconstructors are only called if a supplied method is actually used. If none of\nthe supplied methods is ever used, then there's no need to take the performance\nhit of calling the _supplier_'s constructor.",
"itemtype": "method",
"name": "augment",
"params": [
{
"name": "receiver",
"description": "Object or function to be augmented.",
"type": "Function|Object"
},
{
"name": "supplier",
"description": "Function that supplies the prototype properties with\n which to augment the _receiver_.",
"type": "Function"
},
{
"name": "overwrite",
"description": "If `true`, properties already on the receiver\n will be overwritten if found on the supplier's prototype.",
"type": "Boolean",
"optional": true,
"optdefault": "false"
},
{
"name": "whitelist",
"description": "An array of property names. If specified,\n only the whitelisted prototype properties will be applied to the receiver, and\n all others will be ignored.",
"type": "String[]",
"optional": true
},
{
"name": "args",
"description": "Argument or array of arguments to pass to the\n supplier's constructor when initializing.",
"type": "Array|any",
"optional": true
}
],
"return": {
"description": "Augmented object.",
"type": "Function"
},
"class": "YUI",
"module": "oop"
},
{
"file": "lib/yui3/src/oop/js/oop.js",
"line": 137,
"description": "Applies object properties from the supplier to the receiver. If\nthe target has the property, and the property is an object, the target\nobject will be augmented with the supplier's value. If the property\nis an array, the suppliers value will be appended to the target.",
"itemtype": "method",
"name": "aggregate",
"params": [
{
"name": "r",
"description": "the object to receive the augmentation.",
"type": "Function"
},
{
"name": "s",
"description": "the object that supplies the properties to augment.",
"type": "Function"
},
{
"name": "ov",
"description": "if true, properties already on the receiver\nwill be overwritten if found on the supplier.",
"type": "Boolean"
},
{
"name": "wl",
"description": "a whitelist. If supplied, only properties in\nthis list will be applied to the receiver.",
"type": "String[]"
}
],
"return": {
"description": "the extended object.",
"type": "Object"
},
"class": "YUI",
"module": "oop"
},
{
"file": "lib/yui3/src/oop/js/oop.js",
"line": 155,
"description": "Utility to set up the prototype, constructor and superclass properties to\nsupport an inheritance strategy that can chain constructors and methods.\nStatic members will not be inherited.",
"itemtype": "method",
"name": "extend",
"params": [
{
"name": "r",
"description": "the object to modify.",
"type": "Function"
},
{
"name": "s",
"description": "the object to inherit.",
"type": "Function"
},
{
"name": "px",
"description": "prototype properties to add/override.",
"type": "Object"
},
{
"name": "sx",
"description": "static properties to add/override.",
"type": "Object"
}
],
"return": {
"description": "the extended object.",
"type": "Object"
},
"class": "YUI",
"module": "oop"
},
{
"file": "lib/yui3/src/oop/js/oop.js",
"line": 196,
"description": "Executes the supplied function for each item in\na collection. Supports arrays, objects, and\nNodeLists",
"itemtype": "method",
"name": "each",
"params": [
{
"name": "o",
"description": "the object to iterate.",
"type": "Object"
},
{
"name": "f",
"description": "the function to execute. This function\nreceives the value, key, and object as parameters.",
"type": "Function"
},
{
"name": "c",
"description": "the execution context for the function.",
"type": "Object"
},
{
"name": "proto",
"description": "if true, prototype properties are\niterated on objects.",
"type": "Boolean"
}
],
"return": {
"description": "the YUI instance.",
"type": "YUI"
},
"class": "YUI",
"module": "oop"
},
{
"file": "lib/yui3/src/oop/js/oop.js",
"line": 213,
"description": "Executes the supplied function for each item in\na collection. The operation stops if the function\nreturns true. Supports arrays, objects, and\nNodeLists.",
"itemtype": "method",
"name": "some",
"params": [
{
"name": "o",
"description": "the object to iterate.",
"type": "Object"
},
{
"name": "f",
"description": "the function to execute. This function\nreceives the value, key, and object as parameters.",
"type": "Function"
},
{
"name": "c",
"description": "the execution context for the function.",
"type": "Object"
},
{
"name": "proto",
"description": "if true, prototype properties are\niterated on objects.",
"type": "Boolean"
}
],
"return": {
"description": "true if the function ever returns true,\nfalse otherwise.",
"type": "Boolean"
},
"class": "YUI",
"module": "oop"
},
{
"file": "lib/yui3/src/oop/js/oop.js",
"line": 232,
"description": "Deep object/array copy. Function clones are actually\nwrappers around the original function.\nArray-like objects are treated as arrays.\nPrimitives are returned untouched. Optionally, a\nfunction can be provided to handle other data types,\nfilter keys, validate values, etc.",
"itemtype": "method",
"name": "clone",
"params": [
{
"name": "o",
"description": "what to clone.",
"type": "Object"
},
{
"name": "safe",
"description": "if true, objects will not have prototype\nitems from the source. If false, they will. In this case, the\noriginal is initially protected, but the clone is not completely\nimmune from changes to the source object prototype. Also, cloned\nprototype items that are deleted from the clone will result\nin the value of the source prototype being exposed. If operating\non a non-safe clone, items should be nulled out rather than deleted.",
"type": "Boolean"
},
{
"name": "f",
"description": "optional function to apply to each item in a\ncollection; it will be executed prior to applying the value to\nthe new object. Return false to prevent the copy.",
"type": "Function"
},
{
"name": "c",
"description": "optional execution context for f.",
"type": "Object"
},
{
"name": "owner",
"description": "Owner object passed when clone is iterating\nan object. Used to set up context for cloned functions.",
"type": "Object"
},
{
"name": "cloned",
"description": "hash of previously cloned objects to avoid\nmultiple clones.",
"type": "Object"
}
],
"return": {
"description": "the cloned object.",
"type": "Array|Object"
},
"class": "YUI",
"module": "oop"
},
{
"file": "lib/yui3/src/oop/js/oop.js",
"line": 337,
"description": "Returns a function that will execute the supplied function in the\nsupplied object's context, optionally adding any additional\nsupplied parameters to the beginning of the arguments collection the\nsupplied to the function.",
"itemtype": "method",
"name": "bind",
"params": [
{
"name": "f",
"description": "the function to bind, or a function name\nto execute on the context object.",
"type": "Function|String"
},
{
"name": "c",
"description": "the execution context.",
"type": "Object"
},
{
"name": "args",
"description": "0..n arguments to include before the arguments the\nfunction is executed with.",
"type": "Any",
"multiple": true
}
],
"return": {
"description": "the wrapped function.",
"type": "Function"
},
"class": "YUI",
"module": "oop"
},
{
"file": "lib/yui3/src/oop/js/oop.js",
"line": 362,
"description": "Returns a function that will execute the supplied function in the\nsupplied object's context, optionally adding any additional\nsupplied parameters to the end of the arguments the function\nis executed with.",
"itemtype": "method",
"name": "rbind",
"params": [
{
"name": "f",
"description": "the function to bind, or a function name\nto execute on the context object.",
"type": "Function|String"
},
{
"name": "c",
"description": "the execution context.",
"type": "Object"
},
{
"name": "args",
"description": "0..n arguments to append to the end of\narguments collection supplied to the function.",
"type": "Any",
"multiple": true
}
],
"return": {
"description": "the wrapped function.",
"type": "Function"
},
"class": "YUI",
"module": "oop"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 22,
"description": "Object defining the set of attributes supported by the Plugin.Base class",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 31,
"description": "The plugin's host object.",
"itemtype": "attribute",
"name": "host",
"writeonce": "",
"type": "Plugin.Host",
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 43,
"description": "The string identifying the Plugin.Base class. Plugins extending\nPlugin.Base should set their own NAME value.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 53,
"description": "The name of the property the the plugin will be attached to\nwhen plugged into a Plugin Host. Plugins extending Plugin.Base,\nshould set their own NS value.",
"itemtype": "property",
"name": "NS",
"type": "String",
"static": 1,
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 66,
"description": "The list of event handles for event listeners or AOP injected methods\napplied by the plugin to the host object.",
"itemtype": "property",
"name": "_handles",
"access": "private",
"tagname": "",
"type": "Array",
"value": "null",
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 77,
"description": "Initializer lifecycle implementation.",
"itemtype": "method",
"name": "initializer",
"params": [
{
"name": "config",
"description": "Configuration object with property name/value pairs.",
"type": "Object"
}
],
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 89,
"description": "Destructor lifecycle implementation.\n\nRemoves any event listeners or injected methods applied by the Plugin",
"itemtype": "method",
"name": "destructor",
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 105,
"description": "Listens for the \"on\" moment of events fired by the host, \nor injects code \"before\" a given method on the host.",
"itemtype": "method",
"name": "doBefore",
"params": [
{
"name": "strMethod",
"description": "The event to listen for, or method to inject logic before.",
"type": "String"
},
{
"name": "fn",
"description": "The handler function. For events, the \"on\" moment listener. For methods, the function to execute before the given method is executed.",
"type": "Function"
},
{
"name": "context",
"description": "An optional context to call the handler with. The default context is the plugin instance.",
"type": "Object"
}
],
"return": {
"description": "handle The detach handle for the handler.",
"type": "EventHandle"
},
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 128,
"description": "Listens for the \"after\" moment of events fired by the host, \nor injects code \"after\" a given method on the host.",
"itemtype": "method",
"name": "doAfter",
"params": [
{
"name": "strMethod",
"description": "The event to listen for, or method to inject logic after.",
"type": "String"
},
{
"name": "fn",
"description": "The handler function. For events, the \"after\" moment listener. For methods, the function to execute after the given method is executed.",
"type": "Function"
},
{
"name": "context",
"description": "An optional context to call the handler with. The default context is the plugin instance.",
"type": "Object"
}
],
"return": {
"description": "handle The detach handle for the listener.",
"type": "EventHandle"
},
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 151,
"description": "Listens for the \"on\" moment of events fired by the host object.\n\nListeners attached through this method will be detached when the plugin is unplugged.",
"itemtype": "method",
"name": "onHostEvent",
"params": [
{
"name": "type",
"description": "The event type.",
"type": "String | Object"
},
{
"name": "fn",
"description": "The listener.",
"type": "Function"
},
{
"name": "context",
"description": "The execution context. Defaults to the plugin instance.",
"type": "Object"
}
],
"return": {
"description": "handle The detach handle for the listener.",
"type": "EventHandle"
},
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 168,
"description": "Listens for the \"after\" moment of events fired by the host object.\n\nListeners attached through this method will be detached when the plugin is unplugged.",
"itemtype": "method",
"name": "afterHostEvent",
"params": [
{
"name": "type",
"description": "The event type.",
"type": "String | Object"
},
{
"name": "fn",
"description": "The listener.",
"type": "Function"
},
{
"name": "context",
"description": "The execution context. Defaults to the plugin instance.",
"type": "Object"
}
],
"return": {
"description": "handle The detach handle for the listener.",
"type": "EventHandle"
},
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 185,
"description": "Injects a function to be executed before a given method on host object.\n\nThe function will be detached when the plugin is unplugged.",
"itemtype": "method",
"name": "beforeHostMethod",
"params": [
{
"name": "method",
"description": "The name of the method to inject the function before.",
"type": "String"
},
{
"name": "fn",
"description": "The function to inject.",
"type": "Function"
},
{
"name": "context",
"description": "The execution context. Defaults to the plugin instance.",
"type": "Object"
}
],
"return": {
"description": "handle The detach handle for the injected function.",
"type": "EventHandle"
},
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/plugin/js/plugin.js",
"line": 202,
"description": "Injects a function to be executed after a given method on host object.\n\nThe function will be detached when the plugin is unplugged.",
"itemtype": "method",
"name": "afterHostMethod",
"params": [
{
"name": "method",
"description": "The name of the method to inject the function after.",
"type": "String"
},
{
"name": "fn",
"description": "The function to inject.",
"type": "Function"
},
{
"name": "context",
"description": "The execution context. Defaults to the plugin instance.",
"type": "Object"
}
],
"return": {
"description": "handle The detach handle for the injected function.",
"type": "EventHandle"
},
"class": "Plugin.Base",
"module": "plugin"
},
{
"file": "lib/yui3/src/pluginhost/js/PluginHost.js",
"line": 42,
"description": "Adds a plugin to the host object. This will instantiate the \nplugin and attach it to the configured namespace on the host object.",
"itemtype": "method",
"name": "plug",
"chainable": 1,
"params": [
{
"name": "P",
"description": "Accepts the plugin class, or an \nobject with a \"fn\" property specifying the plugin class and \na \"cfg\" property specifying the configuration for the Plugin.\n\nAdditionally an Array can also be passed in, with the above function or \nobject values, allowing the user to add multiple plugins in a single call.\n
",
"type": "Function | Object |Array"
},
{
"name": "config",
"description": "(Optional) If the first argument is the plugin class, the second argument\ncan be the configuration for the plugin."
}
],
"return": {
"description": "A reference to the host object",
"type": "Base"
},
"class": "Plugin.Host",
"module": "pluginhost-base"
},
{
"file": "lib/yui3/src/pluginhost/js/PluginHost.js",
"line": 93,
"description": "Removes a plugin from the host object. This will destroy the \nplugin instance and delete the namepsace from the host object.",
"itemtype": "method",
"name": "unplug",
"params": [
{
"name": "plugin",
"description": "The namespace of the plugin, or the plugin class with the static NS namespace property defined. If not provided,\nall registered plugins are unplugged.",
"type": "String | Function"
}
],
"return": {
"description": "A reference to the host object",
"type": "Base"
},
"chainable": 1,
"class": "Plugin.Host",
"module": "pluginhost-base"
},
{
"file": "lib/yui3/src/pluginhost/js/PluginHost.js",
"line": 134,
"description": "Determines if a plugin has plugged into this host.",
"itemtype": "method",
"name": "hasPlugin",
"params": [
{
"name": "ns",
"description": "The plugin's namespace",
"type": "String"
}
],
"return": {
"description": "returns true, if the plugin has been plugged into this host, false otherwise.",
"type": "Boolean"
},
"class": "Plugin.Host",
"module": "pluginhost-base"
},
{
"file": "lib/yui3/src/pluginhost/js/PluginHost.js",
"line": 145,
"description": "Initializes static plugins registered on the host (using the\nBase.plug static method) and any plugins passed to the \ninstance through the \"plugins\" configuration property.",
"itemtype": "method",
"name": "_initPlugins",
"params": [
{
"name": "config",
"description": "The configuration object with property name/value pairs.",
"type": "Config"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Host",
"module": "pluginhost-base"
},
{
"file": "lib/yui3/src/pluginhost/js/PluginHost.js",
"line": 163,
"description": "Unplugs and destroys all plugins on the host",
"itemtype": "method",
"name": "_destroyPlugins",
"access": "private",
"tagname": "",
"class": "Plugin.Host",
"module": "pluginhost-base"
},
{
"file": "lib/yui3/src/pluginhost/js/PluginHostConfig.js",
"line": 9,
"description": "A protected initialization method, used by the host class to initialize\nplugin configurations passed the constructor, through the config object.\n\nHost objects should invoke this method at the appropriate time in their\nconstruction lifecycle.",
"itemtype": "method",
"name": "_initConfigPlugins",
"params": [
{
"name": "config",
"description": "The configuration object passed to the constructor",
"type": "Object"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.Host",
"module": "pluginhost-base",
"submodule": "pluginhost-config"
},
{
"file": "lib/yui3/src/pluginhost/js/PluginHostConfig.js",
"line": 60,
"description": "Registers plugins to be instantiated at the class level (plugins \nwhich should be plugged into every instance of the class by default).",
"itemtype": "method",
"name": "plug",
"static": 1,
"params": [
{
"name": "hostClass",
"description": "The host class on which to register the plugins",
"type": "Function"
},
{
"name": "plugin",
"description": "Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)",
"type": "Function | Array"
},
{
"name": "config",
"description": "(Optional) If plugin is the plugin class, the configuration for the plugin",
"type": "Object"
}
],
"class": "Plugin.Host",
"module": "pluginhost-base",
"submodule": "pluginhost-config"
},
{
"file": "lib/yui3/src/pluginhost/js/PluginHostConfig.js",
"line": 94,
"description": "Unregisters any class level plugins which have been registered by the host class, or any\nother class in the hierarchy.",
"itemtype": "method",
"name": "unplug",
"static": 1,
"params": [
{
"name": "hostClass",
"description": "The host class from which to unregister the plugins",
"type": "Function"
},
{
"name": "plugin",
"description": "The plugin class, or an array of plugin classes",
"type": "Function | Array"
}
],
"class": "Plugin.Host",
"module": "pluginhost-base",
"submodule": "pluginhost-config"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 93,
"description": "Removes all report data from the profiler.",
"params": [
{
"name": "name",
"description": "(Optional) The name of the report to clear. If\n omitted, then all report data is cleared.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "clear",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 111,
"description": "Returns the uninstrumented version of a function/object.",
"params": [
{
"name": "name",
"description": "The name of the function/object to retrieve.",
"type": "String"
}
],
"return": {
"description": "The uninstrumented version of a function/object.",
"type": "Function|Object"
},
"itemtype": "method",
"name": "getOriginal",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 122,
"description": "Instruments a method to have profiling calls.",
"params": [
{
"name": "name",
"description": "The name of the report for the function.",
"type": "String"
},
{
"name": "method",
"description": "The function to instrument.",
"type": "Function"
}
],
"return": {
"description": "An instrumented version of the function.",
"type": "Function"
},
"itemtype": "method",
"name": "instrument",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 167,
"description": "Pauses profiling information for a given name.",
"params": [
{
"name": "name",
"description": "The name of the data point.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "pause",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 186,
"description": "Start profiling information for a given name. The name cannot be the name\nof a registered function or object. This is used to start timing for a\nparticular block of code rather than instrumenting the entire function.",
"params": [
{
"name": "name",
"description": "The name of the data point.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "start",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 222,
"description": "Stops profiling information for a given name.",
"params": [
{
"name": "name",
"description": "The name of the data point.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "stop",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 251,
"description": "Returns the average amount of time (in milliseconds) that the function\nwith the given name takes to execute.",
"params": [
{
"name": "name",
"description": "The name of the function whose data should be returned.\n If an object type method, it should be 'constructor.prototype.methodName';\n a normal object method would just be 'object.methodName'.",
"type": "String"
}
],
"return": {
"description": "The average time it takes the function to execute.",
"type": "Float"
},
"itemtype": "method",
"name": "getAverage",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 265,
"description": "Returns the number of times that the given function has been called.",
"params": [
{
"name": "name",
"description": "The name of the function whose data should be returned.",
"type": "String"
}
],
"return": {
"description": "The number of times the function was called.",
"type": "Int"
},
"itemtype": "method",
"name": "getCallCount",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 276,
"description": "Returns the maximum amount of time (in milliseconds) that the function\nwith the given name takes to execute.",
"params": [
{
"name": "name",
"description": "The name of the function whose data should be returned.\n If an object type method, it should be 'constructor.prototype.methodName';\n a normal object method would just be 'object.methodName'.",
"type": "String"
}
],
"return": {
"description": "The maximum time it takes the function to execute.",
"type": "Float"
},
"itemtype": "method",
"name": "getMax",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 290,
"description": "Returns the minimum amount of time (in milliseconds) that the function\nwith the given name takes to execute.",
"params": [
{
"name": "name",
"description": "The name of the function whose data should be returned.\n If an object type method, it should be 'constructor.prototype.methodName';\n a normal object method would just be 'object.methodName'.",
"type": "String"
}
],
"return": {
"description": "The minimum time it takes the function to execute.",
"type": "Float"
},
"itemtype": "method",
"name": "getMin",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 304,
"description": "Returns an object containing profiling data for a single function.\nThe object has an entry for min, max, avg, calls, and points).",
"return": {
"description": "An object containing profile data for a given function.",
"type": "Object"
},
"itemtype": "method",
"name": "getFunctionReport",
"static": 1,
"deprecated": true,
"deprecationMessage": "Use getReport() instead.",
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 316,
"description": "Returns an object containing profiling data for a single function.\nThe object has an entry for min, max, avg, calls, and points).",
"return": {
"description": "An object containing profile data for a given function.",
"type": "Object"
},
"itemtype": "method",
"name": "getReport",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 327,
"description": "Returns an object containing profiling data for all of the functions \nthat were profiled. The object has an entry for each function and \nreturns all information (min, max, average, calls, etc.) for each\nfunction.",
"return": {
"description": "An object containing all profile data.",
"type": "Object"
},
"itemtype": "method",
"name": "getFullReport",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 356,
"description": "Sets up a constructor for profiling, including all properties and methods on the prototype.",
"params": [
{
"name": "name",
"description": "The fully-qualified name of the function including namespace information.",
"type": "String"
},
{
"name": "owner",
"description": "(Optional) The object that owns the function (namespace or containing object).",
"type": "Object"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "registerConstructor",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 368,
"description": "Sets up a function for profiling. It essentially overwrites the function with one\nthat has instrumentation data. This method also creates an entry for the function\nin the profile report. The original function is stored on the container object.",
"params": [
{
"name": "name",
"description": "The full name of the function including namespacing. This\n is the name of the function that is stored in the report.",
"type": "String"
},
{
"name": "owner",
"description": "(Optional) The object that owns the function. If the function\n isn't global then this argument is required. This could be the namespace that\n the function belongs to or the object on which it's\n a method.",
"type": "Object"
},
{
"name": "registerPrototype",
"description": "(Optional) Indicates that the prototype should\n also be instrumented. Setting to true has the same effect as calling\n registerConstructor().",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "registerFunction",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 426,
"description": "Sets up an object for profiling. It takes the object and looks for functions.\nWhen a function is found, registerMethod() is called on it. If set to recrusive\nmode, it will also setup objects found inside of this object for profiling, \nusing the same methodology.",
"params": [
{
"name": "name",
"description": "The name of the object to profile (shows up in report).",
"type": "String"
},
{
"name": "owner",
"description": "(Optional) The object represented by the name.",
"type": "Object"
},
{
"name": "recurse",
"description": "(Optional) Determines if subobject methods are also profiled.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "registerObject",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 458,
"description": "Removes a constructor function from profiling. Reverses the registerConstructor() method.",
"params": [
{
"name": "name",
"description": "The full name of the function including namespacing. This\n is the name of the function that is stored in the report.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "unregisterFunction",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 474,
"description": "Removes function from profiling. Reverses the registerFunction() method.",
"params": [
{
"name": "name",
"description": "The full name of the function including namespacing. This\n is the name of the function that is stored in the report.",
"type": "String"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "unregisterFunction",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/profiler/js/Profiler.js",
"line": 510,
"description": "Unregisters an object for profiling. It takes the object and looks for functions.\nWhen a function is found, unregisterMethod() is called on it. If set to recrusive\nmode, it will also unregister objects found inside of this object, \nusing the same methodology.",
"params": [
{
"name": "name",
"description": "The name of the object to unregister.",
"type": "String"
},
{
"name": "recurse",
"description": "(Optional) Determines if subobject methods should also be\n unregistered.",
"type": "Boolean"
}
],
"return": {
"description": "",
"type": "Void"
},
"itemtype": "method",
"name": "unregisterObject",
"static": 1,
"class": "Profiler",
"module": "profiler"
},
{
"file": "lib/yui3/src/querystring/js/querystring-stringify.js",
"line": 27,
"description": "Converts an arbitrary value to a Query String representation.
\n\nObjects with cyclical references will trigger an exception.
",
"itemtype": "method",
"name": "stringify",
"access": "public",
"tagname": "",
"params": [
{
"name": "obj",
"description": "any arbitrary value to convert to query string",
"type": "Variant"
},
{
"name": "cfg",
"description": "(optional) Configuration object. The three\nsupported configurations are:\n- sep: When defined, the value will be used as the key-value\nseparator. The default value is \"&\".
\n- eq: When defined, the value will be used to join the key to\nthe value. The default value is \"=\".
\n- arrayKey: When set to true, the key of an array will have the\n'[]' notation appended to the key. The default value is false.\n
",
"type": "Object"
},
{
"name": "name",
"description": "(optional) Name of the current key, for handling children recursively.",
"type": "String"
}
],
"static": 1,
"class": "QueryString",
"module": "querystring",
"submodule": "querystring-stringify"
},
{
"file": "lib/yui3/src/queue-promote/js/queue-promote.js",
"line": 9,
"description": "Returns the current index in the queue of the specified item",
"itemtype": "method",
"name": "indexOf",
"params": [
{
"name": "needle",
"description": "the item to search for",
"type": "MIXED"
}
],
"return": {
"description": "the index of the item or -1 if not found",
"type": "Number"
},
"class": "Queue",
"module": "queue-promote"
},
{
"file": "lib/yui3/src/queue-promote/js/queue-promote.js",
"line": 20,
"description": "Moves the referenced item to the head of the queue",
"itemtype": "method",
"name": "promote",
"params": [
{
"name": "item",
"description": "an item in the queue",
"type": "MIXED"
}
],
"class": "Queue",
"module": "queue-promote"
},
{
"file": "lib/yui3/src/queue-promote/js/queue-promote.js",
"line": 34,
"description": "Removes the referenced item from the queue",
"itemtype": "method",
"name": "remove",
"params": [
{
"name": "item",
"description": "an item in the queue",
"type": "MIXED"
}
],
"class": "Queue",
"module": "queue-promote"
},
{
"file": "lib/yui3/src/recordset/js/record.js",
"line": 17,
"description": "Retrieve a particular (or all) values from the object",
"params": [
{
"name": "field",
"description": "(optional) The key to retrieve the value from. If not supplied, the entire object is returned.",
"type": "String"
}
],
"itemtype": "method",
"name": "getValue",
"access": "public",
"tagname": "",
"class": "Record",
"module": "queue-promote"
},
{
"file": "lib/yui3/src/recordset/js/record.js",
"line": 37,
"description": "Unique ID of the record instance",
"itemtype": "attribute",
"name": "id",
"type": "string",
"class": "Record",
"module": "queue-promote"
},
{
"file": "lib/yui3/src/recordset/js/record.js",
"line": 46,
"description": "The object stored within the record instance",
"itemtype": "attribute",
"name": "data",
"type": "object",
"class": "Record",
"module": "queue-promote"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 29,
"description": "Publish default functions for events. Create the initial hash table.",
"itemtype": "method",
"name": "initializer",
"access": "protected",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 45,
"description": "At least one record is being added. Additional properties of\nthe event are:
\n\n - added
\n - Array of new records to be added
\n - index
\n - The insertion index in the Recordset's internal\n array
\n
\n\nPreventing this event will cause the new records NOT to be\nadded to the Recordset's internal collection.
",
"itemtype": "event",
"name": "add",
"preventable": "_defAddFn",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 64,
"description": "At least one record is being removed. Additional properties of\nthe event are:
\n\n - removed
\n - Array of records to be removed
\n - range
\n - Number of records to be removed
\n - index
\n - The starting index in the Recordset's internal\n array from which to remove records
\n
\n\nPreventing this event will cause the records NOT to be\nremoved from the Recordset's internal collection.
",
"itemtype": "event",
"name": "remove",
"preventable": "_defRemoveFn",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 85,
"description": "The Recordset is being flushed of all records.",
"itemtype": "event",
"name": "empty",
"preventable": "_defEmptyFn",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 93,
"description": "At least one record is being updated. Additional properties of\nthe event are:
\n\n - updated
\n - Array of records with updated values
\n - overwritten
\n - Array of current records that will be replaced
\n - index
\n - The starting index in the Recordset's internal\n array from which to update will apply
\n
\n\nPreventing this event will cause the records NOT to be\nupdated in the Recordset's internal collection.
",
"itemtype": "event",
"name": "update",
"preventable": "_defUpdateFn",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 125,
"description": "Returns the record with particular ID or index",
"itemtype": "method",
"name": "getRecord",
"params": [
{
"name": "i",
"description": "The ID of the record if a string, or the index if a number.",
"type": "String, Number"
}
],
"return": {
"description": "A Y.Record instance",
"type": "Record"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 144,
"description": "Returns the record at a particular index",
"itemtype": "method",
"name": "getRecordByIndex",
"params": [
{
"name": "i",
"description": "Index at which the required record resides",
"type": "Number"
}
],
"return": {
"description": "A Y.Record instance",
"type": "Record"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 155,
"description": "Returns a range of records beginning at particular index",
"itemtype": "method",
"name": "getRecordsByIndex",
"params": [
{
"name": "index",
"description": "Index at which the required record resides",
"type": "Number"
},
{
"name": "range",
"description": "(Optional) Number of records to retrieve. The default is 1",
"type": "Number"
}
],
"return": {
"description": "An array of Y.Record instances",
"type": "Array"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 175,
"description": "Returns the length of the recordset",
"itemtype": "method",
"name": "getLength",
"return": {
"description": "Number of records in the recordset",
"type": "Number"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 185,
"description": "Gets an array of values for a data _key_ in the set's records. If no _key_\nis supplied, the returned array will contain the full data object for each\nrecord.",
"itemtype": "method",
"name": "getValuesByKey",
"params": [
{
"name": "key",
"description": "Data property to get from all records",
"type": "String",
"optional": true
}
],
"return": {
"description": "An array of values for the given _key_ if supplied.\n Otherwise, an array of each record's data hash.",
"type": "Array"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 206,
"description": "Adds one or more Records to the RecordSet at the given index. If index is null, then adds the Records to the end of the RecordSet.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "oData",
"description": "A Y.Record instance, An object literal of data or an array of object literals",
"type": "Record|Object|Array"
},
{
"name": "index",
"description": "[index] Index at which to add the record(s)",
"type": "Number",
"optional": true
}
],
"return": {
"description": "The updated recordset instance",
"type": "Recordset"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 238,
"description": "Removes one or more Records to the RecordSet at the given index. If index\nis null, then removes a single Record from the end of the RecordSet.",
"itemtype": "method",
"name": "remove",
"params": [
{
"name": "index",
"description": "Index at which to remove the record(s) from",
"type": "Number",
"optional": true
},
{
"name": "range",
"description": "Number of records to remove (including the one\n at the index)",
"type": "Number",
"optional": true
}
],
"return": {
"description": "The updated recordset instance",
"type": "Recordset"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 266,
"description": "Empties the recordset",
"itemtype": "method",
"name": "empty",
"return": {
"description": "The updated recordset instance",
"type": "Recordset"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 277,
"description": "Updates the recordset with the new records passed in. Overwrites existing\nrecords when updating the index with the new records.",
"itemtype": "method",
"name": "update",
"params": [
{
"name": "data",
"description": "A Y.Record instance, An object literal of\n data or an array of object literals",
"type": "Record|Object|Array"
},
{
"name": "index",
"description": "The index to start updating from.",
"type": "Number",
"optional": true
}
],
"return": {
"description": "The updated recordset instance",
"type": "Recordset"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 310,
"description": "Default behavior for the \"add\" event. Adds Record instances starting from\nthe index specified in `e.index`.",
"itemtype": "method",
"name": "_defAddFn",
"params": [
{
"name": "e",
"description": "The add event",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 322,
"description": "Default behavior for the \"remove\" event. Removes Records from the\ninternal array starting from `e.index`. By default, it will remove one\nRecord. But if `e.range` is set, it will remove that many Records.",
"itemtype": "method",
"name": "_defRemoveFn",
"params": [
{
"name": "e",
"description": "The remove event",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 335,
"description": "Default behavior for the \"update\" event. Sets Record instances for each\nitem in `e.updated` at indexes starting from `e.index`.",
"itemtype": "method",
"name": "_defUpdateFn",
"params": [
{
"name": "e",
"description": "The update event",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 349,
"description": "Default behavior for the \"empty\" event. Clears the internal array of\nRecords.",
"itemtype": "method",
"name": "_defEmptyFn",
"params": [
{
"name": "e",
"description": "The empty event",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 362,
"description": "Updates the internal hash table.",
"itemtype": "method",
"name": "_defUpdateHash",
"params": [
{
"name": "e",
"description": "Event triggering the hash table update",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 386,
"description": "Regenerates the hash table from the current internal array of Records.",
"itemtype": "method",
"name": "_hashRecordsChange",
"params": [
{
"name": "hash",
"description": "The hash map before replacement",
"type": "Object"
},
{
"name": "key",
"description": "The key by which to add items to the hash",
"type": "String"
},
{
"name": "e",
"description": "The event or object containing the items to be added.\n Items are expected to be stored in an array assigned to\n the `added` property.",
"type": "Object"
}
],
"return": {
"description": "The updated hash map",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 402,
"description": "Builds a hash table from the current internal array of Records.",
"itemtype": "method",
"name": "_buildHashTable",
"params": [
{
"name": "key",
"description": "The Record key to hash the items by",
"type": "String"
}
],
"return": {
"description": "A new hash map of Records keyed by each Records' key",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 414,
"description": "Adds items to the hash table. Items are the values, and the keys are the\nvalues of the item's attribute named in the `key` parameter.",
"itemtype": "method",
"name": "_hashAdd",
"params": [
{
"name": "hash",
"description": "The hash map before adding items",
"type": "Object"
},
{
"name": "key",
"description": "The key by which to add the items to the hash",
"type": "String"
},
{
"name": "e",
"description": "The event or object containing the items to be added.\n Items are expected to be stored in an array assigned to\n the `added` property.",
"type": "Object"
}
],
"return": {
"description": "The updated hash map",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 438,
"description": "Removes items from the hash table.",
"itemtype": "method",
"name": "_hashRemove",
"params": [
{
"name": "hash",
"description": "The hash map before removing items",
"type": "Object"
},
{
"name": "key",
"description": "The key by which to remove the items from the hash",
"type": "String"
},
{
"name": "e",
"description": "The event or object containing the items to be removed.\n Items are expected to be stored in an array assigned to\n the `removed` property.",
"type": "Object"
}
],
"return": {
"description": "The updated hash map",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 458,
"description": "Updates items in the hash table.",
"itemtype": "method",
"name": "_hashUpdate",
"params": [
{
"name": "hash",
"description": "The hash map before updating items",
"type": "Object"
},
{
"name": "key",
"description": "The key by which to update the items to the hash",
"type": "String"
},
{
"name": "e",
"description": "The event or object containing the items to be updated.\n Items are expected to be stored in an array assigned to\n the `updated` property. Optionally, items can be\n identified for being overwritten by including them in an\n array assigned to the `overwritten` property.",
"type": "Object"
}
],
"return": {
"description": "The updated hash map",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 480,
"description": "Clears the hash table.",
"itemtype": "method",
"name": "_hashEmpty",
"params": [
{
"name": "hash",
"description": "The hash map before adding items",
"type": "Object"
},
{
"name": "key",
"description": "The key by which to remove the items from the hash",
"type": "String"
},
{
"name": "e",
"description": "The event or object containing the items to be removed.\n Items are expected to be stored in an array assigned to\n the `removed` property.",
"type": "Object"
}
],
"return": {
"description": "An empty hash",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 496,
"description": "Sets up the hashtable with all the records currently in the recordset",
"itemtype": "method",
"name": "_initHashTable",
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 506,
"description": "Helper method - it takes an object bag and converts it to a Y.Record",
"itemtype": "method",
"name": "_changeToRecord",
"params": [
{
"name": "obj",
"description": "Any objet literal or Y.Record instance",
"type": "Object|Record"
}
],
"return": {
"description": "A Record instance.",
"type": "Record"
},
"access": "private",
"tagname": "",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 518,
"description": "Ensures the value being set is an array of Record instances. If array items\nare raw object data, they are turned into Records.",
"itemtype": "method",
"name": "_setRecords",
"params": [
{
"name": "items",
"description": "The Records or data Objects to store as\n Records.",
"type": "Record[]|Object[]"
}
],
"return": {
"description": "",
"type": "Record[]"
},
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 545,
"description": "An array of Records that the Recordset is storing. Passing an array\nof raw record data is also accepted. The data for each item will be\nwrapped in a Record instance.",
"itemtype": "attribute",
"name": "records",
"type": "{Record[]}",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 563,
"description": "A hash table where the ID of the record is the key, and the record\ninstance is the value.",
"itemtype": "attribute",
"name": "table",
"type": "object",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-base.js",
"line": 574,
"description": "The ID to use as the key in the hash table.",
"itemtype": "attribute",
"name": "key",
"type": "string",
"class": "Recordset",
"module": "recordset",
"submodule": "recordset-base"
},
{
"file": "lib/yui3/src/recordset/js/recordset-filter.js",
"line": 36,
"description": "Filter through the recordset with a custom filter function, or a key-value\npair.",
"itemtype": "method",
"name": "filter",
"params": [
{
"name": "filter",
"description": "A custom filter function or a string\n representing the key to filter by.",
"type": "Function|String"
},
{
"name": "value",
"description": "If filtering by key (_filter_ is a string), further\n filter by a specific value.",
"type": "Any",
"optional": true
}
],
"return": {
"description": "A new filtered Recordset instance",
"type": "Recordset"
},
"class": "RecordsetFilter",
"module": "recordset",
"submodule": "recordset-filter"
},
{
"file": "lib/yui3/src/recordset/js/recordset-filter.js",
"line": 65,
"description": "The inverse of filter. Executes the supplied function on each item. Returns\na new Recordset containing the items that the supplied function returned\n`false` for.",
"itemtype": "method",
"name": "reject",
"params": [
{
"name": "filter",
"description": "A boolean function, executed on each item.",
"type": "Function"
}
],
"return": {
"description": "A new Recordset instance containing the items on which\n the supplied function returned false.",
"type": "Recordset"
},
"class": "RecordsetFilter",
"module": "recordset",
"submodule": "recordset-filter"
},
{
"file": "lib/yui3/src/recordset/js/recordset-filter.js",
"line": 81,
"description": "Iterates over the Recordset, returning a new Recordset of all the elements\nthat match the supplied regular expression",
"itemtype": "method",
"name": "grep",
"params": [
{
"name": "pattern",
"description": "The regular expression to test against each record.",
"type": "RegExp"
}
],
"return": {
"description": "A Recordset instance containing all the items in the\n collection that produce a match against the supplied regular\n expression. If no items match, an empty Recordset instance is returned.",
"type": "Recordset"
},
"class": "RecordsetFilter",
"module": "recordset",
"submodule": "recordset-filter"
},
{
"file": "lib/yui3/src/recordset/js/recordset-indexer.js",
"line": 21,
"description": "Collection of all the hashTables created by the plugin. \nThe individual tables can be accessed by the key they are hashing against.",
"itemtype": "attribute",
"name": "hashTables",
"access": "public",
"tagname": "",
"type": "object",
"class": "RecordsetIndexer",
"module": "recordset",
"submodule": "recordset-indexer"
},
{
"file": "lib/yui3/src/recordset/js/recordset-indexer.js",
"line": 62,
"description": "Setup the hash table for a given key with all existing records in the recordset",
"itemtype": "method",
"name": "_setHashTable",
"params": [
{
"name": "key",
"description": "A key to hash by.",
"type": "String"
}
],
"return": {
"description": "obj The created hash table",
"type": "Object"
},
"access": "private",
"tagname": "",
"class": "RecordsetIndexer",
"module": "recordset",
"submodule": "recordset-indexer"
},
{
"file": "lib/yui3/src/recordset/js/recordset-indexer.js",
"line": 86,
"description": "Updates all hash tables when a record is added to the recordset",
"itemtype": "method",
"name": "_defAddHash",
"access": "private",
"tagname": "",
"class": "RecordsetIndexer",
"module": "recordset",
"submodule": "recordset-indexer"
},
{
"file": "lib/yui3/src/recordset/js/recordset-indexer.js",
"line": 111,
"description": "Updates all hash tables when a record is removed from the recordset",
"itemtype": "method",
"name": "_defRemoveHash",
"access": "private",
"tagname": "",
"class": "RecordsetIndexer",
"module": "recordset",
"submodule": "recordset-indexer"
},
{
"file": "lib/yui3/src/recordset/js/recordset-indexer.js",
"line": 137,
"description": "Updates all hash tables when the recordset is updated (a combination of add and remove)",
"itemtype": "method",
"name": "_defUpdateHash",
"access": "private",
"tagname": "",
"class": "RecordsetIndexer",
"module": "recordset",
"submodule": "recordset-indexer"
},
{
"file": "lib/yui3/src/recordset/js/recordset-indexer.js",
"line": 187,
"description": "Creates a new hash table.",
"itemtype": "method",
"name": "createTable",
"params": [
{
"name": "key",
"description": "A key to hash by.",
"type": "String"
}
],
"return": {
"description": "tbls[key] The created hash table",
"type": "Object"
},
"access": "public",
"tagname": "",
"class": "RecordsetIndexer",
"module": "recordset",
"submodule": "recordset-indexer"
},
{
"file": "lib/yui3/src/recordset/js/recordset-indexer.js",
"line": 204,
"description": "Get a hash table that hashes records by a given key.",
"itemtype": "method",
"name": "getTable",
"params": [
{
"name": "key",
"description": "A key to hash by.",
"type": "String"
}
],
"return": {
"description": "table The created hash table",
"type": "Object"
},
"access": "public",
"tagname": "",
"class": "RecordsetIndexer",
"module": "recordset",
"submodule": "recordset-indexer"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 26,
"description": "The last properties used to sort. Consists of an object literal with the keys \"field\", \"desc\", and \"sorter\"",
"itemtype": "attribute",
"name": "lastSortProperties",
"access": "public",
"tagname": "",
"type": "object",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 44,
"description": "Default sort function to use if none is specified by the user.\nTakes two records, the key to sort by, and whether sorting direction is descending or not (boolean).\nIf two records have the same value for a given key, the ID is used as the tie-breaker.",
"itemtype": "attribute",
"name": "defaultSorter",
"access": "public",
"tagname": "",
"type": "function",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 65,
"description": "A boolean telling if the recordset is in a sorted state.",
"itemtype": "attribute",
"name": "defaultSorter",
"access": "public",
"tagname": "",
"type": "function",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 80,
"description": "Sets up the default function to use when the \"sort\" event is fired.",
"itemtype": "method",
"name": "initializer",
"access": "protected",
"tagname": "",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 119,
"description": "Method that all sort calls go through. \nSets up the lastSortProperties object with the details of the sort, and passes in parameters \nto the \"defaultSorter\" or a custom specified sort function.",
"itemtype": "method",
"name": "_defSortFn",
"access": "private",
"tagname": "",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 136,
"description": "Sorts the recordset.",
"itemtype": "method",
"name": "sort",
"params": [
{
"name": "field",
"description": "A key to sort by.",
"type": "String"
},
{
"name": "desc",
"description": "True if you want sort order to be descending, false if you want sort order to be ascending",
"type": "Boolean"
}
],
"access": "public",
"tagname": "",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 152,
"description": "Resorts the recordset based on the last-used sort parameters (stored in 'lastSortProperties' ATTR)",
"itemtype": "method",
"name": "resort",
"access": "public",
"tagname": "",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 167,
"description": "Reverses the recordset calling the standard array.reverse() method.",
"itemtype": "method",
"name": "reverse",
"access": "public",
"tagname": "",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/recordset/js/recordset-sort.js",
"line": 177,
"description": "Sorts the recordset based on the last-used sort parameters, but flips the order. (ie: Descending becomes ascending, and vice versa).",
"itemtype": "method",
"name": "flip",
"access": "public",
"tagname": "",
"class": "RecordsetSort",
"module": "recordset",
"submodule": "recordset-sort"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 168,
"description": "Static property provides a string to identify the class.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"static": 1,
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 177,
"description": "Static property used to define the default attribute\nconfiguration for the Resize.",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 186,
"description": "Stores the active handle during the resize.",
"itemtype": "attribute",
"name": "activeHandle",
"default": "null",
"access": "private",
"tagname": "",
"type": "String",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 201,
"description": "Stores the active handle element during the resize.",
"itemtype": "attribute",
"name": "activeHandleNode",
"default": "null",
"access": "private",
"tagname": "",
"type": "Node",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 214,
"description": "False to ensure that the resize handles are always visible, true to\ndisplay them only when the user mouses over the resizable borders.",
"itemtype": "attribute",
"name": "autoHide",
"default": "false",
"type": "boolean",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 227,
"description": "The default minimum height of the element. Only used when\nResizeConstrained is not plugged.",
"itemtype": "attribute",
"name": "defMinHeight",
"default": "15",
"type": "Number",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 240,
"description": "The default minimum width of the element. Only used when\nResizeConstrained is not plugged.",
"itemtype": "attribute",
"name": "defMinWidth",
"default": "15",
"type": "Number",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 253,
"description": "The handles to use (any combination of): 't', 'b', 'r', 'l', 'bl',\n'br', 'tl', 'tr'. Can use a shortcut of All.",
"itemtype": "attribute",
"name": "handles",
"default": "all",
"type": "Array | String",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 266,
"description": "Node to wrap the resize handles.",
"itemtype": "attribute",
"name": "handlesWrapper",
"type": "Node",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 278,
"description": "The selector or element to resize. Required.",
"itemtype": "attribute",
"name": "node",
"type": "Node",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 288,
"description": "True when the element is being Resized.",
"itemtype": "attribute",
"name": "resizing",
"default": "false",
"type": "boolean",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 300,
"description": "True to wrap an element with a div if needed (required for textareas\nand images, defaults to false) in favor of the handles config option.\nThe wrapper element type (default div) could be over-riden passing the\nwrapper attribute.",
"itemtype": "attribute",
"name": "wrap",
"default": "false",
"type": "boolean",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 316,
"description": "Elements that requires a wrapper by default. Normally are elements\nwhich cannot have children elements.",
"itemtype": "attribute",
"name": "wrapTypes",
"default": "/canvas|textarea|input|select|button|img/i",
"readonly": "",
"type": "Regex",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 330,
"description": "Element to wrap the wrapTypes. This element will house\nthe handles elements.",
"itemtype": "attribute",
"name": "wrapper",
"default": "div",
"type": "String | Node",
"writeonce": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 405,
"description": "Array containing all possible resizable handles.",
"itemtype": "property",
"name": "ALL_HANDLES",
"type": "{String}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 413,
"description": "Regex which matches with the handles that could change the height of\nthe resizable element.",
"itemtype": "property",
"name": "REGEX_CHANGE_HEIGHT",
"type": "{String}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 422,
"description": "Regex which matches with the handles that could change the left of\nthe resizable element.",
"itemtype": "property",
"name": "REGEX_CHANGE_LEFT",
"type": "{String}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 431,
"description": "Regex which matches with the handles that could change the top of\nthe resizable element.",
"itemtype": "property",
"name": "REGEX_CHANGE_TOP",
"type": "{String}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 440,
"description": "Regex which matches with the handles that could change the width of\nthe resizable element.",
"itemtype": "property",
"name": "REGEX_CHANGE_WIDTH",
"type": "{String}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 449,
"description": "Template used to create the resize wrapper for the handles.",
"itemtype": "property",
"name": "HANDLES_WRAP_TEMPLATE",
"type": "{String}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 457,
"description": "Template used to create the resize wrapper node when needed.",
"itemtype": "property",
"name": "WRAP_TEMPLATE",
"type": "{String}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 465,
"description": "Template used to create each resize handle.",
"itemtype": "property",
"name": "HANDLE_TEMPLATE",
"type": "{String}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 476,
"description": "Each box has a content area and optional surrounding padding and\nborder areas. This property stores the sum of all horizontal\nsurrounding * information needed to adjust the node height.",
"itemtype": "property",
"name": "totalHSurrounding",
"default": "0",
"type": "number",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 487,
"description": "Each box has a content area and optional surrounding padding and\nborder areas. This property stores the sum of all vertical\nsurrounding * information needed to adjust the node height.",
"itemtype": "property",
"name": "totalVSurrounding",
"default": "0",
"type": "number",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 498,
"description": "Stores the node\nsurrounding information retrieved from\n_getBoxSurroundingInfo.",
"itemtype": "property",
"name": "nodeSurrounding",
"type": "Object",
"default": "null",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 509,
"description": "Stores the wrapper\nsurrounding information retrieved from\n_getBoxSurroundingInfo.",
"itemtype": "property",
"name": "wrapperSurrounding",
"type": "Object",
"default": "null",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 520,
"description": "Whether the handle being dragged can change the height.",
"itemtype": "property",
"name": "changeHeightHandles",
"default": "false",
"type": "boolean",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 529,
"description": "Whether the handle being dragged can change the left.",
"itemtype": "property",
"name": "changeLeftHandles",
"default": "false",
"type": "boolean",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 538,
"description": "Whether the handle being dragged can change the top.",
"itemtype": "property",
"name": "changeTopHandles",
"default": "false",
"type": "boolean",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 547,
"description": "Whether the handle being dragged can change the width.",
"itemtype": "property",
"name": "changeWidthHandles",
"default": "false",
"type": "boolean",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 556,
"description": "Store DD.Delegate reference for the respective Resize instance.",
"itemtype": "property",
"name": "delegate",
"default": "null",
"type": "Object",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 565,
"description": "Stores the current values for the height, width, top and left. You are\nable to manipulate these values on resize in order to change the resize\nbehavior.",
"itemtype": "property",
"name": "info",
"type": "Object",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 576,
"description": "Stores the last values for the height, width, top and left.",
"itemtype": "property",
"name": "lastInfo",
"type": "Object",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 585,
"description": "Stores the original values for the height, width, top and left, stored\non resize start.",
"itemtype": "property",
"name": "originalInfo",
"type": "Object",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 595,
"description": "Construction logic executed during Resize instantiation. Lifecycle.",
"itemtype": "method",
"name": "initializer",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 605,
"description": "Create the DOM structure for the Resize. Lifecycle.",
"itemtype": "method",
"name": "renderUI",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 617,
"description": "Bind the events on the Resize UI. Lifecycle.",
"itemtype": "method",
"name": "bindUI",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 631,
"description": "Sync the Resize UI.",
"itemtype": "method",
"name": "syncUI",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 648,
"description": "Descructor lifecycle implementation for the Resize class. Purges events attached\nto the node (and all child nodes) and removes the Resize handles.",
"itemtype": "method",
"name": "destructor",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 687,
"description": "Creates DOM (or manipulates DOM for progressive enhancement)\nThis method is invoked by initializer(). It's chained automatically for\nsubclasses if required.",
"itemtype": "method",
"name": "renderer",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 701,
"description": "Loop through each handle which is being used and executes a callback.
\nExample:
\ninstance.eachHandle(\n function(handleName, index) { ... }\n );
",
"itemtype": "method",
"name": "eachHandle",
"params": [
{
"name": "fn",
"description": "Callback function to be executed for each handle.",
"type": "Function"
}
],
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 726,
"description": "Bind the handles DragDrop events to the Resize instance.",
"itemtype": "method",
"name": "_bindDD",
"access": "private",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 756,
"description": "Bind the events related to the handles (_onHandleMouseEnter, _onHandleMouseLeave).",
"itemtype": "method",
"name": "_bindHandle",
"access": "private",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 772,
"description": "Create the custom events used on the Resize.",
"itemtype": "method",
"name": "_createEvents",
"access": "private",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 791,
"description": "Handles the resize start event. Fired when a handle starts to be\ndragged.",
"itemtype": "event",
"name": "resize:start",
"preventable": "_defResizeStartFn",
"params": [
{
"name": "event",
"description": "The resize start event.",
"type": "Event.Facade"
}
],
"bubbles": "Resize",
"type": "{Event.Custom}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 803,
"description": "Handles the resize event. Fired on each pixel when the handle is\nbeing dragged.",
"itemtype": "event",
"name": "resize:resize",
"preventable": "_defResizeFn",
"params": [
{
"name": "event",
"description": "The resize event.",
"type": "Event.Facade"
}
],
"bubbles": "Resize",
"type": "{Event.Custom}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 815,
"description": "Handles the resize align event.",
"itemtype": "event",
"name": "resize:align",
"preventable": "_defResizeAlignFn",
"params": [
{
"name": "event",
"description": "The resize align event.",
"type": "Event.Facade"
}
],
"bubbles": "Resize",
"type": "{Event.Custom}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 826,
"description": "Handles the resize end event. Fired when a handle stop to be\ndragged.",
"itemtype": "event",
"name": "resize:end",
"preventable": "_defResizeEndFn",
"params": [
{
"name": "event",
"description": "The resize end event.",
"type": "Event.Facade"
}
],
"bubbles": "Resize",
"type": "{Event.Custom}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 838,
"description": "Handles the resize mouseUp event. Fired when a mouseUp event happens on a\nhandle.",
"itemtype": "event",
"name": "resize:mouseUp",
"preventable": "_defMouseUpFn",
"params": [
{
"name": "event",
"description": "The resize mouseUp event.",
"type": "Event.Facade"
}
],
"bubbles": "Resize",
"type": "{Event.Custom}",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 851,
"description": "Responsible for loop each handle element and append to the wrapper.",
"itemtype": "method",
"name": "_renderHandles",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 869,
"description": "Creates the handle element based on the handle name and initialize the\nDragDrop on it.",
"itemtype": "method",
"name": "_buildHandle",
"params": [
{
"name": "handle",
"description": "Handle name ('t', 'tr', 'b', ...).",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 887,
"description": "Basic resize calculations.",
"itemtype": "method",
"name": "_calcResize",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 910,
"description": "Helper method to update the current size value on\ninfo to respect the\nmin/max values and fix the top/left calculations.",
"itemtype": "method",
"name": "_checkSize",
"params": [
{
"name": "offset",
"description": "'offsetHeight' or 'offsetWidth'",
"type": "String"
},
{
"name": "size",
"description": "Size to restrict the offset",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 938,
"description": "Copy relevant styles of the node\nto the wrapper.",
"itemtype": "method",
"name": "_copyStyles",
"params": [
{
"name": "node",
"description": "Node from.",
"type": "Node"
},
{
"name": "wrapper",
"description": "Node to.",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 993,
"description": "Generates metadata to the info\nand originalInfo
\nbottom, actXY, left, top, offsetHeight, offsetWidth, right
",
"itemtype": "method",
"name": "_getInfo",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
},
{
"name": "event",
"description": "",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1028,
"description": "Each box has a content area and optional surrounding margin,\npadding and * border areas. This method get all this information from\nthe passed node. For more reference see\n\nhttp://www.w3.org/TR/CSS21/box.html#box-dimensions.",
"itemtype": "method",
"name": "_getBoxSurroundingInfo",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
}
],
"access": "private",
"tagname": "",
"return": {
"description": "",
"type": "Object"
},
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1071,
"description": "Sync the Resize UI with internal values from\ninfo.",
"itemtype": "method",
"name": "_syncUI",
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1106,
"description": "Update instance.changeHeightHandles,\ninstance.changeLeftHandles, instance.changeTopHandles,\ninstance.changeWidthHandles information.",
"itemtype": "method",
"name": "_updateChangeHandleInfo",
"access": "private",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1123,
"description": "Update info values (bottom, actXY, left, top, offsetHeight, offsetWidth, right).",
"itemtype": "method",
"name": "_updateInfo",
"access": "private",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1135,
"description": "Update properties\nnodeSurrounding,\nwrapperSurrounding,\ntotalVSurrounding,\ntotalHSurrounding.",
"itemtype": "method",
"name": "_updateSurroundingInfo",
"access": "private",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1159,
"description": "Set the active state of the handles.",
"itemtype": "method",
"name": "_setActiveHandlesUI",
"params": [
{
"name": "val",
"description": "True to activate the handles, false to deactivate.",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1187,
"description": "Setter for the handles attribute",
"itemtype": "method",
"name": "_setHandles",
"access": "protected",
"tagname": "",
"params": [
{
"name": "val",
"description": "",
"type": "String"
}
],
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1226,
"description": "Set the visibility of the handles.",
"itemtype": "method",
"name": "_setHideHandlesUI",
"params": [
{
"name": "val",
"description": "True to hide the handles, false to show.",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1247,
"description": "Setter for the wrap attribute",
"itemtype": "method",
"name": "_setWrap",
"access": "protected",
"tagname": "",
"params": [
{
"name": "val",
"description": "",
"type": "Boolean"
}
],
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1268,
"description": "Default resize:mouseUp handler",
"itemtype": "method",
"name": "_defMouseUpFn",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1281,
"description": "Default resize:resize handler",
"itemtype": "method",
"name": "_defResizeFn",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1294,
"description": "Logic method for _defResizeFn. Allow AOP.",
"itemtype": "method",
"name": "_resize",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1310,
"description": "Default resize:align handler",
"itemtype": "method",
"name": "_defResizeAlignFn",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1323,
"description": "Logic method for _defResizeAlignFn. Allow AOP.",
"itemtype": "method",
"name": "_resizeAlign",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1361,
"description": "Default resize:end handler",
"itemtype": "method",
"name": "_defResizeEndFn",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1374,
"description": "Logic method for _defResizeEndFn. Allow AOP.",
"itemtype": "method",
"name": "_resizeEnd",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1399,
"description": "Default resize:start handler",
"itemtype": "method",
"name": "_defResizeStartFn",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1412,
"description": "Logic method for _defResizeStartFn. Allow AOP.",
"itemtype": "method",
"name": "_resizeStart",
"params": [
{
"name": "event",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1435,
"description": "Fires the resize:mouseUp event.",
"itemtype": "method",
"name": "_handleMouseUpEvent",
"params": [
{
"name": "event",
"description": "resize:mouseUp event facade",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1446,
"description": "Fires the resize:resize event.",
"itemtype": "method",
"name": "_handleResizeEvent",
"params": [
{
"name": "event",
"description": "resize:resize event facade",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1457,
"description": "Fires the resize:align event.",
"itemtype": "method",
"name": "_handleResizeAlignEvent",
"params": [
{
"name": "event",
"description": "resize:resize event facade",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1468,
"description": "Fires the resize:end event.",
"itemtype": "method",
"name": "_handleResizeEndEvent",
"params": [
{
"name": "event",
"description": "resize:end event facade",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1479,
"description": "Fires the resize:start event.",
"itemtype": "method",
"name": "_handleResizeStartEvent",
"params": [
{
"name": "event",
"description": "resize:start event facade",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1494,
"description": "Mouseenter event handler for the wrapper.",
"itemtype": "method",
"name": "_onWrapperMouseEnter",
"params": [
{
"name": "event",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1509,
"description": "Mouseleave event handler for the wrapper.",
"itemtype": "method",
"name": "_onWrapperMouseLeave",
"params": [
{
"name": "event",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1524,
"description": "Handles setting the activeHandle from a node, used from startDrag (for touch) and mouseenter (for mouse).",
"itemtype": "method",
"name": "_setHandleFromNode",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1544,
"description": "Mouseenter event handler for the handles.",
"itemtype": "method",
"name": "_onHandleMouseEnter",
"params": [
{
"name": "event",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1555,
"description": "Mouseout event handler for the handles.",
"itemtype": "method",
"name": "_onHandleMouseLeave",
"params": [
{
"name": "event",
"description": "",
"type": "EventFacade"
}
],
"access": "protected",
"tagname": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1570,
"description": "Default value for the wrapper handles node attribute",
"itemtype": "method",
"name": "_valueHandlesWrapper",
"access": "protected",
"tagname": "",
"readonly": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-base.js",
"line": 1581,
"description": "Default value for the wrapper attribute",
"itemtype": "method",
"name": "_valueWrapper",
"access": "protected",
"tagname": "",
"readonly": "",
"class": "Resize",
"module": "resize"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 64,
"description": "Will attempt to constrain the resize node to the boundaries. Arguments:
\n'view': Contrain to Viewport
\n'#selector_string': Constrain to this node
\n'{Region Object}': An Object Literal containing a valid region (top, right, bottom, left) of page positions",
"itemtype": "attribute",
"name": "constrain",
"type": "{String|Object|Node}",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 83,
"description": "The minimum height of the element",
"itemtype": "attribute",
"name": "minHeight",
"default": "15",
"type": "Number",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 95,
"description": "The minimum width of the element",
"itemtype": "attribute",
"name": "minWidth",
"default": "15",
"type": "Number",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 107,
"description": "The maximum height of the element",
"itemtype": "attribute",
"name": "maxHeight",
"default": "Infinity",
"type": "Number",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 119,
"description": "The maximum width of the element",
"itemtype": "attribute",
"name": "maxWidth",
"default": "Infinity",
"type": "Number",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 131,
"description": "Maintain the element's ratio when resizing.",
"itemtype": "attribute",
"name": "preserveRatio",
"default": "false",
"type": "boolean",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 143,
"description": "The number of x ticks to span the resize to.",
"itemtype": "attribute",
"name": "tickX",
"default": "false",
"type": "Number | false",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 154,
"description": "The number of y ticks to span the resize to.",
"itemtype": "attribute",
"name": "tickY",
"default": "false",
"type": "Number | false",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 168,
"description": "Stores the constrain\nsurrounding information retrieved from\n_getBoxSurroundingInfo.",
"itemtype": "property",
"name": "constrainSurrounding",
"type": "Object",
"default": "null",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 195,
"description": "Helper method to update the current values on\ninfo to respect the\nconstrain node.",
"itemtype": "method",
"name": "_checkConstrain",
"params": [
{
"name": "axis",
"description": "'top' or 'left'",
"type": "String"
},
{
"name": "axisConstrain",
"description": "'bottom' or 'right'",
"type": "String"
},
{
"name": "offset",
"description": "'offsetHeight' or 'offsetWidth'",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 235,
"description": "Update the current values on info\nto respect the maxHeight and minHeight.",
"itemtype": "method",
"name": "_checkHeight",
"access": "protected",
"tagname": "",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 260,
"description": "Update the current values on info\ncalculating the correct ratio for the other values.",
"itemtype": "method",
"name": "_checkRatio",
"access": "protected",
"tagname": "",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 350,
"description": "Check whether the resizable node is inside the constrain region.",
"itemtype": "method",
"name": "_checkRegion",
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Boolean"
},
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 365,
"description": "Update the current values on info\nto respect the maxWidth and minWidth.",
"itemtype": "method",
"name": "_checkWidth",
"access": "protected",
"tagname": "",
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-constrain.js",
"line": 390,
"description": "Get the constrain region based on the constrain\nattribute.",
"itemtype": "method",
"name": "_getConstrainRegion",
"access": "protected",
"tagname": "",
"return": {
"description": "",
"type": "Object Region"
},
"class": "Plugin.ResizeConstrained",
"module": "resize",
"submodule": "resize-contrain",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 37,
"itemtype": "property",
"name": "NAME",
"description": "resize-plugin",
"type": "{String}",
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 44,
"itemtype": "property",
"name": "NS",
"description": "The Resize instance will be placed on the Node instance under the resize namespace. It can be accessed via Node.resize or Widget.resize;",
"type": "{String}",
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 51,
"description": "Static property used to define the default attribute\nconfiguration for the Resize plugin.",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 61,
"description": "Stores the node that is being resized",
"itemtype": "attribute",
"name": "node",
"default": "undefined",
"access": "public",
"tagname": "",
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 72,
"description": "Stores the widget that the node belongs to, if one exists",
"itemtype": "attribute",
"name": "widget",
"default": "undefined",
"access": "public",
"tagname": "",
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 87,
"description": "Stores the values for node and widget, and sets up an event-listener",
"itemtype": "method",
"name": "initializer",
"access": "protected",
"tagname": "",
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 103,
"description": "Updates the node's (x,y) values if they are changed via resizing.\nIf the node belongs to a widget, passes the widget down to _setWidgetProperties method",
"itemtype": "method",
"name": "_correctDimensions",
"params": [
{
"name": "e",
"description": "The Event object",
"type": "EventFacade"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 140,
"description": "If the host is a widget, then set the width, height. Then look for widgetPosition and set x,y",
"itemtype": "method",
"name": "_setWidgetProperties",
"params": [
{
"name": "e",
"description": "The Event object",
"type": "EventFacade"
},
{
"name": "x",
"description": "Literal containing old x value and current x value",
"type": "Object"
},
{
"name": "y",
"description": "Literal containing old y value and current y value",
"type": "Object"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-plugin.js",
"line": 183,
"description": "a little utility method that returns a value if the old !== new, otherwise it returns false.",
"itemtype": "method",
"name": "_isDifferent",
"params": [
{
"name": "oldVal",
"description": "",
"type": "Number"
},
{
"name": "newVal",
"description": "",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "Plugin.Resize",
"module": "resize",
"submodule": "resize-plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-proxy.js",
"line": 46,
"description": "The Resize proxy element.",
"itemtype": "attribute",
"name": "proxyNode",
"default": "Generated using an internal HTML markup",
"type": "String|Node",
"class": "Plugin.ResizeProxy",
"module": "resize",
"submodule": "resize-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-proxy.js",
"line": 63,
"description": "Template used to create the resize proxy.",
"itemtype": "property",
"name": "PROXY_TEMPLATE",
"type": "{String}",
"class": "Plugin.ResizeProxy",
"module": "resize",
"submodule": "resize-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-proxy.js",
"line": 116,
"description": "Render the proxyNode element and\nmake it sibling of the node.",
"itemtype": "method",
"name": "_renderProxy",
"access": "protected",
"tagname": "",
"class": "Plugin.ResizeProxy",
"module": "resize",
"submodule": "resize-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/resize/js/resize-proxy.js",
"line": 135,
"description": "Sync the proxy UI with internal values from\ninfo.",
"itemtype": "method",
"name": "_syncProxyUI",
"access": "protected",
"tagname": "",
"class": "Plugin.ResizeProxy",
"module": "resize",
"submodule": "resize-proxy",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/list-plugin.js",
"line": 29,
"description": "The identity of the plugin",
"itemtype": "property",
"name": "NAME",
"type": "String",
"default": "'pluginList'",
"static": 1,
"class": "Plugin.ScrollViewList",
"module": "scrollview-list",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/list-plugin.js",
"line": 39,
"description": "The namespace on which the plugin will reside.",
"itemtype": "property",
"name": "NS",
"type": "String",
"default": "'list'",
"static": 1,
"class": "Plugin.ScrollViewList",
"module": "scrollview-list",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/list-plugin.js",
"line": 50,
"description": "The default attribute configuration for the plugin",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Plugin.ScrollViewList",
"module": "scrollview-list",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/list-plugin.js",
"line": 59,
"description": "Specifies whether the list elements (the immediate 's and the immediate - 's inside those
's) have class names attached to them or not",
"itemtype": "attribute",
"name": "isAttached",
"type": "boolean",
"deprecated": true,
"deprecationMessage": "No real use for this attribute on the public API",
"class": "Plugin.ScrollViewList",
"module": "scrollview-list",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/list-plugin.js",
"line": 74,
"description": "Designated initializer",
"itemtype": "method",
"name": "initializer",
"class": "Plugin.ScrollViewList",
"module": "scrollview-list",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 27,
"description": "The identity of the plugin",
"itemtype": "property",
"name": "NAME",
"type": "String",
"default": "'paginatorPlugin'",
"static": 1,
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 37,
"description": "The namespace on which the plugin will reside",
"itemtype": "property",
"name": "NS",
"type": "String",
"default": "'pages'",
"static": 1,
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 47,
"description": "The default attribute configuration for the plugin",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 56,
"description": "CSS selector for a page inside the scrollview. The scrollview\nwill snap to the closest page.",
"itemtype": "attribute",
"name": "selector",
"type": "{String}",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 67,
"description": "The active page number for a paged scrollview",
"itemtype": "attribute",
"name": "index",
"type": "{Number}",
"default": "0",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 78,
"description": "The total number of pages",
"itemtype": "attribute",
"name": "total",
"type": "{Number}",
"default": "0",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 92,
"description": "Designated initializer",
"itemtype": "method",
"name": "initializer",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 111,
"description": "Calculate the page boundary offsets",
"itemtype": "method",
"name": "_calcOffsets",
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 136,
"description": "Executed to respond to the flick event, by over-riding the default flickFrame animation. \nThis is needed to determine if the next or prev page should be activated.",
"itemtype": "method",
"name": "_flickFrame",
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 164,
"description": "After host render handler",
"itemtype": "method",
"name": "_afterRender",
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 175,
"description": "scrollEnd handler detects if a page needs to change",
"itemtype": "method",
"name": "_scrollEnded",
"params": [
{
"name": "UNKNOWN",
"description": "",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 206,
"description": "index attr change handler",
"itemtype": "method",
"name": "_afterIndexChange",
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 218,
"description": "Update the UI based on the current page index",
"itemtype": "method",
"name": "_uiIndex",
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 228,
"description": "Scroll to the next page in the scrollview, with animation",
"itemtype": "method",
"name": "next",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 240,
"description": "Scroll to the previous page in the scrollview, with animation",
"itemtype": "method",
"name": "prev",
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 252,
"description": "Scroll to a given page in the scrollview, with animation.",
"itemtype": "method",
"name": "scrollTo",
"params": [
{
"name": "index",
"description": "The index of the page to scroll to",
"type": "Number"
},
{
"name": "duration",
"description": "The number of ms the animation should last",
"type": "Number"
},
{
"name": "easing",
"description": "The timing function to use in the animation",
"type": "String"
}
],
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 272,
"description": "Snaps the scrollview to the currently selected page",
"itemtype": "method",
"name": "snapToCurrent",
"params": [
{
"name": "duration",
"description": "The number of ms the animation should last",
"type": "Number"
},
{
"name": "easing",
"description": "The timing function to use in the animation",
"type": "String"
}
],
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/paginator-plugin.js",
"line": 296,
"description": "The default snap to current duration and easing values used on scroll end.",
"itemtype": "property",
"name": "SNAP_TO_CURRENT",
"static": 1,
"class": "Plugin.ScrollViewPaginator",
"module": "scrollview-paginator",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 73,
"description": "The identity of the plugin",
"itemtype": "property",
"name": "NAME",
"type": "String",
"default": "'pluginScrollViewScrollbars'",
"static": 1,
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 83,
"description": "The namespace on which the plugin will reside.",
"itemtype": "property",
"name": "NS",
"type": "String",
"default": "'scrollbars'",
"static": 1,
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 93,
"description": "HTML template for the scrollbar",
"itemtype": "property",
"name": "SCROLLBAR_TEMPLATE",
"type": "Object",
"static": 1,
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 108,
"description": "The default attribute configuration for the plugin",
"itemtype": "property",
"name": "ATTRS",
"type": "Object",
"static": 1,
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 117,
"description": "Vertical scrollbar node",
"itemtype": "attribute",
"name": "verticalNode",
"type": "Y.Node",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 128,
"description": "Horizontal scrollbar node",
"itemtype": "attribute",
"name": "horizontalNode",
"type": "Y.Node",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 142,
"description": "Designated initializer",
"itemtype": "method",
"name": "initializer",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 155,
"description": "Set up the DOM nodes for the scrollbars. This method is invoked whenever the\nhost's _uiDimensionsChange fires, giving us the opportunity to remove un-needed\nscrollbars, as well as add one if necessary.",
"itemtype": "method",
"name": "_hostDimensionsChange",
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 174,
"description": "Handler for the scrollEnd event fired by the host. Default implementation flashes the scrollbar",
"itemtype": "method",
"name": "_hostScrollEnd",
"params": [
{
"name": "e",
"description": "The event facade.",
"type": "Event.Facade"
}
],
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 186,
"description": "Adds or removes a scrollbar node from the document.",
"itemtype": "method",
"name": "_renderBar",
"access": "private",
"tagname": "",
"params": [
{
"name": "bar",
"description": "The scrollbar node",
"type": "Node"
},
{
"name": "add",
"description": "true, to add the node, false to remove it",
"type": "Boolean"
}
],
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 209,
"description": "Caches scrollbar child element information,\nto optimize _update implementation",
"itemtype": "method",
"name": "_setChildCache",
"access": "private",
"tagname": "",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
}
],
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 238,
"description": "Clears child cache",
"itemtype": "method",
"name": "_clearChildCache",
"access": "private",
"tagname": "",
"params": [
{
"name": "node",
"description": "",
"type": "Node"
}
],
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 249,
"description": "Utility method, to move/resize either vertical or horizontal scrollbars",
"itemtype": "method",
"name": "_updateBar",
"access": "private",
"tagname": "",
"params": [
{
"name": "scrollbar",
"description": "The scrollbar node.",
"type": "Node"
},
{
"name": "current",
"description": "The current scroll position.",
"type": "Number"
},
{
"name": "duration",
"description": "The transition duration.",
"type": "Number"
},
{
"name": "horiz",
"description": "true if horizontal, false if vertical.",
"type": "Boolean"
}
],
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 408,
"description": "AOP method, invoked after the host's _uiScrollTo method, \nto position and resize the scroll bars",
"itemtype": "method",
"name": "_update",
"params": [
{
"name": "x",
"description": "The current scrollX value",
"type": "Number"
},
{
"name": "y",
"description": "The current scrollY value",
"type": "Number"
},
{
"name": "duration",
"description": "Number of ms of animation (optional) - used when snapping to bounds",
"type": "Number"
},
{
"name": "easing",
"description": "Optional easing equation to use during the animation, if duration is set",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 440,
"description": "Show the scroll bar indicators",
"itemtype": "method",
"name": "show",
"params": [
{
"name": "animated",
"description": "Whether or not to animate the showing",
"type": "Boolean"
}
],
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 450,
"description": "Hide the scroll bar indicators",
"itemtype": "method",
"name": "hide",
"params": [
{
"name": "animated",
"description": "Whether or not to animate the hiding",
"type": "Boolean"
}
],
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 460,
"description": "Internal hide/show implementation utility method",
"itemtype": "method",
"name": "_show",
"params": [
{
"name": "show",
"description": "Whether to show or hide the scrollbar",
"type": "Boolean"
},
{
"name": "animated",
"description": "Whether or not to animate while showing/hide",
"type": "Bolean"
}
],
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 498,
"description": "Momentarily flash the scroll bars to indicate current scroll position",
"itemtype": "method",
"name": "flash",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 521,
"description": "Setter for the verticalNode and horizontalNode attributes",
"itemtype": "method",
"name": "_setNode",
"params": [
{
"name": "node",
"description": "The Y.Node instance for the scrollbar",
"type": "Node"
},
{
"name": "name",
"description": "The attribute name",
"type": "String"
}
],
"return": {
"description": "The Y.Node instance for the scrollbar",
"type": "Node"
},
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollbars-plugin.js",
"line": 545,
"description": "Creates default node instances for scrollbars",
"itemtype": "method",
"name": "_defaultNode",
"return": {
"description": "The Y.Node instance for the scrollbar",
"type": "Node"
},
"access": "protected",
"tagname": "",
"class": "Plugin.ScrollViewScrollbars",
"module": "scrollview-scrollbars",
"namespace": "Plugin"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 66,
"description": "Designated initializer",
"itemtype": "method",
"name": "initializer",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 72,
"description": "Notification event fired at the end of a scroll transition",
"itemtype": "event",
"name": "scrollEnd",
"params": [
{
"name": "e",
"description": "The default event facade.",
"type": "EventFacade"
}
],
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 79,
"description": "Notification event fired at the end of a flick gesture (the flick animation may still be in progress)",
"itemtype": "event",
"name": "flick",
"params": [
{
"name": "e",
"description": "The default event facade.",
"type": "EventFacade"
}
],
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 92,
"description": "Override the contentBox sizing method, since the contentBox height\nshould not be that of the boundingBox.",
"itemtype": "method",
"name": "_uiSizeCB",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 101,
"description": "Content box transition callback",
"itemtype": "method",
"name": "_onTransEnd",
"params": [
{
"name": "e",
"description": "The event facade",
"type": "Event.Facade"
}
],
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 112,
"description": "bindUI implementation\n\nHooks up events for the widget",
"itemtype": "method",
"name": "bindUI",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 131,
"itemtype": "method",
"name": "_bindAttrs",
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 163,
"description": "Bind (or unbind) gesture move listeners required for drag support",
"itemtype": "method",
"name": "_bindDrag",
"params": [
{
"name": "drag",
"description": "If true, the method binds listener to enable drag (gesturemovestart). If false, the method unbinds gesturemove listeners for drag support.",
"type": "Boolean"
}
],
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 180,
"description": "Bind (or unbind) flick listeners.",
"itemtype": "method",
"name": "_bindFlick",
"params": [
{
"name": "flick",
"description": "If truthy, the method binds listeners for flick support. If false, the method unbinds flick listeners.",
"type": "Object|boolean"
}
],
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 197,
"description": "syncUI implementation.\n\nUpdate the scroll position, based on the current value of scrollX/scrollY.",
"itemtype": "method",
"name": "syncUI",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 210,
"description": "Scroll the element to a given xy coordinate",
"itemtype": "method",
"name": "scrollTo",
"params": [
{
"name": "x",
"description": "The x-position to scroll to",
"type": "Number"
},
{
"name": "y",
"description": "The y-position to scroll to",
"type": "Number"
},
{
"name": "duration",
"description": "Duration, in ms, of the scroll animation (default is 0)",
"type": "Number"
},
{
"name": "easing",
"description": "An easing equation if duration is set",
"type": "String"
}
],
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 280,
"description": "Utility method, to create the translate transform string with the\nx, y translation amounts provided.",
"itemtype": "method",
"name": "_transform",
"params": [
{
"name": "x",
"description": "Number of pixels to translate along the x axis",
"type": "Number"
},
{
"name": "y",
"description": "Number of pixels to translate along the y axis",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 294,
"description": "Utility method, to move the given element to the given xy position",
"itemtype": "method",
"name": "_moveTo",
"params": [
{
"name": "node",
"description": "The node to move",
"type": "Node"
},
{
"name": "x",
"description": "The x-position to move to",
"type": "Number"
},
{
"name": "y",
"description": "The y-position to move to",
"type": "Number"
}
],
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 312,
"description": "Flag driving whether or not we should try and force H/W acceleration when transforming. Currently enabled by default for Webkit.\nUsed by the _transform method.",
"itemtype": "property",
"name": "_forceHWTransforms",
"type": "boolean",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 322,
"description": "Used to control whether or not ScrollView's internal\ngesturemovestart, gesturemove and gesturemoveend\nevent listeners should preventDefault. The value is an\nobject, with \"start\", \"move\" and \"end\" properties used to \nspecify which events should preventDefault and which shouldn't:
\n\n
\n{\n start : false,\n move : true,\n end : false\n}\n\n\nThe default values are set up in order to prevent panning,\non touch devices, while allowing click listeners on elements inside \nthe ScrollView to be notified as expected.
",
"itemtype": "property",
"name": "_prevent",
"type": "Object",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 351,
"description": "gesturemovestart event handler",
"itemtype": "method",
"name": "_onGestureMoveStart",
"params": [
{
"name": "e",
"description": "The gesturemovestart event facade",
"type": "Event.Facade"
}
],
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 379,
"description": "Internal state, defines whether or not the scrollview is currently being dragged",
"itemtype": "property",
"name": "_isDragging",
"type": "boolean",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 388,
"description": "Internal state, defines whether or not the scrollview is currently animating a flick",
"itemtype": "property",
"name": "_flicking",
"type": "boolean",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 397,
"description": "Internal state, defines whether or not the scrollview needs to snap to a boundary edge",
"itemtype": "property",
"name": "_snapToEdge",
"type": "boolean",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 408,
"description": "gesturemove event handler",
"itemtype": "method",
"name": "_onGestureMove",
"params": [
{
"name": "e",
"description": "The gesturemove event facade",
"type": "Event.Facade"
}
],
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 436,
"description": "gestureend event handler",
"itemtype": "method",
"name": "_onGestureMoveEnd",
"params": [
{
"name": "e",
"description": "The gesturemoveend event facade",
"type": "Event.Facade"
}
],
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 466,
"description": "Internal state, defines whether or not the scrollview has been scrolled half it's width/height",
"itemtype": "property",
"name": "_scrolledHalfway",
"type": "boolean",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 475,
"description": "Contains the distance (postive or negative) in pixels by which the scrollview was last scrolled. This is useful when\nsetting up click listeners on the scrollview content, which on mouse based devices are always fired, even after a\ndrag/flick. \n\nTouch based devices don't currently fire a click event, if the finger has been moved (beyond a threshold) so this check isn't required,\nif working in a purely touch based environment
",
"itemtype": "property",
"name": "lastScrolledAmt",
"type": "Number",
"access": "public",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 493,
"description": "Internal state, defines whether or not the scrollview has been scrolled in the forward (distance > 0), or backward (distance < 0) direction",
"itemtype": "property",
"name": "_scrolledForward",
"type": "boolean",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 537,
"description": "After listener for changes to the scrollX or scrollY attribute",
"itemtype": "method",
"name": "_afterScrollChange",
"params": [
{
"name": "e",
"description": "The event facade",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 558,
"description": "After listener for changes to the flick attribute",
"itemtype": "method",
"name": "_afterFlickChange",
"params": [
{
"name": "e",
"description": "The event facade",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 569,
"description": "After listener for changes to the disabled attribute",
"itemtype": "method",
"name": "_afterDisabledChange",
"params": [
{
"name": "e",
"description": "The event facade",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 581,
"description": "After listener for changes to the drag attribute",
"itemtype": "method",
"name": "_afterDragChange",
"params": [
{
"name": "e",
"description": "The event facade",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 592,
"description": "Used to move the ScrollView content",
"itemtype": "method",
"name": "_uiScrollTo",
"params": [
{
"name": "x",
"description": "",
"type": "Number"
},
{
"name": "y",
"description": "",
"type": "Number"
},
{
"name": "duration",
"description": "",
"type": "Number"
},
{
"name": "easing",
"description": "",
"type": "String"
}
],
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 612,
"description": "After listener for the height or width attribute",
"itemtype": "method",
"name": "_afterDimChange",
"params": [
{
"name": "e",
"description": "The event facade",
"type": "Event.Facade"
}
],
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 623,
"description": "Utility method to obtain scrollWidth, scrollHeight,\naccounting for the impact of translate on scrollWidth, scrollHeight",
"itemtype": "method",
"name": "_getScrollDims",
"return": {
"description": "The offsetWidth, offsetHeight, scrollWidth and scrollHeight as an array: [offsetWidth, offsetHeight, scrollWidth, scrollHeight]",
"type": "Array"
},
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 665,
"description": "This method gets invoked whenever the height or width attributes change,\nallowing us to determine which scrolling axes need to be enabled.",
"itemtype": "method",
"name": "_uiDimensionsChange",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 712,
"description": "Internal state, defines whether or not the scrollview can scroll vertically",
"itemtype": "property",
"name": "_scrollsVertical",
"type": "boolean",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 720,
"description": "Internal state, defines the maximum amount that the scrollview can be scrolled along the Y axis",
"itemtype": "property",
"name": "_maxScrollY",
"type": "number",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 728,
"description": "Internal state, defines the minimum amount that the scrollview can be scrolled along the Y axis",
"itemtype": "property",
"name": "_minScrollY",
"type": "number",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 736,
"description": "Internal state, cached scrollHeight, for performance",
"itemtype": "property",
"name": "_scrollHeight",
"type": "number",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 744,
"description": "Internal state, defines whether or not the scrollview can scroll horizontally",
"itemtype": "property",
"name": "_scrollsHorizontal",
"type": "boolean",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 752,
"description": "Internal state, defines the maximum amount that the scrollview can be scrolled along the X axis",
"itemtype": "property",
"name": "_maxScrollX",
"type": "number",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 760,
"description": "Internal state, defines the minimum amount that the scrollview can be scrolled along the X axis",
"itemtype": "property",
"name": "_minScrollX",
"type": "number",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 768,
"description": "Internal state, cached scrollWidth, for performance",
"itemtype": "property",
"name": "_scrollWidth",
"type": "number",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 777,
"description": "Execute a flick at the end of a scroll action",
"itemtype": "method",
"name": "_flick",
"params": [
{
"name": "distance",
"description": "The distance (in px) the user scrolled before the flick",
"type": "Number"
},
{
"name": "time",
"description": "The number of ms the scroll event lasted before the flick",
"type": "Number"
}
],
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 792,
"description": "Internal state, currently calculated velocity from the flick",
"itemtype": "property",
"name": "_currentVelocity",
"type": "number",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 814,
"description": "Execute a single frame in the flick animation",
"itemtype": "method",
"name": "_flickFrame",
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 899,
"description": "Stop the animation timer",
"itemtype": "method",
"name": "_killTimer",
"params": [
{
"name": "fireEvent",
"description": "If true, fire the scrollEnd event",
"type": "Boolean"
}
],
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 918,
"description": "The scrollX, scrollY setter implementation",
"itemtype": "method",
"name": "_setScroll",
"access": "private",
"tagname": "",
"params": [
{
"name": "val",
"description": "",
"type": "Number"
},
{
"name": "dim",
"description": "",
"type": "String"
}
],
"return": {
"description": "The constrained value, if it exceeds min/max range",
"type": "Number"
},
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 954,
"description": "Setter for the scrollX attribute",
"itemtype": "method",
"name": "_setScrollX",
"params": [
{
"name": "val",
"description": "The new scrollX value",
"type": "Number"
}
],
"return": {
"description": "The normalized value",
"type": "Number"
},
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 966,
"description": "Setter for the scrollY ATTR",
"itemtype": "method",
"name": "_setScrollY",
"params": [
{
"name": "val",
"description": "The new scrollY value",
"type": "Number"
}
],
"return": {
"description": "The normalized value",
"type": "Number"
},
"access": "protected",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 982,
"description": "The identity of the widget.",
"itemtype": "property",
"name": "NAME",
"type": "String",
"default": "'scrollview'",
"readonly": "",
"access": "protected",
"tagname": "",
"static": 1,
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 994,
"description": "Static property used to define the default attribute configuration of\nthe Widget.",
"itemtype": "property",
"name": "ATTRS",
"type": "{Object}",
"access": "protected",
"tagname": "",
"static": 1,
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1005,
"description": "The scroll position in the y-axis",
"itemtype": "attribute",
"name": "scrollY",
"type": "Number",
"default": "0",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1017,
"description": "The scroll position in the x-axis",
"itemtype": "attribute",
"name": "scrollX",
"type": "Number",
"default": "0",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1029,
"description": "Drag coefficent for inertial scrolling. The closer to 1 this\nvalue is, the less friction during scrolling.",
"itemtype": "attribute",
"name": "deceleration",
"default": "0.93",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1040,
"description": "Drag coefficient for intertial scrolling at the upper\nand lower boundaries of the scrollview. Set to 0 to \ndisable \"rubber-banding\".",
"itemtype": "attribute",
"name": "bounce",
"type": "Number",
"default": "0.1",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1053,
"description": "The minimum distance and/or velocity which define a flick. Can be set to false,\nto disable flick support (note: drag support is enabled/disabled separately)",
"itemtype": "attribute",
"name": "flick",
"type": "Object",
"default": "Object with properties minDistance = 10, minVelocity = 0.3.",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1068,
"description": "Enable/Disable dragging the ScrollView content (note: flick support is enabled/disabled separately)",
"itemtype": "attribute",
"name": "drag",
"type": "boolean",
"default": "true",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1079,
"description": "List of class names used in the scrollview's DOM",
"itemtype": "property",
"name": "CLASS_NAMES",
"type": "Object",
"static": 1,
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1088,
"description": "Flag used to source property changes initiated from the DOM",
"itemtype": "property",
"name": "UI_SRC",
"type": "String",
"static": 1,
"default": "\"ui\"",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1098,
"description": "The default bounce distance in pixels",
"itemtype": "property",
"name": "BOUNCE_RANGE",
"type": "Number",
"static": 1,
"default": "150",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1108,
"description": "The interval used when animating the flick",
"itemtype": "property",
"name": "FRAME_STEP",
"type": "Number",
"static": 1,
"default": "30",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1118,
"description": "The default easing used when animating the flick",
"itemtype": "property",
"name": "EASING",
"type": "String",
"static": 1,
"default": "'cubic-bezier(0, 0.1, 0, 1.0)'",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1128,
"description": "The default easing to use when animating the bounce snap back.",
"itemtype": "property",
"name": "SNAP_EASING",
"type": "String",
"static": 1,
"default": "'ease-out'",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/scrollview-base.js",
"line": 1138,
"description": "Object map of style property names used to set transition properties.\nDefaults to the vendor prefix established by the Transition module. \nThe configured property names are `_TRANSITION.DURATION` (e.g. \"WebkitTransitionDuration\") and\n`_TRANSITION.PROPERTY (e.g. \"WebkitTransitionProperty\").",
"itemtype": "property",
"name": "_TRANSITION",
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base"
},
{
"file": "lib/yui3/src/scrollview/js/ScrollViewBaseIE.js",
"line": 9,
"description": "Internal method to fix text selection in IE",
"itemtype": "method",
"name": "_fixIESelect",
"access": "private",
"tagname": "",
"params": [
{
"name": "bb",
"description": "The bounding box",
"type": "Node"
},
{
"name": "cb",
"description": "The content box",
"type": "Node"
}
],
"class": "ScrollView",
"module": "scrollview-base-ie"
},
{
"file": "lib/yui3/src/scrollview/js/ScrollViewBaseIE.js",
"line": 29,
"description": "Native onselectstart handle to prevent selection in IE",
"itemtype": "method",
"name": "_iePreventSelect",
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base-ie"
},
{
"file": "lib/yui3/src/scrollview/js/ScrollViewBaseIE.js",
"line": 40,
"description": "Restores native onselectstart handle, backed up to prevent selection in IE",
"itemtype": "method",
"name": "_ieRestoreSelect",
"access": "private",
"tagname": "",
"class": "ScrollView",
"module": "scrollview-base-ie"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 179,
"description": "Applies a new configuration object to the YUI instance config.\nThis will merge new group/module definitions, and will also\nupdate the loader cache if necessary. Updating Y.config directly\nwill not update the cache.",
"itemtype": "method",
"name": "applyConfig",
"params": [
{
"name": "the",
"description": "configuration object.",
"type": "Object"
}
],
"since": "3.2.0",
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 225,
"description": "Old way to apply a config to the instance (calls `applyConfig` under the hood)",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_config",
"params": [
{
"name": "o",
"description": "The config to apply",
"type": "Object"
}
],
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 235,
"description": "Initialize this YUI instance",
"access": "private",
"tagname": "",
"itemtype": "method",
"name": "_init",
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 247,
"description": "The version number of the YUI instance.",
"itemtype": "property",
"name": "version",
"type": "string",
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 405,
"description": "Finishes the instance setup. Attaches whatever modules were defined\nwhen the yui modules was registered.",
"itemtype": "method",
"name": "_setup",
"access": "private",
"tagname": "",
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 429,
"description": "Executes a method on a YUI instance with\nthe specified id if the specified method is whitelisted.",
"itemtype": "method",
"name": "applyTo",
"params": [
{
"name": "id",
"description": "the YUI instance id.",
"type": "String"
},
{
"name": "method",
"description": "the name of the method to exectute.\nEx: 'Object.keys'.",
"type": "String"
},
{
"name": "args",
"description": "the arguments to apply to the method.",
"type": "Array"
}
],
"return": {
"description": "the return value from the applied method or null.",
"type": "Object"
},
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 461,
"description": "Registers a module with the YUI global. The easiest way to create a\nfirst-class YUI module is to use the YUI component build tool.\n\nhttp://yuilibrary.com/projects/builder\n\nThe build system will produce the `YUI.add` wrapper for you module, along\nwith any configuration info required for the module.",
"itemtype": "method",
"name": "add",
"params": [
{
"name": "name",
"description": "module name.",
"type": "String"
},
{
"name": "fn",
"description": "entry point into the module that\nis used to bind module to the YUI instance.",
"type": "Function"
},
{
"name": "version",
"description": "version string.",
"type": "String"
},
{
"name": "details",
"description": "optional config data:",
"type": "Object",
"props": [
{
"name": "requires",
"description": "features that must be present before this module can be attached.",
"type": "Array"
},
{
"name": "optional",
"description": "optional features that should be present if loadOptional\nis defined. Note: modules are not often loaded this way in YUI 3,\nbut this field is still useful to inform the user that certain\nfeatures in the component will require additional dependencies.",
"type": "Array"
},
{
"name": "use",
"description": "features that are included within this module which need to\nbe attached automatically when this module is attached. This\nsupports the YUI 3 rollup system -- a module with submodules\ndefined will need to have the submodules listed in the 'use'\nconfig. The YUI component build tool does this for you.",
"type": "Array"
}
]
}
],
"return": {
"description": "the YUI instance.",
"type": "YUI"
},
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 518,
"description": "Executes the function associated with each required\nmodule, binding the module to the YUI instance.",
"itemtype": "method",
"name": "_attach",
"access": "private",
"tagname": "",
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 627,
"description": "Attaches one or more modules to the YUI instance. When this\nis executed, the requirements are analyzed, and one of\nseveral things can happen:\n\n * All requirements are available on the page -- The modules\n are attached to the instance. If supplied, the use callback\n is executed synchronously.\n\n * Modules are missing, the Get utility is not available OR\n the 'bootstrap' config is false -- A warning is issued about\n the missing modules and all available modules are attached.\n\n * Modules are missing, the Loader is not available but the Get\n utility is and boostrap is not false -- The loader is bootstrapped\n before doing the following....\n\n * Modules are missing and the Loader is available -- The loader\n expands the dependency tree and fetches missing modules. When\n the loader is finshed the callback supplied to use is executed\n asynchronously.",
"itemtype": "method",
"name": "use",
"params": [
{
"name": "modules",
"description": "1-n modules to bind (uses arguments array).",
"type": "String",
"multiple": true
},
{
"name": "*callback",
"description": "callback function executed when\nthe instance has the required functionality. If included, it\nmust be the last parameter.",
"type": "Function"
}
],
"example": [
"\n // loads and attaches dd and its dependencies\n YUI().use('dd', function(Y) {});\n\n // loads and attaches dd and node as well as all of their dependencies (since 3.4.0)\n YUI().use(['dd', 'node'], function(Y) {});\n\n // attaches all modules that are available on the page\n YUI().use('*', function(Y) {});\n\n // intrinsic YUI gallery support (since 3.1.0)\n YUI().use('gallery-yql', function(Y) {});\n\n // intrinsic YUI 2in3 support (since 3.1.0)\n YUI().use('yui2-datatable', function(Y) {});"
],
"return": {
"description": "the YUI instance.",
"type": "YUI"
},
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 737,
"description": "Notify handler from Loader for attachment/load errors",
"itemtype": "method",
"name": "_notify",
"params": [
{
"name": "callback",
"description": "The callback to pass to the `Y.config.loadErrorFn`",
"type": "Function"
},
{
"name": "response",
"description": "The response returned from Loader",
"type": "Object"
},
{
"name": "args",
"description": "The aruments passed from Loader",
"type": "Array"
}
],
"access": "private",
"tagname": "",
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 757,
"description": "This private method is called from the `use` method queue. To ensure that only one set of loading\nlogic is performed at a time.",
"itemtype": "method",
"name": "_use",
"access": "private",
"tagname": "",
"params": [
{
"name": "args",
"description": "1-n modules to bind (uses arguments array).",
"type": "String",
"multiple": true
},
{
"name": "*callback",
"description": "callback function executed when\nthe instance has the required functionality. If included, it\nmust be the last parameter.",
"type": "Function"
}
],
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1012,
"description": "Returns the namespace specified and creates it if it doesn't exist\n\n YUI.namespace(\"property.package\");\n YUI.namespace(\"YAHOO.property.package\");\n\nEither of the above would create `YUI.property`, then\n`YUI.property.package` (`YAHOO` is scrubbed out, this is\nto remain compatible with YUI2)\n\nBe careful when naming packages. Reserved words may work in some browsers\nand not others. For instance, the following will fail in Safari:\n\n YUI.namespace(\"really.long.nested.namespace\");\n\nThis fails because \"long\" is a future reserved word in ECMAScript",
"itemtype": "method",
"name": "namespace",
"params": [
{
"name": "arguments",
"description": "1-n namespaces to create.",
"type": "String*"
}
],
"return": {
"description": "A reference to the last namespace object created.",
"type": "Object"
},
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1057,
"description": "Report an error. The reporting mechanism is controled by\nthe `throwFail` configuration attribute. If throwFail is\nnot specified, the message is written to the Logger, otherwise\na JS error is thrown",
"itemtype": "method",
"name": "error",
"params": [
{
"name": "msg",
"description": "the error message.",
"type": "String"
},
{
"name": "e",
"description": "Optional JS error that was caught, or an error string.",
"type": "Error|String"
},
{
"name": "data",
"description": "Optional additional info\nand `throwFail` is specified, this error will be re-thrown."
}
],
"return": {
"description": "this YUI instance.",
"type": "YUI"
},
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1086,
"description": "Generate an id that is unique among all YUI instances",
"itemtype": "method",
"name": "guid",
"params": [
{
"name": "pre",
"description": "optional guid prefix.",
"type": "String"
}
],
"return": {
"description": "the guid.",
"type": "String"
},
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1097,
"description": "Returns a `guid` associated with an object. If the object\ndoes not have one, a new one is created unless `readOnly`\nis specified.",
"itemtype": "method",
"name": "stamp",
"params": [
{
"name": "o",
"description": "The object to stamp.",
"type": "Object"
},
{
"name": "readOnly",
"description": "if `true`, a valid guid will only\nbe returned if the object has one assigned to it.",
"type": "Boolean"
}
],
"return": {
"description": "The object's guid or null.",
"type": "String"
},
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1134,
"description": "Destroys the YUI instance",
"itemtype": "method",
"name": "destroy",
"since": "3.3.0",
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1149,
"description": "instanceof check for objects that works around\nmemory leak in IE when the item tested is\nwindow/document",
"itemtype": "method",
"name": "instanceOf",
"since": "3.3.0",
"class": "YUI",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1206,
"description": "Allows the YUI seed file to fetch the loader component and library\nmetadata to dynamically load additional dependencies.",
"itemtype": "property",
"name": "bootstrap",
"type": "boolean",
"default": "true",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1215,
"description": "Log to the browser console if debug is on and the browser has a\nsupported console.",
"itemtype": "property",
"name": "useBrowserConsole",
"type": "boolean",
"default": "true",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1224,
"description": "A hash of log sources that should be logged. If specified, only\nlog messages from these sources will be logged.",
"itemtype": "property",
"name": "logInclude",
"type": "object",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1232,
"description": "A hash of log sources that should be not be logged. If specified,\nall sources are logged if not on this list.",
"itemtype": "property",
"name": "logExclude",
"type": "object",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1240,
"description": "Set to true if the yui seed file was dynamically loaded in\norder to bootstrap components relying on the window load event\nand the `domready` custom event.",
"itemtype": "property",
"name": "injected",
"type": "boolean",
"default": "false",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1250,
"description": "If `throwFail` is set, `Y.error` will generate or re-throw a JS Error.\nOtherwise the failure is logged.",
"itemtype": "property",
"name": "throwFail",
"type": "boolean",
"default": "true",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1259,
"description": "The window/frame that this instance should operate in.",
"itemtype": "property",
"name": "win",
"type": "Window",
"default": "the window hosting YUI",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1267,
"description": "The document associated with the 'win' configuration.",
"itemtype": "property",
"name": "doc",
"type": "Document",
"default": "the document hosting YUI",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1275,
"description": "A list of modules that defines the YUI core (overrides the default).",
"itemtype": "property",
"name": "core",
"type": "string[]",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1282,
"description": "A list of languages in order of preference. This list is matched against\nthe list of available languages in modules that the YUI instance uses to\ndetermine the best possible localization of language sensitive modules.\nLanguages are represented using BCP 47 language tags, such as \"en-GB\" for\nEnglish as used in the United Kingdom, or \"zh-Hans-CN\" for simplified\nChinese as used in China. The list can be provided as a comma-separated\nlist or as an array.",
"itemtype": "property",
"name": "lang",
"type": "string|string[]",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1295,
"description": "The default date format",
"itemtype": "property",
"name": "dateFormat",
"type": "string",
"deprecated": true,
"deprecationMessage": "use configuration in `DataType.Date.format()` instead.",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1302,
"description": "The default locale",
"itemtype": "property",
"name": "locale",
"type": "string",
"deprecated": true,
"deprecationMessage": "use `config.lang` instead.",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1309,
"description": "The default interval when polling in milliseconds.",
"itemtype": "property",
"name": "pollInterval",
"type": "int",
"default": "20",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1316,
"description": "The number of dynamic nodes to insert by default before\nautomatically removing them. This applies to script nodes\nbecause removing the node will not make the evaluated script\nunavailable. Dynamic CSS is not auto purged, because removing\na linked style sheet will also remove the style definitions.",
"itemtype": "property",
"name": "purgethreshold",
"type": "int",
"default": "20",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1327,
"description": "The default interval when polling in milliseconds.",
"itemtype": "property",
"name": "windowResizeDelay",
"type": "int",
"default": "40",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1334,
"description": "Base directory for dynamic loading",
"itemtype": "property",
"name": "base",
"type": "string",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1347,
"description": "The YUI combo service base dir. Ex: `http://yui.yahooapis.com/combo?`\nFor dynamic loading.",
"itemtype": "property",
"name": "comboBase",
"type": "string",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1354,
"description": "The root path to prepend to module path for the combo service.\nEx: 3.0.0b1/build/\nFor dynamic loading.",
"itemtype": "property",
"name": "root",
"type": "string",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1362,
"description": "A filter to apply to result urls. This filter will modify the default\npath for all modules. The default path for the YUI library is the\nminified version of the files (e.g., event-min.js). The filter property\ncan be a predefined filter or a custom filter. The valid predefined\nfilters are:\n\n - DEBUG
\n - Selects the debug versions of the library (e.g., event-debug.js).\n This option will automatically include the Logger widget
\n - RAW
\n - Selects the non-minified version of the library (e.g., event.js).
\n
\nYou can also define a custom filter, which must be an object literal\ncontaining a search expression and a replace string:\n\n myFilter: {\n 'searchExp': \"-min\\\\.js\",\n 'replaceStr': \"-debug.js\"\n }\n\nFor dynamic loading.",
"itemtype": "property",
"name": "filter",
"type": "string|object",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1389,
"description": "The `skin` config let's you configure application level skin\ncustomizations. It contains the following attributes which\ncan be specified to override the defaults:\n\n // The default skin, which is automatically applied if not\n // overriden by a component-specific skin definition.\n // Change this in to apply a different skin globally\n defaultSkin: 'sam',\n\n // This is combined with the loader base property to get\n // the default root directory for a skin.\n base: 'assets/skins/',\n\n // Any component-specific overrides can be specified here,\n // making it possible to load different skins for different\n // components. It is possible to load more than one skin\n // for a given component as well.\n overrides: {\n slider: ['capsule', 'round']\n }\n\nFor dynamic loading.",
"itemtype": "property",
"name": "skin",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1416,
"description": "Hash of per-component filter specification. If specified for a given\ncomponent, this overrides the filter config.\n\nFor dynamic loading.",
"itemtype": "property",
"name": "filters",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1425,
"description": "Use the YUI combo service to reduce the number of http connections\nrequired to load your dependencies. Turning this off will\ndisable combo handling for YUI and all module groups configured\nwith a combo service.\n\nFor dynamic loading.",
"itemtype": "property",
"name": "combine",
"type": "boolean",
"default": "true if 'base' is not supplied, false if it is.",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1438,
"description": "A list of modules that should never be dynamically loaded",
"itemtype": "property",
"name": "ignore",
"type": "string[]",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1445,
"description": "A list of modules that should always be loaded when required, even if already\npresent on the page.",
"itemtype": "property",
"name": "force",
"type": "string[]",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1453,
"description": "Node or id for a node that should be used as the insertion point for new\nnodes. For dynamic loading.",
"itemtype": "property",
"name": "insertBefore",
"type": "string",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1461,
"description": "Object literal containing attributes to add to dynamically loaded script\nnodes.",
"itemtype": "property",
"name": "jsAttributes",
"type": "string",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1468,
"description": "Object literal containing attributes to add to dynamically loaded link\nnodes.",
"itemtype": "property",
"name": "cssAttributes",
"type": "string",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1475,
"description": "Number of milliseconds before a timeout occurs when dynamically\nloading nodes. If not set, there is no timeout.",
"itemtype": "property",
"name": "timeout",
"type": "int",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1482,
"description": "Callback for the 'CSSComplete' event. When dynamically loading YUI\ncomponents with CSS, this property fires when the CSS is finished\nloading but script loading is still ongoing. This provides an\nopportunity to enhance the presentation of a loading page a little\nbit before the entire loading process is done.",
"itemtype": "property",
"name": "onCSS",
"type": "function",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1493,
"description": "A hash of module definitions to add to the list of YUI components.\nThese components can then be dynamically loaded side by side with\nYUI via the `use()` method. This is a hash, the key is the module\nname, and the value is an object literal specifying the metdata\nfor the module. See `Loader.addModule` for the supported module\nmetadata fields. Also see groups, which provides a way to\nconfigure the base and combo spec for a set of modules.\n\n modules: {\n mymod1: {\n requires: ['node'],\n fullpath: 'http://myserver.mydomain.com/mymod1/mymod1.js'\n },\n mymod2: {\n requires: ['mymod1'],\n fullpath: 'http://myserver.mydomain.com/mymod2/mymod2.js'\n }\n }",
"itemtype": "property",
"name": "modules",
"type": "object",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1517,
"description": "A hash of module group definitions. It for each group you\ncan specify a list of modules and the base path and\ncombo spec to use when dynamically loading the modules.\n\n groups: {\n yui2: {\n // specify whether or not this group has a combo service\n combine: true,\n\n // the base path for non-combo paths\n base: 'http://yui.yahooapis.com/2.8.0r4/build/',\n\n // the path to the combo service\n comboBase: 'http://yui.yahooapis.com/combo?',\n\n // a fragment to prepend to the path attribute when\n // when building combo urls\n root: '2.8.0r4/build/',\n\n // the module definitions\n modules: {\n yui2_yde: {\n path: \"yahoo-dom-event/yahoo-dom-event.js\"\n },\n yui2_anim: {\n path: \"animation/animation.js\",\n requires: ['yui2_yde']\n }\n }\n }\n }",
"itemtype": "property",
"name": "groups",
"type": "object",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1554,
"description": "The loader 'path' attribute to the loader itself. This is combined\nwith the 'base' attribute to dynamically load the loader component\nwhen boostrapping with the get utility alone.",
"itemtype": "property",
"name": "loaderPath",
"type": "string",
"default": "loader/loader-min.js",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1564,
"description": "Specifies whether or not YUI().use(...) will attempt to load CSS\nresources at all. Any truthy value will cause CSS dependencies\nto load when fetching script. The special value 'force' will\ncause CSS dependencies to be loaded even if no script is needed.",
"itemtype": "property",
"name": "fetchCSS",
"type": "boolean|string",
"default": "true",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1575,
"description": "The default gallery version to build gallery module urls",
"itemtype": "property",
"name": "gallery",
"type": "string",
"since": "3.1.0",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1582,
"description": "The default YUI 2 version to build yui2 module urls. This is for\nintrinsic YUI 2 support via the 2in3 project. Also see the '2in3'\nconfig for pulling different revisions of the wrapped YUI 2\nmodules.",
"since": "3.1.0",
"itemtype": "property",
"name": "yui2",
"type": "string",
"default": "2.8.1",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1593,
"description": "The 2in3 project is a deployment of the various versions of YUI 2\ndeployed as first-class YUI 3 modules. Eventually, the wrapper\nfor the modules will change (but the underlying YUI 2 code will\nbe the same), and you can select a particular version of\nthe wrapper modules via this config.",
"since": "3.1.0",
"itemtype": "property",
"name": "2in3",
"type": "string",
"default": "1",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1605,
"description": "Alternative console log function for use in environments without\na supported native console. The function is executed in the\nYUI instance context.",
"since": "3.1.0",
"itemtype": "property",
"name": "logFn",
"type": "Function",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1614,
"description": "A callback to execute when Y.error is called. It receives the\nerror message and an javascript error object if Y.error was\nexecuted because a javascript error was caught. The function\nis executed in the YUI instance context.",
"since": "3.2.0",
"itemtype": "property",
"name": "errorFn",
"type": "Function",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1625,
"description": "A callback to execute when the loader fails to load one or\nmore resource. This could be because of a script load\nfailure. It can also fail if a javascript module fails\nto register itself, but only when the 'requireRegistration'\nis true. If this function is defined, the use() callback will\nonly be called when the loader succeeds, otherwise it always\nexecutes unless there was a javascript error when attaching\na module.",
"since": "3.3.0",
"itemtype": "property",
"name": "loadErrorFn",
"type": "Function",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1640,
"description": "When set to true, the YUI loader will expect that all modules\nit is responsible for loading will be first-class YUI modules\nthat register themselves with the YUI global. If this is\nset to true, loader will fail if the module registration fails\nto happen after the script is loaded.",
"since": "3.3.0",
"itemtype": "property",
"name": "requireRegistration",
"type": "boolean",
"default": "false",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1653,
"description": "Cache serviced use() requests.",
"since": "3.3.0",
"itemtype": "property",
"name": "cacheUse",
"type": "boolean",
"default": "true",
"deprecated": true,
"deprecationMessage": "no longer used",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1662,
"description": "The parameter defaults for the remote loader service.\nRequires the rls submodule. The properties that are\nsupported:\n\n * `m`: comma separated list of module requirements. This\n must be the param name even for custom implemetations.\n * `v`: the version of YUI to load. Defaults to the version\n of YUI that is being used.\n * `gv`: the version of the gallery to load (see the gallery config)\n * `env`: comma separated list of modules already on the page.\n this must be the param name even for custom implemetations.\n * `lang`: the languages supported on the page (see the lang config)\n * `'2in3v'`: the version of the 2in3 wrapper to use (see the 2in3 config).\n * `'2v'`: the version of yui2 to use in the yui 2in3 wrappers\n * `filt`: a filter def to apply to the urls (see the filter config).\n * `filts`: a list of custom filters to apply per module\n * `tests`: this is a map of conditional module test function id keys\nwith the values of 1 if the test passes, 0 if not. This must be\nthe name of the querystring param in custom templates.",
"since": "3.2.0",
"itemtype": "property",
"name": "rls",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1687,
"description": "The base path to the remote loader service",
"since": "3.2.0",
"itemtype": "property",
"name": "rls_base",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1694,
"description": "The template to use for building the querystring portion\nof the remote loader service url. The default is determined\nby the rls config -- each property that has a value will be\nrepresented.",
"since": "3.2.0",
"itemtype": "property",
"name": "rls_tmpl",
"example": [
"\n m={m}&v={v}&env={env}&lang={lang}&filt={filt}&tests={tests}\n"
],
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1707,
"description": "Configure the instance to use a remote loader service instead of\nthe client loader.",
"since": "3.2.0",
"itemtype": "property",
"name": "use_rls",
"class": "config",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1763,
"description": "Determines whether or not the provided item is an array.\n\nReturns `false` for array-like collections such as the function `arguments`\ncollection or `HTMLElement` collections. Use `Y.Array.test()` if you want to\ntest for an array-like collection.",
"itemtype": "method",
"name": "isArray",
"params": [
{
"name": "o",
"description": "The object to test."
}
],
"return": {
"description": "true if o is an array.",
"type": "Boolean"
},
"static": 1,
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1779,
"description": "Determines whether or not the provided item is a boolean.",
"itemtype": "method",
"name": "isBoolean",
"static": 1,
"params": [
{
"name": "o",
"description": "The object to test."
}
],
"return": {
"description": "true if o is a boolean.",
"type": "Boolean"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1790,
"description": "\nDetermines whether or not the provided item is a function.\nNote: Internet Explorer thinks certain functions are objects:\n
\n\n\nvar obj = document.createElement(\"object\");\nY.Lang.isFunction(obj.getAttribute) // reports false in IE\n \nvar input = document.createElement(\"input\"); // append to body\nY.Lang.isFunction(input.focus) // reports false in IE\n
\n\n\nYou will have to implement additional tests if these functions\nmatter to you.\n
",
"itemtype": "method",
"name": "isFunction",
"static": 1,
"params": [
{
"name": "o",
"description": "The object to test."
}
],
"return": {
"description": "true if o is a function.",
"type": "Boolean"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1818,
"description": "Determines whether or not the supplied item is a date instance.",
"itemtype": "method",
"name": "isDate",
"static": 1,
"params": [
{
"name": "o",
"description": "The object to test."
}
],
"return": {
"description": "true if o is a date.",
"type": "Boolean"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1829,
"description": "Determines whether or not the provided item is null.",
"itemtype": "method",
"name": "isNull",
"static": 1,
"params": [
{
"name": "o",
"description": "The object to test."
}
],
"return": {
"description": "true if o is null.",
"type": "Boolean"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1840,
"description": "Determines whether or not the provided item is a legal number.",
"itemtype": "method",
"name": "isNumber",
"static": 1,
"params": [
{
"name": "o",
"description": "The object to test."
}
],
"return": {
"description": "true if o is a number.",
"type": "Boolean"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1851,
"description": "Determines whether or not the provided item is of type object\nor function. Note that arrays are also objects, so\nY.Lang.isObject([]) === true.",
"itemtype": "method",
"name": "isObject",
"static": 1,
"params": [
{
"name": "o",
"description": "The object to test."
},
{
"name": "failfn",
"description": "fail if the input is a function.",
"type": "Boolean"
}
],
"return": {
"description": "true if o is an object.",
"type": "Boolean"
},
"see": [
"isPlainObject"
],
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1868,
"description": "Determines whether or not the provided item is a string.",
"itemtype": "method",
"name": "isString",
"static": 1,
"params": [
{
"name": "o",
"description": "The object to test."
}
],
"return": {
"description": "true if o is a string.",
"type": "Boolean"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1879,
"description": "Determines whether or not the provided item is undefined.",
"itemtype": "method",
"name": "isUndefined",
"static": 1,
"params": [
{
"name": "o",
"description": "The object to test."
}
],
"return": {
"description": "true if o is undefined.",
"type": "Boolean"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1890,
"description": "Returns a string without any leading or trailing whitespace. If\nthe input is not a string, the input will be returned untouched.",
"itemtype": "method",
"name": "trim",
"static": 1,
"params": [
{
"name": "s",
"description": "the string to trim.",
"type": "String"
}
],
"return": {
"description": "the trimmed string.",
"type": "String"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1908,
"description": "Returns a string without any leading whitespace.",
"itemtype": "method",
"name": "trimLeft",
"static": 1,
"params": [
{
"name": "s",
"description": "the string to trim.",
"type": "String"
}
],
"return": {
"description": "the trimmed string.",
"type": "String"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1921,
"description": "Returns a string without any trailing whitespace.",
"itemtype": "method",
"name": "trimRight",
"static": 1,
"params": [
{
"name": "s",
"description": "the string to trim.",
"type": "String"
}
],
"return": {
"description": "the trimmed string.",
"type": "String"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1934,
"description": "A convenience method for detecting a legitimate non-null value.\nReturns false for null/undefined/NaN, true for other values,\nincluding 0/false/''",
"itemtype": "method",
"name": "isValue",
"static": 1,
"params": [
{
"name": "o",
"description": "The item to test."
}
],
"return": {
"description": "true if it is not null/undefined/NaN || false.",
"type": "Boolean"
},
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1959,
"description": "\nReturns a string representing the type of the item passed in.\n
\n\n\nKnown issues:\n
\n\n\n - \n
typeof HTMLElementCollection returns function in Safari, but\n Y.type() reports object, which could be a good thing --\n but it actually caused the logic in Y.Lang.isObject to fail.\n \n
",
"itemtype": "method",
"name": "type",
"params": [
{
"name": "o",
"description": "the item to test."
}
],
"return": {
"description": "the detected type.",
"type": "String"
},
"static": 1,
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 1985,
"description": "Lightweight version of Y.substitute. Uses the same template\nstructure as Y.substitute, but doesn't support recursion,\nauto-object coersion, or formats.",
"itemtype": "method",
"name": "sub",
"params": [
{
"name": "s",
"description": "String to be modified.",
"type": "String"
},
{
"name": "o",
"description": "Object containing replacement values.",
"type": "Object"
}
],
"return": {
"description": "the substitute result.",
"type": "String"
},
"static": 1,
"since": "3.2.0",
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 2002,
"description": "Returns the current time in milliseconds.",
"itemtype": "method",
"name": "now",
"return": {
"description": "Current time in milliseconds.",
"type": "Number"
},
"static": 1,
"since": "3.3.0",
"class": "Lang",
"module": "yui",
"submodule": "yui-base"
},
{
"file": "lib/yui3/src/simpleyui/js/concat.js",
"line": 2080,
"description": "Evaluates _obj_ to determine if it's an array, an array-like collection, or\nsomething else. This is useful when working with the function `arguments`\ncollection and `HTMLElement` collections.\n\nNote: This implementation doesn't consider elements that are also\ncollections, such as `
![](\"assets/images/aui-autocomplete/main.png\"/)
![](\"assets/images/aui-calendar/main.png\"/)