X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..refs/heads/master:/docs/output/Ext.chart.series.Pie.js?ds=sidebyside diff --git a/docs/output/Ext.chart.series.Pie.js b/docs/output/Ext.chart.series.Pie.js index 2df3d266..0da876cf 100644 --- a/docs/output/Ext.chart.series.Pie.js +++ b/docs/output/Ext.chart.series.Pie.js @@ -1,1709 +1 @@ -Ext.data.JsonP.Ext_chart_series_Pie({ - "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": "Pie.html#Ext-chart-series-Pie-cfg-angleField", - "shortDoc": "The store record field name to be used for the pie angles. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "name": "angleField", - "owner": "Ext.chart.series.Pie", - "doc": "
The store record field name to be used for the pie angles.\nThe values bound to this field name must be positive real numbers.\nThis parameter is required.
\n", - "linenr": 92, - "html_filename": "Pie.html" - }, - { - "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": "Array", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Pie.html#Ext-chart-series-Pie-cfg-colorSet", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "name": "colorSet", - "owner": "Ext.chart.series.Pie", - "doc": "An array of color values which will be used, in order, as the pie slice fill colors.
\n", - "linenr": 122, - "html_filename": "Pie.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": "Boolean|Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Pie.html#Ext-chart-series-Pie-cfg-donut", - "shortDoc": "Whether to set the pie chart as donut chart. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "name": "donut", - "owner": "Ext.chart.series.Pie", - "doc": "Whether to set the pie chart as donut chart.\nDefault's false. Can be set to a particular percentage to set the radius\nof the donut chart.
\n", - "linenr": 108, - "html_filename": "Pie.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.
The duration for the pie slice highlight effect.
\n", - "linenr": 86, - "html_filename": "Pie.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Pie.html#Ext-chart-series-Pie-cfg-lengthField", - "shortDoc": "The store record field name to be used for the pie slice lengths. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "name": "lengthField", - "owner": "Ext.chart.series.Pie", - "doc": "The store record field name to be used for the pie slice lengths.\nThe values bound to this field name must be positive real numbers.\nThis parameter is optional.
\n", - "linenr": 100, - "html_filename": "Pie.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
<li>itemmouseover</li>\n <li>itemmouseout</li>\n <li>itemmousedown</li>\n <li>itemmouseup</li>\n
\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": "Pie.html#Ext-chart-series-Pie-cfg-showInLegend", - "shortDoc": "Whether to add the pie chart elements as legend items. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "name": "showInLegend", - "owner": "Ext.chart.series.Pie", - "doc": "Whether to add the pie chart elements as legend items. Default's false.
\n", - "linenr": 116, - "html_filename": "Pie.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Pie.html#Ext-chart-series-Pie-cfg-style", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "name": "style", - "owner": "Ext.chart.series.Pie", - "doc": "An object containing styles for overriding series styles from Theming.
\n", - "linenr": 127, - "html_filename": "Pie.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\ntips: {\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:
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\nthis.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.
(optional) The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses 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.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis 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\nThis 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\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.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\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.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.
(optional) If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
(optional) If the ename
parameter was an event name, this is the\naddListener options.
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\nExt.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
Call the original method that was previously overridden with Ext.Base.override
\n\nExt.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)
Call the parent's overridden method. For example:
\n\nExt.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.
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\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll 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\nExt.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": "Pie.html#Ext-chart-series-Pie-method-drawSeries",
- "shortDoc": "Draws the series for the current chart. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js",
- "private": false,
- "params": [
-
- ],
- "name": "drawSeries",
- "owner": "Ext.chart.series.Pie",
- "doc": "Draws the series for the current chart.
\n", - "linenr": 284, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Pie.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.
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\nExample:
\n\nExt.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).
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": "Pie.html#Ext-chart-series-Pie-method-getLegendColor",
- "shortDoc": "Returns the color of the series (to be displayed as color for the series legend item). ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js",
- "private": false,
- "params": [
- {
- "type": "Object",
- "optional": false,
- "doc": "{Object} Info about the item; same format as returned by #getItemForPoint
\n", - "name": "item" - } - ], - "name": "getLegendColor", - "owner": "Ext.chart.series.Pie", - "doc": "Returns the color of the series (to be displayed as color for the series legend item).
\n", - "linenr": 1009, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Pie.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\nExt.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": "Pie.html#Ext-chart-series-Pie-method-highlightItem", - "shortDoc": "Highlight the specified item. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "{Object} Info about the item; same format as returned by #getItemForPoint
\n", - "name": "item" - } - ], - "name": "highlightItem", - "owner": "Ext.chart.series.Pie", - "doc": "Highlight the specified item. If no item is provided the whole series will be highlighted.
\n", - "linenr": 819, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Pie.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\nExt.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\nExt.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.
(optional) If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
(optional) If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for addManagedListener.
\n\nAdds 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.
Optional. If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for removeManagedListener.
\n\nRemoves 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\nThis 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\nUsage:
\n\nExt.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.
(optional) The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses 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.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis 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\nThis 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\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.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\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.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\nAppends 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\nExt.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
.
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.
Optional. If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
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\nIf events were suspended using the **queueSuspended**
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Changes the value of the title for the series.\nArguments can take two forms:
\n\nShows 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
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\nRemoves an event handler.
\n", - "linenr": 675, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Pie.html#Ext-chart-series-Pie-method-unHighlightItem", - "shortDoc": "un-highlights the specified item. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "{Object} Info about the item; same format as returned by #getItemForPoint
\n", - "name": "item" - } - ], - "name": "unHighlightItem", - "owner": "Ext.chart.series.Pie", - "doc": "un-highlights the specified item. If no item is provided it will un-highlight the entire series.
\n", - "linenr": 920, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Pie.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
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", - "Ext.chart.series.Series" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Pie.html#Ext-chart-series-Pie", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Pie.js", - "private": false, - "alternateClassNames": [ - "Ext.chart.PieSeries", - "Ext.chart.PieChart" - ], - "name": "Ext.chart.series.Pie", - "doc": "Creates a Pie Chart. A Pie Chart is a useful visualization technique to display quantitative information for different\ncategories that also have a meaning as a whole.\nAs with all other series, the Pie Series must be appended in the series Chart array configuration. See the Chart\ndocumentation for more information. A typical configuration object for the pie series could be:
\n\n\n\nvar store = Ext.create('Ext.data.JsonStore', {\n fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'],\n data: [\n {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13},\n {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3},\n {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7},\n {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23},\n {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} \n ]\n});\n\nExt.create('Ext.chart.Chart', {\n renderTo: Ext.getBody(),\n width: 500,\n height: 300,\n animate: true,\n store: store,\n theme: 'Base:gradients',\n series: [{\n type: 'pie',\n field: 'data1',\n showInLegend: true,\n tips: {\n trackMouse: true,\n width: 140,\n height: 28,\n renderer: function(storeItem, item) {\n //calculate and display percentage on hover\n var total = 0;\n store.each(function(rec) {\n total += rec.get('data1');\n });\n this.setTitle(storeItem.get('name') + ': ' + Math.round(storeItem.get('data1') / total * 100) + '%');\n }\n },\n highlight: {\n segment: {\n margin: 20\n }\n },\n label: {\n field: 'name',\n display: 'rotate',\n contrast: true,\n font: '18px Arial'\n }\n }] \n});\n
\n\nIn this configuration we set pie
as the type for the series, set an object with specific style properties for highlighting options\n(triggered when hovering elements). We also set true to showInLegend
so all the pie slices can be represented by a legend item.\nWe set data1
as the value of the field to determine the angle span for each pie slice. We also set a label configuration object\nwhere we set the field name of the store field to be renderer as text for the label. The labels will also be displayed rotated.\nWe set contrast
to true
to flip the color of the label if it is to similar to the background color. Finally, we set the font family\nand size through the font
parameter.
Alternate names
Ext.chart.PieSeriesExt.chart.PieChartHierarchy
Ext.BaseExt.chart.series.SeriesExt.chart.series.PieMixins
Files
Creates a Pie Chart. A Pie Chart is a useful visualization technique to display quantitative information for different\ncategories that also have a meaning as a whole.\nAs with all other series, the Pie Series must be appended in the series Chart array configuration. See the Chart\ndocumentation for more information. A typical configuration object for the pie series could be:
\n\nvar store = Ext.create('Ext.data.JsonStore', {\n fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'],\n data: [\n { 'name': 'metric one', 'data1': 10, 'data2': 12, 'data3': 14, 'data4': 8, 'data5': 13 },\n { 'name': 'metric two', 'data1': 7, 'data2': 8, 'data3': 16, 'data4': 10, 'data5': 3 },\n { 'name': 'metric three', 'data1': 5, 'data2': 2, 'data3': 14, 'data4': 12, 'data5': 7 },\n { 'name': 'metric four', 'data1': 2, 'data2': 14, 'data3': 6, 'data4': 1, 'data5': 23 },\n { 'name': 'metric five', 'data1': 27, 'data2': 38, 'data3': 36, 'data4': 13, 'data5': 33 }\n ]\n});\n\nExt.create('Ext.chart.Chart', {\n renderTo: Ext.getBody(),\n width: 500,\n height: 350,\n animate: true,\n store: store,\n theme: 'Base:gradients',\n series: [{\n type: 'pie',\n field: 'data1',\n showInLegend: true,\n tips: {\n trackMouse: true,\n width: 140,\n height: 28,\n renderer: function(storeItem, item) {\n // calculate and display percentage on hover\n var total = 0;\n store.each(function(rec) {\n total += rec.get('data1');\n });\n this.setTitle(storeItem.get('name') + ': ' + Math.round(storeItem.get('data1') / total * 100) + '%');\n }\n },\n highlight: {\n segment: {\n margin: 20\n }\n },\n label: {\n field: 'name',\n display: 'rotate',\n contrast: true,\n font: '18px Arial'\n }\n }]\n});\n
\n\nIn this configuration we set pie
as the type for the series, set an object with specific style properties for highlighting options\n(triggered when hovering elements). We also set true to showInLegend
so all the pie slices can be represented by a legend item.
We set data1
as the value of the field to determine the angle span for each pie slice. We also set a label configuration object\nwhere we set the field name of the store field to be renderer as text for the label. The labels will also be displayed rotated.
We set contrast
to true
to flip the color of the label if it is to similar to the background color. Finally, we set the font family\nand size through the font
parameter.
The store record field name to be used for the pie angles.\nThe values bound to this field name must be positive real numbers.
\nDefaults to: false
An array of color values which will be used, in order, as the pie slice fill colors.
\nAn array of color values which will be used, in order, as the pie slice fill colors.
\nWhether to set the pie chart as donut chart.\nDefault's false. Can be set to a particular percentage to set the radius\nof the donut chart.
\nDefaults to: false
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.
The duration for the pie slice highlight effect.
\nDefaults to: 150
Object with the following properties:
\n\ndisplay : String
\n\nSpecifies 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'.
color : String
\n\nThe color of the label text.\nDefault value: '#000' (black).
contrast : Boolean
\n\nTrue to render the label in contrasting color with the backround.\nDefault value: false.
field : String
\n\nThe name of the field to be displayed in the label.\nDefault value: 'name'.
minMargin : Number
\n\nSpecifies 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.
font : String
\n\nThe font used for the labels.\nDefault value: \"11px Helvetica, sans-serif\".
orientation : String
\n\nEither \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".
renderer : Function
\n\nOptional function for formatting the label into a displayable value.\nDefault value: function(v) { return v; }
The store record field name to be used for the pie slice lengths.\nThe values bound to this field name must be positive real numbers.
\nDefaults to: false
An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback functions are:
\n\nA function that can be overridden to set custom styling properties to each rendered element.\nPasses in (sprite, record, attributes, index, store) to the function.
\nWhether to add the pie chart elements as legend items. Default's false.
\nDefaults to: false
An object containing styles for overriding series styles from Theming.
\nDefaults to: {}
Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with Ext.tip.ToolTip. For example:
\n\ntips: {\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
\nGet 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
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
\nAdds the specified events to the list of events which this Observable may fire.
\nEither 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:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses 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.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis 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\nThis 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\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe 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\nmyGridPanel.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\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Call the original method that was previously overridden with override
\n\nExt.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
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.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
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRemoves all listeners for this object including the managed listeners
\nIterate 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.
\nEnables 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.
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\nExample:
\n\nExt.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
\nFires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nFor a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.
\nAn 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:
\nthe Series object to which the item belongs
\nthe value(s) of the item's data point
\nthe 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.
\nthe item's rendering Sprite.
\nReturns the color of the series (to be displayed as color for the series legend item).
\n{Object} Info about the item; same format as returned by #getItemForPoint
\nReturn 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.
\nHighlight the specified item. If no item is provided the whole series will be highlighted.
\n{Object} Info about the item; same format as returned by #getItemForPoint
\nInitialize configuration for this class. a typical example:
\n\nExt.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
\nmixins The mixin prototypes as key - value pairs
\nDetermines whether the series item at the given index has been excluded, i.e. toggled off in the legend.
\nShorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses 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.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis 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\nThis 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\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe 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\nmyGridPanel.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\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe 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\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the queueSuspended
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Changes the value of the title for the series.\nArguments can take two forms:
\n\nGet 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
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
\nSuspends the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\nShorthand for removeListener.
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe 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\nUn-highlights the specified item. If no item is provided it will un-highlight the entire series.
\n{Object} Info about the item; same format as returned by #getItemForPoint
\nAdd / override static properties of this class.
\n\nExt.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
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.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
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.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
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.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
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.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
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.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
\nthis
\nFires when the series title is changed via setTitle.
\nThe new title value
\nThe index in the collection of titles
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\n