X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/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 f4c145bb..6bc5be51 100644 --- a/docs/output/Ext.chart.series.Series.js +++ b/docs/output/Ext.chart.series.Series.js @@ -1,1586 +1 @@ -Ext.data.JsonP.Ext_chart_series_Series({ - "allMixins": [ - "Ext.util.Observable", - "Ext.chart.Label", - "Ext.chart.Highlight", - "Ext.chart.Tip", - "Ext.chart.Callout" - ], - "deprecated": null, - "docauthor": null, - "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" - }, - "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" - }, - "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" - }, - "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" - }, - "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": [ - - ], - "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": [ - - ], - "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": [ - - ], - "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", - "doc": "

the created instance.

\n" - }, - "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" - }, - "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" - }, - "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", - "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" - }, - "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" - }, - "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", - "doc": "

className

\n" - }, - "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" - }, - "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", - "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": [ - - ], - "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": [ - - ], - "name": "showAll", - "owner": "Ext.chart.series.Series", - "doc": "

Shows all the elements in the series.

\n", - "linenr": 308, - "return": { - "type": "void", - "doc": "\n" - }, - "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" - }, - "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": [ - - ], - "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": [ - - ], - "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.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": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "Series.html", - "extends": "Ext.Base" -}); \ No newline at end of file +Ext.data.JsonP.Ext_chart_series_Series({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.chart.series.Series

Mixins

Files

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
Defined By

Config options

If set to true it will highlight the markers or the series when hovering\nwith the mouse. ...

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
Object with the following properties:\n\n\ndisplay : String\n\nSpecifies the presence and position of labels for each pie ...

Object with the following properties:

\n\n
    \n
  • display : String

    \n\n

    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
  • color : String

    \n\n

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

  • \n
  • contrast : Boolean

    \n\n

    True to render the label in contrasting color with the backround.\nDefault value: false.

  • \n
  • field : String

    \n\n

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

  • \n
  • minMargin : Number

    \n\n

    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
  • font : String

    \n\n

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

  • \n
  • orientation : String

    \n\n

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

  • \n
  • renderer : Function

    \n\n

    Optional function for formatting the label into a displayable value.\nDefault value: function(v) { return v; }

  • \n
\n\n
An (optional) object with event callbacks. ...

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

\n\n
    \n
  • itemmouseover
  • \n
  • itemmouseout
  • \n
  • itemmousedown
  • \n
  • itemmouseup
  • \n
\n\n
A function that can be overridden to set custom styling properties to each rendered element. ...

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
An array with shadow attributes ...

An array with shadow attributes

\n

Defaults to: null

Whether to show this series in the legend. ...

Whether to show this series in the legend.

\n

Defaults to: true

Add tooltips to the visualization's markers. ...

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
The human-readable name of the series. ...

The human-readable name of the series.

\n

Defaults to: null

The type of series. ...

The type of series. Set in subclasses.

\n

Defaults to: null

Defined By

Properties

 

Highlight the given series item.

\n

Highlight the given series item.

\n
Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See 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

Methods

Defined By

Instance Methods

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

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

\n

Parameters

  • o : Object/String

    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
  • more : String... (optional)

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

    \n\n
    this.addEvents('storeloaded', 'storecleared');\n
    \n
Appends an event handler to this object. ...

Appends an event handler to this object.

\n

Parameters

  • eventName : String

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

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

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

    \n\n
  • options : Object (optional)

    An object containing handler configuration.

    \n\n\n\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\n\n\n

    This object may contain any of the following properties:

    \n\n\n\n\n
      \n
    • scope : Object

      \n\n

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

    • \n
    • delay : Number

      \n\n

      The number of milliseconds to delay the invocation of the handler after the event fires.

    • \n
    • single : Boolean

      \n\n

      True to add a handler to handle just the next firing of the event, and then remove itself.

    • \n
    • buffer : Number

      \n\n

      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.

    • \n
    • target : Observable

      \n\n

      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.

    • \n
    • element : String

      \n\n

      This option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.

      \n\n

      This option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:

      \n\n
      new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n
    • \n
    \n\n\n\n\n

    Combining Options

    \n\n\n\n\n

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

    \n\n\n\n\n

    A delayed, one-time listener.

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

    Attaching multiple handlers in 1 call

    \n\n\n\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\n\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\n\n\n

    One can also specify options for each event handler separately:

    \n\n\n\n\n
    myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
    \n\n
Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestr...

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

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

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

    \n\n
  • opt : Object (optional)

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

    \n\n
