X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.chart.series.Series.js diff --git a/docs/output/Ext.chart.series.Series.js b/docs/output/Ext.chart.series.Series.js index 7f1717af..f4c145bb 100644 --- a/docs/output/Ext.chart.series.Series.js +++ b/docs/output/Ext.chart.series.Series.js @@ -1,1023 +1,1586 @@ Ext.data.JsonP.Ext_chart_series_Series({ - "tagname": "class", - "name": "Ext.chart.series.Series", - "doc": "

Series is the abstract class containing the common logic to all chart series. Series includes\nmethods from Labels, Highlights, Tips and Callouts mixins. This class implements the logic of handling\nmouse events, animating, hiding, showing all elements and returning the color of the series to be used as a legend item.

\n\n

Listeners

\n\n

The series class supports listeners via the Observable syntax. Some of these listeners are:

\n\n\n\n\n

For example:

\n\n
series: [{\n        type: 'column',\n        axis: 'left',\n        listeners: {\n                'afterrender': function() {\n                        console('afterrender');\n                }\n        },\n        xField: 'category',\n        yField: 'data1'\n}]\n
\n", - "extends": null, - "mixins": [ + "allMixins": [ "Ext.util.Observable", "Ext.chart.Label", "Ext.chart.Highlight", "Ext.chart.Tip", "Ext.chart.Callout" ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "color", - "member": "Ext.chart.Label", - "type": "String", - "doc": "

The color of the label text.\nDefault value: '#000' (black).

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 42, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-color" - }, - { - "tagname": "cfg", - "name": "display", - "member": "Ext.chart.Label", - "type": "String", - "doc": "

Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEnd\", \"outside\", \"over\", \"under\", or \"none\" to prevent label rendering.\nDefault value: 'none'.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 35, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-display", - "shortDoc": "Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEn..." - }, - { - "tagname": "cfg", - "name": "field", - "member": "Ext.chart.Label", - "type": "String", - "doc": "

The name of the field to be displayed in the label.\nDefault value: 'name'.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 48, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-field" - }, - { - "tagname": "cfg", - "name": "font", - "member": "Ext.chart.Label", - "type": "String", - "doc": "

The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 61, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-font" - }, - { - "tagname": "cfg", - "name": "highlight", - "member": "Ext.chart.series.Series", - "type": "Boolean|Object", - "doc": "

If set to true it will highlight the markers or the series when hovering\nwith the mouse. This parameter can also be an object with the same style\nproperties you would apply to a Ext.draw.Sprite to apply custom\nstyles to markers and series.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 46, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-cfg-highlight", - "shortDoc": "If set to true it will highlight the markers or the series when hovering\nwith the mouse. This parameter can also be a..." - }, - { - "tagname": "cfg", - "name": "listeners", - "member": "Ext.chart.series.Series", - "type": "Object", - "doc": "

An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback functions are:

\n\n

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 105, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-cfg-listeners", - "shortDoc": "An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback f..." - }, - { - "tagname": "cfg", - "name": "minMargin", - "member": "Ext.chart.Label", - "type": "Number", - "doc": "

Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using PieSeries width variable pie slice lengths.\nDefault value: 50.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 54, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-minMargin", - "shortDoc": "Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using P..." - }, - { - "tagname": "cfg", - "name": "orientation", - "member": "Ext.chart.Label", - "type": "String", - "doc": "

Either \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 67, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-orientation" - }, - { - "tagname": "cfg", - "name": "renderer", - "member": "Ext.chart.series.Series", - "type": "Function", - "doc": "

A function that can be overridden to set custom styling properties to each rendered element.\nPasses in (sprite, record, attributes, index, store) to the function.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 87, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-cfg-renderer", - "shortDoc": "A function that can be overridden to set custom styling properties to each rendered element.\nPasses in (sprite, recor..." - }, - { - "tagname": "cfg", - "name": "shadowAttributes", - "member": "Ext.chart.series.Series", - "type": "Array", - "doc": "

An array with shadow attributes

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 96, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-cfg-shadowAttributes" - }, - { - "tagname": "cfg", - "name": "showInLegend", - "member": "Ext.chart.series.Series", - "type": "Boolean", - "doc": "

Whether to show this series in the legend.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 81, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-cfg-showInLegend" - }, - { - "tagname": "cfg", - "name": "tips", - "member": "Ext.chart.series.Series", - "type": "Object", - "doc": "

Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with Ext.tip.ToolTip. For example:

\n\n
tips: {\n  trackMouse: true,\n  width: 140,\n  height: 28,\n  renderer: function(storeItem, item) {\n    this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');\n  }\n},\n
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 54, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-cfg-tips", - "shortDoc": "Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with Ext.tip.To..." - }, - { - "tagname": "cfg", - "name": "title", - "member": "Ext.chart.series.Series", - "type": "String", - "doc": "

The human-readable name of the series.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 75, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-cfg-title" - }, - { - "tagname": "cfg", - "name": "type", - "member": "Ext.chart.series.Series", - "type": "String", - "doc": "

The type of series. Set in subclasses.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 69, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-cfg-type" - } - ], - "method": [ - { - "tagname": "method", - "name": "addEvents", - "member": "Ext.util.Observable", - "doc": "

Adds the specified events to the list of events which this Observable may fire.

\n", - "params": [ - { - "type": "Object/String", - "name": "o", - "doc": "

Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.

\n", - "optional": false - }, - { - "type": "String", - "name": "", - "doc": "

[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:

\n\n
this.addEvents('storeloaded', 'storecleared');\n
\n\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 452, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addEvents", - "shortDoc": "

Adds the specified events to the list of events which this Observable may fire.

\n" - }, - { - "tagname": "method", - "name": "addListener", - "member": "Ext.util.Observable", - "doc": "

Appends an event handler to this object.

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The name of the event to listen for. May also be an object who's property names are event names. See

\n", - "optional": false + "members": { + "cfg": [ + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Label2.html#Ext-chart-Label-cfg-color", + "shortDoc": "The color of the label text. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js", + "private": false, + "name": "color", + "owner": "Ext.chart.Label", + "doc": "

The color of the label text.\nDefault value: '#000' (black).

\n", + "linenr": 42, + "html_filename": "Label2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Label2.html#Ext-chart-Label-cfg-display", + "shortDoc": "Specifies the presence and position of labels for each pie slice. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js", + "private": false, + "name": "display", + "owner": "Ext.chart.Label", + "doc": "

Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEnd\", \"outside\", \"over\", \"under\", or \"none\" to prevent label rendering.\nDefault value: 'none'.

\n", + "linenr": 35, + "html_filename": "Label2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Label2.html#Ext-chart-Label-cfg-field", + "shortDoc": "The name of the field to be displayed in the label. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js", + "private": false, + "name": "field", + "owner": "Ext.chart.Label", + "doc": "

The name of the field to be displayed in the label.\nDefault value: 'name'.

\n", + "linenr": 48, + "html_filename": "Label2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Label2.html#Ext-chart-Label-cfg-font", + "shortDoc": "The font used for the labels. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js", + "private": false, + "name": "font", + "owner": "Ext.chart.Label", + "doc": "

The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".

\n", + "linenr": 61, + "html_filename": "Label2.html" + }, + { + "type": "Boolean|Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Series.html#Ext-chart-series-Series-cfg-highlight", + "shortDoc": "If set to true it will highlight the markers or the series when hovering\nwith the mouse. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "name": "highlight", + "owner": "Ext.chart.series.Series", + "doc": "

If set to true it will highlight the markers or the series when hovering\nwith the mouse. This parameter can also be an object with the same style\nproperties you would apply to a Ext.draw.Sprite to apply custom\nstyles to markers and series.

\n", + "linenr": 46, + "html_filename": "Series.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Series.html#Ext-chart-series-Series-cfg-listeners", + "shortDoc": "An (optional) object with event callbacks. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "name": "listeners", + "owner": "Ext.chart.series.Series", + "doc": "

An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback functions are:

\n\n

\n", + "linenr": 105, + "html_filename": "Series.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Label2.html#Ext-chart-Label-cfg-minMargin", + "shortDoc": "Specifies the minimum distance from a label to the origin of the visualization. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js", + "private": false, + "name": "minMargin", + "owner": "Ext.chart.Label", + "doc": "

Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using PieSeries width variable pie slice lengths.\nDefault value: 50.

\n", + "linenr": 54, + "html_filename": "Label2.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Label2.html#Ext-chart-Label-cfg-orientation", + "shortDoc": "Either \"horizontal\" or \"vertical\". ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js", + "private": false, + "name": "orientation", + "owner": "Ext.chart.Label", + "doc": "

Either \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".

\n", + "linenr": 67, + "html_filename": "Label2.html" + }, + { + "type": "Function", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Series.html#Ext-chart-series-Series-cfg-renderer", + "shortDoc": "A function that can be overridden to set custom styling properties to each rendered element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "name": "renderer", + "owner": "Ext.chart.series.Series", + "doc": "

A function that can be overridden to set custom styling properties to each rendered element.\nPasses in (sprite, record, attributes, index, store) to the function.

\n", + "linenr": 87, + "html_filename": "Series.html" + }, + { + "type": "Array", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Series.html#Ext-chart-series-Series-cfg-shadowAttributes", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "name": "shadowAttributes", + "owner": "Ext.chart.series.Series", + "doc": "

An array with shadow attributes

\n", + "linenr": 96, + "html_filename": "Series.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Series.html#Ext-chart-series-Series-cfg-showInLegend", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "name": "showInLegend", + "owner": "Ext.chart.series.Series", + "doc": "

Whether to show this series in the legend.

\n", + "linenr": 81, + "html_filename": "Series.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Series.html#Ext-chart-series-Series-cfg-tips", + "shortDoc": "Add tooltips to the visualization's markers. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "name": "tips", + "owner": "Ext.chart.series.Series", + "doc": "

Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with Ext.tip.ToolTip. For example:

\n\n
tips: {\n  trackMouse: true,\n  width: 140,\n  height: 28,\n  renderer: function(storeItem, item) {\n    this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');\n  }\n},\n
\n", + "linenr": 54, + "html_filename": "Series.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Series.html#Ext-chart-series-Series-cfg-title", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "name": "title", + "owner": "Ext.chart.series.Series", + "doc": "

The human-readable name of the series.

\n", + "linenr": 75, + "html_filename": "Series.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Series.html#Ext-chart-series-Series-cfg-type", + "shortDoc": "The type of series. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "name": "type", + "owner": "Ext.chart.series.Series", + "doc": "

The type of series. Set in subclasses.

\n", + "linenr": 69, + "html_filename": "Series.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addEvents", + "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object/String", + "optional": false, + "doc": "

Either an object with event names as properties with a value of true or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:

\n\n
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
\n", + "name": "o" + }, + { + "type": "String...", + "optional": false, + "doc": "

Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:

\n\n
this.addEvents('storeloaded', 'storecleared');\n
\n", + "name": "more" + } + ], + "name": "addEvents", + "owner": "Ext.util.Observable", + "doc": "

Adds the specified events to the list of events which this Observable may fire.

\n", + "linenr": 494, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addListener", + "shortDoc": "Appends an event handler to this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The name of the event to listen for. May also be an object who's property names are\nevent names.

\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "

The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.

\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.

\n", + "name": "scope" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) An object containing handler configuration.

\n\n

Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

\n\n

This object may contain any of the following properties:

\n\n\n\n\n

Combining Options

\n\n

Using the options argument, it is possible to combine different types of listeners:

\n\n

A delayed, one-time listener.

\n\n
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
\n\n

Attaching multiple handlers in 1 call

\n\n

The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:

\n\n
myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n

One can also specify options for each event handler separately:

\n\n
myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n", + "name": "options" + } + ], + "name": "addListener", + "owner": "Ext.util.Observable", + "doc": "

Appends an event handler to this object.

\n", + "linenr": 278, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "

The method the event invokes.

\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addManagedListener", + "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable/Element", + "optional": false, + "doc": "

The item to which to add a listener/listeners.

\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "

The event name, or an object containing event name properties.

\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the handler function.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", + "name": "scope" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the\naddListener options.

\n", + "name": "opt" + } + ], + "name": "addManagedListener", + "owner": "Ext.util.Observable", + "doc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.

\n", + "linenr": 156, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.

\n", - "optional": true + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-addStatics", + "shortDoc": "Add / override static properties of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "addStatics", + "owner": "Ext.Base", + "doc": "

Add / override static properties of this class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n
\n", + "linenr": 388, + "return": { + "type": "Ext.Base", + "doc": "

this

\n" }, - { - "type": "Object", - "name": "options", - "doc": "

(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:


\n\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n

myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
.\n

\n\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 271, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addListener", - "shortDoc": "

Appends an event handler to this object.

\n" - }, - { - "tagname": "method", - "name": "addManagedListener", - "member": "Ext.util.Observable", - "doc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n", - "params": [ - { - "type": "Observable/Element", - "name": "item", - "doc": "

The item to which to add a listener/listeners.

\n", - "optional": false - }, - { - "type": "Object/String", - "name": "ename", - "doc": "

The event name, or an object containing event name properties.

\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "

Optional. If the ename parameter was an event name, this\nis the handler function.

\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callOverridden", + "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "

The arguments, either an array or the arguments object

\n", + "name": "args" + } + ], + "name": "callOverridden", + "owner": "Ext.Base", + "doc": "

Call the original method that was previously overridden with Ext.Base.override

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n", + "linenr": 269, + "return": { + "type": "Mixed", + "doc": "

Returns the result after calling the overridden method

\n" }, - { - "type": "Object", - "name": "opt", - "doc": "

Optional. If the ename parameter was an event name, this\nis the addListener options.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 155, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addManagedListener", - "shortDoc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n" - }, - { - "tagname": "method", - "name": "capture", - "member": "Ext.util.Observable", - "doc": "

Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.

\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "

The Observable to capture events from.

\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "

The function to call when an event is fired.

\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 55, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-capture", - "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..." - }, - { - "tagname": "method", - "name": "clearListeners", - "member": "Ext.util.Observable", - "doc": "

Removes all listeners for this object including the managed listeners

\n", - "params": [ + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callParent", + "shortDoc": "Call the parent's overridden method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "

The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

\n", + "name": "args" + } + ], + "name": "callParent", + "owner": "Ext.Base", + "doc": "

Call the parent's overridden method. For example:

\n\n
Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n
\n", + "linenr": 124, + "return": { + "type": "Mixed", + "doc": "

Returns the result from the superclass' method

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-capture", + "shortDoc": "Starts capture on the specified Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "

The Observable to capture events from.

\n", + "name": "o" + }, + { + "type": "Function", + "optional": false, + "doc": "

The function to call when an event is fired.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to\nthe Observable firing the event.

\n", + "name": "scope" + } + ], + "name": "capture", + "owner": "Ext.util.Observable", + "doc": "

Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.

\n", + "linenr": 54, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearListeners", + "shortDoc": "Removes all listeners for this object including the managed listeners ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 383, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearListeners", - "shortDoc": "

Removes all listeners for this object including the managed listeners

\n" - }, - { - "tagname": "method", - "name": "clearManagedListeners", - "member": "Ext.util.Observable", - "doc": "

Removes all managed listeners for this object.

\n", - "params": [ + ], + "name": "clearListeners", + "owner": "Ext.util.Observable", + "doc": "

Removes all listeners for this object including the managed listeners

\n", + "linenr": 425, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", + "shortDoc": "Removes all managed listeners for this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 412, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", - "shortDoc": "

Removes all managed listeners for this object.

\n" - }, - { - "tagname": "method", - "name": "enableBubble", - "member": "Ext.util.Observable", - "doc": "

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.

\n\n\n

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.

\n\n\n

Example:

\n\n\n
Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n
\n\n", - "params": [ - { - "type": "String/Array", - "name": "events", - "doc": "

The event name to bubble, or an Array of event names.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 554, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-enableBubble", - "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." - }, - { - "tagname": "method", - "name": "fireEvent", - "member": "Ext.util.Observable", - "doc": "

Fires the specified event with the passed parameters (minus the event name).

\n\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.

\n\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The name of the event to fire.

\n", - "optional": false - }, - { - "type": "Object...", - "name": "args", - "doc": "

Variable number of parameters are passed to handlers.

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

returns false if any of the handlers return false otherwise it returns true.

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 232, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-fireEvent", - "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..." - }, - { - "tagname": "method", - "name": "getItemForPoint", - "member": "Ext.chart.series.Series", - "doc": "

For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.

\n", - "params": [ - { - "type": "Number", - "name": "x", - "doc": "\n", - "optional": false - }, - { - "type": "Number", - "name": "y", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "

An object describing the item, or null if there is no matching item. The exact contents of

\n\n
             this object will vary by series type, but should always contain at least the following:\n             <ul>\n               <li>{Ext.chart.series.Series} series - the Series object to which the item belongs</li>\n               <li>{Object} value - the value(s) of the item's data point</li>\n               <li>{Array} point - the x/y coordinates relative to the chart box of a single point\n                   for this data item, which can be used as e.g. a tooltip anchor point.</li>\n               <li>{Ext.draw.Sprite} sprite - the item's rendering Sprite.\n             </ul>\n
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 241, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-method-getItemForPoint", - "shortDoc": "

For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.

\n" - }, - { - "tagname": "method", - "name": "getLegendColor", - "member": "Ext.chart.series.Series", - "doc": "

Returns a string with the color to be used for the series legend item.

\n", - "params": [ - { - "type": "Object", - "name": "index", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 321, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-method-getLegendColor", - "shortDoc": "

Returns a string with the color to be used for the series legend item.

\n" - }, - { - "tagname": "method", - "name": "hasListener", - "member": "Ext.util.Observable", - "doc": "

Checks to see if this object has any listeners for a specified event

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The name of the event to check for

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

True if the event is being listened for, else false

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 480, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-hasListener", - "shortDoc": "

Checks to see if this object has any listeners for a specified event

\n" - }, - { - "tagname": "method", - "name": "hideAll", - "member": "Ext.chart.series.Series", - "doc": "

Hides all the elements in the series.

\n", - "params": [ + ], + "name": "clearManagedListeners", + "owner": "Ext.util.Observable", + "doc": "

Removes all managed listeners for this object.

\n", + "linenr": 454, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-create", + "shortDoc": "Create a new instance of this Class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 282, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-method-hideAll", - "shortDoc": "

Hides all the elements in the series.

\n" - }, - { - "tagname": "method", - "name": "highlightItem", - "member": "Ext.chart.Highlight", - "doc": "

Highlight the given series item.

\n", - "params": [ - { + ], + "name": "create", + "owner": "Ext.Base", + "doc": "

Create a new instance of this Class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
\n\n

All parameters are passed to the constructor of the class.

\n", + "linenr": 329, + "return": { "type": "Object", - "name": "item", - "doc": "

Info about the item; same format as returned by #getItemForPoint.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js", - "linenr": 38, - "html_filename": "Highlight.html", - "href": "Highlight.html#Ext-chart-Highlight-method-highlightItem", - "shortDoc": "

Highlight the given series item.

\n" - }, - { - "tagname": "method", - "name": "observe", - "member": "Ext.util.Observable", - "doc": "

Sets observability on the passed class constructor.

\n\n

This makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.

\n\n

Usage:

\n\n
Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n
\n", - "params": [ - { - "type": "Function", - "name": "c", - "doc": "

The class constructor to make observable.

\n", - "optional": false - }, - { - "type": "Object", - "name": "listeners", - "doc": "

An object containing a series of listeners to add. See addListener.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 69, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-observe", - "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..." - }, - { - "tagname": "method", - "name": "on", - "member": "Ext.util.Observable", - "doc": "

Appends an event handler to this object (shorthand for addListener.)

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The type of event to listen for

\n", - "optional": false + "doc": "

the created instance.

\n" }, - { - "type": "Function", - "name": "handler", - "doc": "

The method the event invokes

\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-createAlias", + "shortDoc": "Create aliases for existing prototype methods. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "String/Object", + "optional": false, + "doc": "

The new method name, or an object to set multiple aliases. See\nflexSetter

\n", + "name": "alias" + }, + { + "type": "String/Object", + "optional": false, + "doc": "

The original method name

\n", + "name": "origin" + } + ], + "name": "createAlias", + "owner": "Ext.Base", + "doc": "

Create aliases for existing prototype methods. Example:

\n\n
Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\n", + "linenr": 648, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.

\n", - "optional": true + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String/[String]", + "optional": false, + "doc": "

The event name to bubble, or an Array of event names.

\n", + "name": "events" + } + ], + "name": "enableBubble", + "owner": "Ext.util.Observable", + "doc": "

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.

\n\n

This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.

\n\n

Example:

\n\n
Ext.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n
\n", + "linenr": 609, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "options", - "doc": "

(optional) An object containing handler configuration.

\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 616, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-on", - "shortDoc": "

Appends an event handler to this object (shorthand for addListener.)

\n" - }, - { - "tagname": "method", - "name": "relayEvents", - "member": "Ext.util.Observable", - "doc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n", - "params": [ - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-fireEvent", + "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The name of the event to fire.

\n", + "name": "eventName" + }, + { + "type": "Object...", + "optional": false, + "doc": "

Variable number of parameters are passed to handlers.

\n", + "name": "args" + } + ], + "name": "fireEvent", + "owner": "Ext.util.Observable", + "doc": "

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

\n", + "linenr": 233, + "return": { + "type": "Boolean", + "doc": "

returns false if any of the handlers return false otherwise it returns true.

\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Series.html#Ext-chart-series-Series-method-getItemForPoint", + "shortDoc": "For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "\n", + "name": "x" + }, + { + "type": "Number", + "optional": false, + "doc": "\n", + "name": "y" + } + ], + "name": "getItemForPoint", + "owner": "Ext.chart.series.Series", + "doc": "

For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.

\n", + "linenr": 241, + "return": { "type": "Object", - "name": "origin", - "doc": "

The Observable whose events this object is to relay.

\n", - "optional": false + "doc": "

An object describing the item, or null if there is no matching item. The exact contents of

\n\n
             this object will vary by series type, but should always contain at least the following:\n             <ul>\n               <li>{Ext.chart.series.Series} series - the Series object to which the item belongs</li>\n               <li>{Object} value - the value(s) of the item's data point</li>\n               <li>{Array} point - the x/y coordinates relative to the chart box of a single point\n                   for this data item, which can be used as e.g. a tooltip anchor point.</li>\n               <li>{Ext.draw.Sprite} sprite - the item's rendering Sprite.\n             </ul>\n
\n" }, - { - "type": "Array", - "name": "events", - "doc": "

Array of event names to relay.

\n", - "optional": false + "html_filename": "Series.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Series.html#Ext-chart-series-Series-method-getLegendColor", + "shortDoc": "Returns a string with the color to be used for the series legend item. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "index" + } + ], + "name": "getLegendColor", + "owner": "Ext.chart.series.Series", + "doc": "

Returns a string with the color to be used for the series legend item.

\n", + "linenr": 321, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "prefix", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 520, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-relayEvents", - "shortDoc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n" - }, - { - "tagname": "method", - "name": "releaseCapture", - "member": "Ext.util.Observable", - "doc": "

Removes all added captures from the Observable.

\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "

The Observable to release

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 46, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-releaseCapture", - "shortDoc": "

Removes all added captures from the Observable.

\n" - }, - { - "tagname": "method", - "name": "removeListener", - "member": "Ext.util.Observable", - "doc": "

Removes an event handler.

\n", - "params": [ - { + "html_filename": "Series.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-getName", + "shortDoc": "Get the current class' name in string format. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "getName", + "owner": "Ext.Base", + "doc": "

Get the current class' name in string format.

\n\n
Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\n", + "linenr": 631, + "return": { "type": "String", - "name": "eventName", - "doc": "

The type of event the handler was associated with.

\n", - "optional": false + "doc": "

className

\n" }, - { - "type": "Function", - "name": "handler", - "doc": "

The handler to remove. This must be a reference to the function passed into the addListener call.

\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "Checks to see if this object has any listeners for a specified event ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The name of the event to check for

\n", + "name": "eventName" + } + ], + "name": "hasListener", + "owner": "Ext.util.Observable", + "doc": "

Checks to see if this object has any listeners for a specified event

\n", + "linenr": 530, + "return": { + "type": "Boolean", + "doc": "

True if the event is being listened for, else false

\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope originally specified for the handler.

\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 352, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-removeListener", - "shortDoc": "

Removes an event handler.

\n" - }, - { - "tagname": "method", - "name": "removeManagedListener", - "member": "Ext.util.Observable", - "doc": "

Removes listeners that were added by the mon method.

\n", - "params": [ - { - "type": "Observable|Element", - "name": "item", - "doc": "

The item from which to remove a listener/listeners.

\n", - "optional": false - }, - { - "type": "Object|String", - "name": "ename", - "doc": "

The event name, or an object containing event name properties.

\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "

Optional. If the ename parameter was an event name, this\nis the handler function.

\n", - "optional": false - }, - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Series.html#Ext-chart-series-Series-method-hideAll", + "shortDoc": "Hides all the elements in the series. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "params": [ + + ], + "name": "hideAll", + "owner": "Ext.chart.series.Series", + "doc": "

Hides all the elements in the series.

\n", + "linenr": 282, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Series.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Highlight.html#Ext-chart-Highlight-method-highlightItem", + "shortDoc": "Highlight the given series item. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

Info about the item; same format as returned by #getItemForPoint.

\n", + "name": "item" + } + ], + "name": "highlightItem", + "owner": "Ext.chart.Highlight", + "doc": "

Highlight the given series item.

\n", + "linenr": 38, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Highlight.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-implement", + "shortDoc": "Add methods / properties to the prototype of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "implement", + "owner": "Ext.Base", + "doc": "

Add methods / properties to the prototype of this class.

\n\n
Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\n", + "linenr": 415, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-initConfig", + "shortDoc": "Initialize configuration for this class. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "config" + } + ], + "name": "initConfig", + "owner": "Ext.Base", + "doc": "

Initialize configuration for this class. a typical example:

\n\n
Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n\n        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n", + "linenr": 63, + "return": { "type": "Object", - "name": "scope", - "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 196, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", - "shortDoc": "

Removes listeners that were added by the mon method.

\n" - }, - { - "tagname": "method", - "name": "resumeEvents", - "member": "Ext.util.Observable", - "doc": "

Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.

\n", - "params": [ + "doc": "

mixins The mixin prototypes as key - value pairs

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addManagedListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-mon", + "shortDoc": "Shorthand for addManagedListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable/Element", + "optional": false, + "doc": "

The item to which to add a listener/listeners.

\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "

The event name, or an object containing event name properties.

\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the handler function.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", + "name": "scope" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the\naddListener options.

\n", + "name": "opt" + } + ], + "name": "mon", + "owner": "Ext.util.Observable", + "doc": "

Shorthand for addManagedListener.

\n\n

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.

\n", + "linenr": 681, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeManagedListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-mun", + "shortDoc": "Shorthand for removeManagedListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable|Element", + "optional": false, + "doc": "

The item from which to remove a listener/listeners.

\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "

The event name, or an object containing event name properties.

\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "

Optional. If the ename parameter was an event name, this is the handler function.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": false, + "doc": "

Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", + "name": "scope" + } + ], + "name": "mun", + "owner": "Ext.util.Observable", + "doc": "

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n", + "linenr": 687, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-observe", + "shortDoc": "Sets observability on the passed class constructor. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Function", + "optional": false, + "doc": "

The class constructor to make observable.

\n", + "name": "c" + }, + { + "type": "Object", + "optional": false, + "doc": "

An object containing a series of listeners to add. See addListener.

\n", + "name": "listeners" + } + ], + "name": "observe", + "owner": "Ext.util.Observable", + "doc": "

Sets observability on the passed class constructor.

\n\n

This makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.

\n\n

Usage:

\n\n
Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n
\n", + "linenr": 69, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-on", + "shortDoc": "Shorthand for addListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The name of the event to listen for. May also be an object who's property names are\nevent names.

\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "

The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.

\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.

\n", + "name": "scope" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) An object containing handler configuration.

\n\n

Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

\n\n

This object may contain any of the following properties:

\n\n\n\n\n

Combining Options

\n\n

Using the options argument, it is possible to combine different types of listeners:

\n\n

A delayed, one-time listener.

\n\n
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
\n\n

Attaching multiple handlers in 1 call

\n\n

The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:

\n\n
myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n

One can also specify options for each event handler separately:

\n\n
myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n", + "name": "options" + } + ], + "name": "on", + "owner": "Ext.util.Observable", + "doc": "

Shorthand for addListener.

\n\n

Appends an event handler to this object.

\n", + "linenr": 669, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-override", + "shortDoc": "Override prototype members of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "override", + "owner": "Ext.Base", + "doc": "

Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n", + "linenr": 518, + "return": { + "type": "Ext.Base", + "doc": "

this

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-relayEvents", + "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

The Observable whose events this object is to relay.

\n", + "name": "origin" + }, + { + "type": "[String]", + "optional": false, + "doc": "

Array of event names to relay.

\n", + "name": "events" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "prefix" + } + ], + "name": "relayEvents", + "owner": "Ext.util.Observable", + "doc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n", + "linenr": 573, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-releaseCapture", + "shortDoc": "Removes all added captures from the Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "

The Observable to release

\n", + "name": "o" + } + ], + "name": "releaseCapture", + "owner": "Ext.util.Observable", + "doc": "

Removes all added captures from the Observable.

\n", + "linenr": 44, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeListener", + "shortDoc": "Removes an event handler. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The type of event the handler was associated with.

\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "

The handler to remove. This must be a reference to the function passed into the\naddListener call.

\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope originally specified for the handler.

\n", + "name": "scope" + } + ], + "name": "removeListener", + "owner": "Ext.util.Observable", + "doc": "

Removes an event handler.

\n", + "linenr": 392, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", + "shortDoc": "Removes listeners that were added by the mon method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable|Element", + "optional": false, + "doc": "

The item from which to remove a listener/listeners.

\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "

The event name, or an object containing event name properties.

\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "

Optional. If the ename parameter was an event name, this is the handler function.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": false, + "doc": "

Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", + "name": "scope" + } + ], + "name": "removeManagedListener", + "owner": "Ext.util.Observable", + "doc": "

Removes listeners that were added by the mon method.

\n", + "linenr": 197, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-resumeEvents", + "shortDoc": "Resumes firing events (see suspendEvents). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 502, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-resumeEvents", - "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..." - }, - { - "tagname": "method", - "name": "setTitle", - "member": "Ext.chart.series.Series", - "doc": "

Changes the value of the title for the series.\nArguments can take two forms:

\n\n\n\n", - "params": [ - { - "type": "Number", - "name": "index", - "doc": "\n", - "optional": false - }, - { - "type": "String", - "name": "title", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 350, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-method-setTitle", - "shortDoc": "Changes the value of the title for the series.\nArguments can take two forms:\n\n\nA single String value: this will be us..." - }, - { - "tagname": "method", - "name": "showAll", - "member": "Ext.chart.series.Series", - "doc": "

Shows all the elements in the series.

\n", - "params": [ + ], + "name": "resumeEvents", + "owner": "Ext.util.Observable", + "doc": "

Resumes firing events (see suspendEvents).

\n\n

If events were suspended using the **queueSuspended** parameter, then all events fired\nduring event suspension will be sent to any listeners now.

\n", + "linenr": 554, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Series.html#Ext-chart-series-Series-method-setTitle", + "shortDoc": "Changes the value of the title for the series. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "\n", + "name": "index" + }, + { + "type": "String", + "optional": false, + "doc": "\n", + "name": "title" + } + ], + "name": "setTitle", + "owner": "Ext.chart.series.Series", + "doc": "

Changes the value of the title for the series.\nArguments can take two forms:

\n\n\n\n", + "linenr": 350, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Series.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Series.html#Ext-chart-series-Series-method-showAll", + "shortDoc": "Shows all the elements in the series. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 308, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-method-showAll", - "shortDoc": "

Shows all the elements in the series.

\n" - }, - { - "tagname": "method", - "name": "suspendEvents", - "member": "Ext.util.Observable", - "doc": "

Suspend the firing of all events. (see resumeEvents)

\n", - "params": [ - { - "type": "Boolean", - "name": "queueSuspended", - "doc": "

Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 490, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-suspendEvents", - "shortDoc": "

Suspend the firing of all events. (see resumeEvents)

\n" - }, - { - "tagname": "method", - "name": "un", - "member": "Ext.util.Observable", - "doc": "

Removes an event handler (shorthand for removeListener.)

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The type of event the handler was associated with.

\n", - "optional": false + ], + "name": "showAll", + "owner": "Ext.chart.series.Series", + "doc": "

Shows all the elements in the series.

\n", + "linenr": 308, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "

The handler to remove. This must be a reference to the function passed into the addListener call.

\n", - "optional": false + "html_filename": "Series.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-statics", + "shortDoc": "Get the reference to the class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "statics", + "owner": "Ext.Base", + "doc": "

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n
Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n\n        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n
\n", + "linenr": 199, + "return": { + "type": "Class", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope originally specified for the handler.

\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 608, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-un", - "shortDoc": "

Removes an event handler (shorthand for removeListener.)

\n" - }, - { - "tagname": "method", - "name": "unHighlightItem", - "member": "Ext.chart.Highlight", - "doc": "

Un-highlight any existing highlights

\n", - "params": [ + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-suspendEvents", + "shortDoc": "Suspends the firing of all events. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": false, + "doc": "

Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.

\n", + "name": "queueSuspended" + } + ], + "name": "suspendEvents", + "owner": "Ext.util.Observable", + "doc": "

Suspends the firing of all events. (see resumeEvents)

\n", + "linenr": 541, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-un", + "shortDoc": "Shorthand for removeListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The type of event the handler was associated with.

\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "

The handler to remove. This must be a reference to the function passed into the\naddListener call.

\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope originally specified for the handler.

\n", + "name": "scope" + } + ], + "name": "un", + "owner": "Ext.util.Observable", + "doc": "

Shorthand for removeListener.

\n\n

Removes an event handler.

\n", + "linenr": 675, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Highlight.html#Ext-chart-Highlight-method-unHighlightItem", + "shortDoc": "Un-highlight any existing highlights ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js", - "linenr": 109, - "html_filename": "Highlight.html", - "href": "Highlight.html#Ext-chart-Highlight-method-unHighlightItem", - "shortDoc": "

Un-highlight any existing highlights

\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "highlight", - "member": "Ext.chart.Highlight", - "type": "Boolean", - "doc": "

Highlight the given series item.

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js", - "linenr": 13, - "html_filename": "Highlight.html", - "href": "Highlight.html#Ext-chart-Highlight-property-highlight" - } - ], - "event": [ - { - "tagname": "event", - "name": "titlechange", - "member": "Ext.chart.series.Series", - "doc": "

Fires when the series title is changed via setTitle.

\n", - "params": [ - { - "type": "String", - "name": "title", - "doc": "

The new title value

\n", - "optional": false - }, - { - "type": "Number", - "name": "index", - "doc": "

The index in the collection of titles

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 139, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series-event-titlechange", - "shortDoc": "

Fires when the series title is changed via setTitle.

\n" - } - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js", - "linenr": 1, - "html_filename": "Series.html", - "href": "Series.html#Ext-chart-series-Series", - "cssVar": [ + ], + "name": "unHighlightItem", + "owner": "Ext.chart.Highlight", + "doc": "

Un-highlight any existing highlights

\n", + "linenr": 106, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Highlight.html" + } + ], + "property": [ + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Highlight.html#Ext-chart-Highlight-property-highlight", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js", + "private": false, + "name": "highlight", + "owner": "Ext.chart.Highlight", + "doc": "

Highlight the given series item.

\n", + "linenr": 13, + "html_filename": "Highlight.html" + }, + { + "type": "Class", + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "property", + "href": "Base3.html#Ext-Base-property-self", + "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "name": "self", + "owner": "Ext.Base", + "doc": "

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison

\n\n
Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); / dependent on 'this'\n\n        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n
\n", + "linenr": 18, + "html_filename": "Base3.html" + } + ], + "cssVar": [ - ], - "cssMixin": [ + ], + "cssMixin": [ - ], - "component": false, + ], + "event": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "Series.html#Ext-chart-series-Series-event-titlechange", + "shortDoc": "Fires when the series title is changed via setTitle. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The new title value

\n", + "name": "title" + }, + { + "type": "Number", + "optional": false, + "doc": "

The index in the collection of titles

\n", + "name": "index" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "titlechange", + "owner": "Ext.chart.series.Series", + "doc": "

Fires when the series title is changed via setTitle.

\n", + "linenr": 139, + "html_filename": "Series.html" + } + ] + }, + "singleton": false, + "alias": null, "superclasses": [ - + "Ext.Base" + ], + "protected": false, + "tagname": "class", + "mixins": [ + "Ext.util.Observable", + "Ext.chart.Label", + "Ext.chart.Highlight", + "Ext.chart.Tip", + "Ext.chart.Callout" ], + "href": "Series.html#Ext-chart-series-Series", "subclasses": [ - "Ext.chart.series.Cartesian", "Ext.chart.series.Gauge", + "Ext.chart.series.Cartesian", "Ext.chart.series.Pie", "Ext.chart.series.Radar" ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.chart.series.Series", + "doc": "

Series is the abstract class containing the common logic to all chart series. Series includes\nmethods from Labels, Highlights, Tips and Callouts mixins. This class implements the logic of handling\nmouse events, animating, hiding, showing all elements and returning the color of the series to be used as a legend item.

\n\n

Listeners

\n\n

The series class supports listeners via the Observable syntax. Some of these listeners are:

\n\n\n\n\n

For example:

\n\n
series: [{\n        type: 'column',\n        axis: 'left',\n        listeners: {\n                'afterrender': function() {\n                        console('afterrender');\n                }\n        },\n        xField: 'category',\n        yField: 'data1'\n}]\n
\n", "mixedInto": [ ], - "allMixins": [ - "Ext.util.Observable", - "Ext.chart.Label", - "Ext.chart.Highlight", - "Ext.chart.Tip", - "Ext.chart.Callout" - ] + "linenr": 1, + "xtypes": [ + + ], + "html_filename": "Series.html", + "extends": "Ext.Base" }); \ No newline at end of file