( Array/Arguments args ) : Objectprotected
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with 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

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

    \n

Returns

  • Object

    Returns the result after calling the overridden method

    \n
( Array/Arguments args ) : Objectprotected
Call the parent's overridden method. ...

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

Parameters

  • args : Array/Arguments

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

    \n

Returns

  • Object

    Returns the result from the superclass' method

    \n
Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

\n
Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

\n
Iterate over each of the records for this series. ...

Iterate over each of the records for this series. The default implementation simply iterates\nthrough the entire data store, but individual series implementations can override this to\nprovide custom handling, e.g. adding/removing records.

\n

Parameters

  • fn : Function

    The function to execute for each record.

    \n
  • scope : Object

    Scope for the fn.

    \n
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...

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

Parameters

  • events : String/String[]

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

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

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

Parameters

  • eventName : String

    The name of the event to fire.

    \n
  • args : Object...

    Variable number of parameters are passed to handlers.

    \n

Returns

  • Boolean

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

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

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

\n

Parameters

Returns

  • Object

    An object describing the item, or null if there is no matching item.\nThe exact contents of this object will vary by series type, but should always contain the following:

    \n
    • series : Ext.chart.series.Series

      the Series object to which the item belongs

      \n
    • value : Object

      the value(s) of the item's data point

      \n
    • point : Array

      the x/y coordinates relative to the chart box of a single point\nfor this data item, which can be used as e.g. a tooltip anchor point.

      \n
    • sprite : Ext.draw.Sprite

      the item's rendering Sprite.

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

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

\n

Parameters

Return the number of records being displayed in this series. ...

Return the number of records being displayed in this series. Defaults to the number of\nrecords in the store; individual series implementations can override to provide custom handling.

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

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

\n

Parameters

  • eventName : String

    The name of the event to check for

    \n

Returns

  • Boolean

    True if the event is being listened for, else false

    \n
Hides all the elements in the series. ...

Hides all the elements in the series.

\n
Highlight the given series item. ...

Highlight the given series item.

\n

Parameters

  • item : Object

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

    \n
Initialize configuration for this class. ...

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

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

    \n
Determines whether the series item at the given index has been excluded, i.e. ...

Determines whether the series item at the given index has been excluded, i.e. toggled off in the legend.

\n

Parameters

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

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

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

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

    \n\n
  • opt : Object (optional)

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

    \n\n
Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

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

    \n\n
( String eventName, Function fn, [Object scope], [Object options] )
Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object.

\n

Parameters

  • eventName : String

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

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

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

    \n\n
  • options : Object (optional)

    An object containing handler configuration.

    \n\n\n\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\n\n\n

    This object may contain any of the following properties:

    \n\n\n\n\n
      \n
    • scope : Object

      \n\n

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

    • \n
    • delay : Number

      \n\n

      The number of milliseconds to delay the invocation of the handler after the event fires.

    • \n
    • single : Boolean

      \n\n

      True to add a handler to handle just the next firing of the event, and then remove itself.

    • \n
    • buffer : Number

      \n\n

      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.

    • \n
    • target : Observable

      \n\n

      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.

    • \n
    • element : String

      \n\n

      This option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.

      \n\n

      This option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:

      \n\n
      new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n
    • \n
    \n\n\n\n\n

    Combining Options

    \n\n\n\n\n

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

    \n\n\n\n\n

    A delayed, one-time listener.

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

    Attaching multiple handlers in 1 call

    \n\n\n\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\n\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\n\n\n

    One can also specify options for each event handler separately:

    \n\n\n\n\n
    myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
    \n\n
Relays selected events from the specified Observable as if the events were fired by this. ...

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

\n

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

    \n
  • events : String[]

    Array of event names to relay.

    \n
  • prefix : String
    \n
Removes an event handler. ...

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.

    \n\n
Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

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

    \n\n
Resumes firing events (see suspendEvents). ...

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
Changes the value of the title for the series. ...

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

\n\n
    \n
  • A single String value: this will be used as the new single title for the series (applies\nto series with only one yField)
  • \n
  • A numeric index and a String value: this will set the title for a single indexed yField.
  • \n
\n\n

Parameters

Shows all the elements in the series. ...

Shows all the elements in the series.

\n
Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike 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

Returns

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

\n

Parameters

  • queueSuspended : Boolean

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

    \n
Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.

    \n\n
Un-highlight any existing highlights ...

Un-highlight any existing highlights

\n
Defined By

Static Methods

Add / override static properties of this class. ...

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

Parameters

Returns

( Ext.Base fromClass, String/String[] members ) : Ext.Basestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n
Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\n

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : String/String[]

    The names of the members to borrow

    \n

Returns

Create a new instance of this Class. ...

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

Returns

Create aliases for existing prototype methods. ...

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

Parameters

Get the current class' name in string format. ...

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

Returns

Add methods / properties to the prototype of this class. ...

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

Parameters

Override prototype members of this class. ...

Override prototype members of this class. Overridden methods can be invoked via\ncallOverridden

\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

Parameters

Returns

Defined By

Events

Fires when the series title is changed via setTitle. ...

Fires when the series title is changed via setTitle.

\n

Parameters

","allMixins":["Ext.util.Observable","Ext.chart.Label","Ext.chart.Highlight","Ext.chart.Tip","Ext.chart.Callout"],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.chart.series.Series"],"singleton":false,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"borrow","id":"static-method-borrow"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"create","id":"static-method-create"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"getName","id":"static-method-getName"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"implement","id":"static-method-implement"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"override","id":"static-method-override"}],"event":[]},"subclasses":["Ext.chart.series.Cartesian","Ext.chart.series.Gauge","Ext.chart.series.Pie","Ext.chart.series.Radar"],"uses":[],"protected":false,"mixins":["Ext.util.Observable","Ext.chart.Label","Ext.chart.Highlight","Ext.chart.Tip","Ext.chart.Callout"],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.chart.Highlight","template":null,"required":null,"protected":false,"name":"highlight","id":"property-highlight"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"}],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":false,"protected":false,"name":"highlight","id":"cfg-highlight"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.Label","template":null,"required":false,"protected":false,"name":"label","id":"cfg-label"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":false,"protected":false,"name":"listeners","id":"cfg-listeners"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":false,"protected":false,"name":"renderer","id":"cfg-renderer"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":false,"protected":false,"name":"shadowAttributes","id":"cfg-shadowAttributes"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":false,"protected":false,"name":"showInLegend","id":"cfg-showInLegend"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":false,"protected":false,"name":"tips","id":"cfg-tips"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":false,"protected":false,"name":"title","id":"cfg-title"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":false,"protected":false,"name":"type","id":"cfg-type"}],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"addEvents","id":"method-addEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"addListener","id":"method-addListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"addManagedListener","id":"method-addManagedListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callParent","id":"method-callParent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"clearListeners","id":"method-clearListeners"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"clearManagedListeners","id":"method-clearManagedListeners"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":false,"required":null,"protected":false,"name":"eachRecord","id":"method-eachRecord"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"enableBubble","id":"method-enableBubble"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"fireEvent","id":"method-fireEvent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":false,"required":null,"protected":false,"name":"getItemForPoint","id":"method-getItemForPoint"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":false,"required":null,"protected":false,"name":"getLegendColor","id":"method-getLegendColor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":false,"required":null,"protected":false,"name":"getRecordCount","id":"method-getRecordCount"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"hasListener","id":"method-hasListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":false,"required":null,"protected":false,"name":"hideAll","id":"method-hideAll"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.Highlight","template":false,"required":null,"protected":false,"name":"highlightItem","id":"method-highlightItem"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":false,"required":null,"protected":false,"name":"isExcluded","id":"method-isExcluded"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"mon","id":"method-mon"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"mun","id":"method-mun"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"on","id":"method-on"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"removeListener","id":"method-removeListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"removeManagedListener","id":"method-removeManagedListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"resumeEvents","id":"method-resumeEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":false,"required":null,"protected":false,"name":"setTitle","id":"method-setTitle"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":false,"required":null,"protected":false,"name":"showAll","id":"method-showAll"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"suspendEvents","id":"method-suspendEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"un","id":"method-un"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.chart.Highlight","template":false,"required":null,"protected":false,"name":"unHighlightItem","id":"method-unHighlightItem"}],"event":[{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.chart.series.Series","template":null,"required":null,"protected":false,"name":"titlechange","id":"event-titlechange"}]},"private":false,"component":false,"name":"Ext.chart.series.Series","alternateClassNames":[],"id":"class-Ext.chart.series.Series","mixedInto":[],"xtypes":{},"files":[{"href":"Series.html#Ext-chart-series-Series","filename":"Series.js"}]}); \ No newline at end of file