Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.chart.series.Series.js
1 Ext.data.JsonP.Ext_chart_series_Series({
2   "tagname": "class",
3   "name": "Ext.chart.series.Series",
4   "doc": "<p>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.</p>\n\n<h2>Listeners</h2>\n\n<p>The series class supports listeners via the Observable syntax. Some of these listeners are:</p>\n\n<ul>\n<li><code>itemmouseup</code> When the user interacts with a marker.</li>\n<li><code>itemmousedown</code> When the user interacts with a marker.</li>\n<li><code>itemmousemove</code> When the user iteracts with a marker.</li>\n<li><code>afterrender</code> Will be triggered when the animation ends or when the series has been rendered completely.</li>\n</ul>\n\n\n<p>For example:</p>\n\n<pre><code>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</code></pre>\n",
5   "extends": null,
6   "mixins": [
7     "Ext.util.Observable",
8     "Ext.chart.Label",
9     "Ext.chart.Highlight",
10     "Ext.chart.Tip",
11     "Ext.chart.Callout"
12   ],
13   "alternateClassNames": [
14
15   ],
16   "xtype": null,
17   "author": null,
18   "docauthor": null,
19   "singleton": false,
20   "private": false,
21   "cfg": [
22     {
23       "tagname": "cfg",
24       "name": "color",
25       "member": "Ext.chart.Label",
26       "type": "String",
27       "doc": "<p>The color of the label text.\nDefault value: '#000' (black).</p>\n",
28       "private": false,
29       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
30       "linenr": 42,
31       "html_filename": "Label2.html",
32       "href": "Label2.html#Ext-chart-Label-cfg-color"
33     },
34     {
35       "tagname": "cfg",
36       "name": "display",
37       "member": "Ext.chart.Label",
38       "type": "String",
39       "doc": "<p>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'.</p>\n",
40       "private": false,
41       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
42       "linenr": 35,
43       "html_filename": "Label2.html",
44       "href": "Label2.html#Ext-chart-Label-cfg-display",
45       "shortDoc": "Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEn..."
46     },
47     {
48       "tagname": "cfg",
49       "name": "field",
50       "member": "Ext.chart.Label",
51       "type": "String",
52       "doc": "<p>The name of the field to be displayed in the label.\nDefault value: 'name'.</p>\n",
53       "private": false,
54       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
55       "linenr": 48,
56       "html_filename": "Label2.html",
57       "href": "Label2.html#Ext-chart-Label-cfg-field"
58     },
59     {
60       "tagname": "cfg",
61       "name": "font",
62       "member": "Ext.chart.Label",
63       "type": "String",
64       "doc": "<p>The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".</p>\n",
65       "private": false,
66       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
67       "linenr": 61,
68       "html_filename": "Label2.html",
69       "href": "Label2.html#Ext-chart-Label-cfg-font"
70     },
71     {
72       "tagname": "cfg",
73       "name": "highlight",
74       "member": "Ext.chart.series.Series",
75       "type": "Boolean|Object",
76       "doc": "<p>If set to <code>true</code> 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 <a href=\"#/api/Ext.draw.Sprite\" rel=\"Ext.draw.Sprite\" class=\"docClass\">Ext.draw.Sprite</a> to apply custom\nstyles to markers and series.</p>\n",
77       "private": false,
78       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
79       "linenr": 46,
80       "html_filename": "Series.html",
81       "href": "Series.html#Ext-chart-series-Series-cfg-highlight",
82       "shortDoc": "If set to true it will highlight the markers or the series when hovering\nwith the mouse. This parameter can also be a..."
83     },
84     {
85       "tagname": "cfg",
86       "name": "listeners",
87       "member": "Ext.chart.series.Series",
88       "type": "Object",
89       "doc": "<p>An (optional) object with event callbacks. All event callbacks get the target <em>item</em> as first parameter. The callback functions are:</p>\n\n<p> <ul></p>\n\n<pre><code> &lt;li&gt;itemmouseover&lt;/li&gt;\n &lt;li&gt;itemmouseout&lt;/li&gt;\n &lt;li&gt;itemmousedown&lt;/li&gt;\n &lt;li&gt;itemmouseup&lt;/li&gt;\n</code></pre>\n\n<p> </ul></p>\n",
90       "private": false,
91       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
92       "linenr": 105,
93       "html_filename": "Series.html",
94       "href": "Series.html#Ext-chart-series-Series-cfg-listeners",
95       "shortDoc": "An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback f..."
96     },
97     {
98       "tagname": "cfg",
99       "name": "minMargin",
100       "member": "Ext.chart.Label",
101       "type": "Number",
102       "doc": "<p>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.</p>\n",
103       "private": false,
104       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
105       "linenr": 54,
106       "html_filename": "Label2.html",
107       "href": "Label2.html#Ext-chart-Label-cfg-minMargin",
108       "shortDoc": "Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using P..."
109     },
110     {
111       "tagname": "cfg",
112       "name": "orientation",
113       "member": "Ext.chart.Label",
114       "type": "String",
115       "doc": "<p>Either \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".</p>\n",
116       "private": false,
117       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
118       "linenr": 67,
119       "html_filename": "Label2.html",
120       "href": "Label2.html#Ext-chart-Label-cfg-orientation"
121     },
122     {
123       "tagname": "cfg",
124       "name": "renderer",
125       "member": "Ext.chart.series.Series",
126       "type": "Function",
127       "doc": "<p>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.</p>\n",
128       "private": false,
129       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
130       "linenr": 87,
131       "html_filename": "Series.html",
132       "href": "Series.html#Ext-chart-series-Series-cfg-renderer",
133       "shortDoc": "A function that can be overridden to set custom styling properties to each rendered element.\nPasses in (sprite, recor..."
134     },
135     {
136       "tagname": "cfg",
137       "name": "shadowAttributes",
138       "member": "Ext.chart.series.Series",
139       "type": "Array",
140       "doc": "<p>An array with shadow attributes</p>\n",
141       "private": false,
142       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
143       "linenr": 96,
144       "html_filename": "Series.html",
145       "href": "Series.html#Ext-chart-series-Series-cfg-shadowAttributes"
146     },
147     {
148       "tagname": "cfg",
149       "name": "showInLegend",
150       "member": "Ext.chart.series.Series",
151       "type": "Boolean",
152       "doc": "<p>Whether to show this series in the legend.</p>\n",
153       "private": false,
154       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
155       "linenr": 81,
156       "html_filename": "Series.html",
157       "href": "Series.html#Ext-chart-series-Series-cfg-showInLegend"
158     },
159     {
160       "tagname": "cfg",
161       "name": "tips",
162       "member": "Ext.chart.series.Series",
163       "type": "Object",
164       "doc": "<p>Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with <a href=\"#/api/Ext.tip.ToolTip\" rel=\"Ext.tip.ToolTip\" class=\"docClass\">Ext.tip.ToolTip</a>. For example:</p>\n\n<pre><code>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</code></pre>\n",
165       "private": false,
166       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
167       "linenr": 54,
168       "html_filename": "Series.html",
169       "href": "Series.html#Ext-chart-series-Series-cfg-tips",
170       "shortDoc": "Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with Ext.tip.To..."
171     },
172     {
173       "tagname": "cfg",
174       "name": "title",
175       "member": "Ext.chart.series.Series",
176       "type": "String",
177       "doc": "<p>The human-readable name of the series.</p>\n",
178       "private": false,
179       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
180       "linenr": 75,
181       "html_filename": "Series.html",
182       "href": "Series.html#Ext-chart-series-Series-cfg-title"
183     },
184     {
185       "tagname": "cfg",
186       "name": "type",
187       "member": "Ext.chart.series.Series",
188       "type": "String",
189       "doc": "<p>The type of series. Set in subclasses.</p>\n",
190       "private": false,
191       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
192       "linenr": 69,
193       "html_filename": "Series.html",
194       "href": "Series.html#Ext-chart-series-Series-cfg-type"
195     }
196   ],
197   "method": [
198     {
199       "tagname": "method",
200       "name": "addEvents",
201       "member": "Ext.util.Observable",
202       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
203       "params": [
204         {
205           "type": "Object/String",
206           "name": "o",
207           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
208           "optional": false
209         },
210         {
211           "type": "String",
212           "name": "",
213           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
214           "optional": false
215         }
216       ],
217       "return": {
218         "type": "void",
219         "doc": "\n"
220       },
221       "private": false,
222       "static": false,
223       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
224       "linenr": 452,
225       "html_filename": "Observable.html",
226       "href": "Observable.html#Ext-util-Observable-method-addEvents",
227       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
228     },
229     {
230       "tagname": "method",
231       "name": "addListener",
232       "member": "Ext.util.Observable",
233       "doc": "<p>Appends an event handler to this object.</p>\n",
234       "params": [
235         {
236           "type": "String",
237           "name": "eventName",
238           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
239           "optional": false
240         },
241         {
242           "type": "Function",
243           "name": "handler",
244           "doc": "<p>The method the event invokes.</p>\n",
245           "optional": false
246         },
247         {
248           "type": "Object",
249           "name": "scope",
250           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
251           "optional": true
252         },
253         {
254           "type": "Object",
255           "name": "options",
256           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>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</code></pre>.\n<p>\n\n",
257           "optional": true
258         }
259       ],
260       "return": {
261         "type": "void",
262         "doc": "\n"
263       },
264       "private": false,
265       "static": false,
266       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
267       "linenr": 271,
268       "html_filename": "Observable.html",
269       "href": "Observable.html#Ext-util-Observable-method-addListener",
270       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
271     },
272     {
273       "tagname": "method",
274       "name": "addManagedListener",
275       "member": "Ext.util.Observable",
276       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
277       "params": [
278         {
279           "type": "Observable/Element",
280           "name": "item",
281           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
282           "optional": false
283         },
284         {
285           "type": "Object/String",
286           "name": "ename",
287           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
288           "optional": false
289         },
290         {
291           "type": "Function",
292           "name": "fn",
293           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
294           "optional": false
295         },
296         {
297           "type": "Object",
298           "name": "scope",
299           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
300           "optional": false
301         },
302         {
303           "type": "Object",
304           "name": "opt",
305           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
306           "optional": false
307         }
308       ],
309       "return": {
310         "type": "void",
311         "doc": "\n"
312       },
313       "private": false,
314       "static": false,
315       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
316       "linenr": 155,
317       "html_filename": "Observable.html",
318       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
319       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
320     },
321     {
322       "tagname": "method",
323       "name": "capture",
324       "member": "Ext.util.Observable",
325       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
326       "params": [
327         {
328           "type": "Observable",
329           "name": "o",
330           "doc": "<p>The Observable to capture events from.</p>\n",
331           "optional": false
332         },
333         {
334           "type": "Function",
335           "name": "fn",
336           "doc": "<p>The function to call when an event is fired.</p>\n",
337           "optional": false
338         },
339         {
340           "type": "Object",
341           "name": "scope",
342           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
343           "optional": true
344         }
345       ],
346       "return": {
347         "type": "void",
348         "doc": "\n"
349       },
350       "private": false,
351       "static": true,
352       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
353       "linenr": 55,
354       "html_filename": "Observable.html",
355       "href": "Observable.html#Ext-util-Observable-method-capture",
356       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
357     },
358     {
359       "tagname": "method",
360       "name": "clearListeners",
361       "member": "Ext.util.Observable",
362       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
363       "params": [
364
365       ],
366       "return": {
367         "type": "void",
368         "doc": "\n"
369       },
370       "private": false,
371       "static": false,
372       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
373       "linenr": 383,
374       "html_filename": "Observable.html",
375       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
376       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
377     },
378     {
379       "tagname": "method",
380       "name": "clearManagedListeners",
381       "member": "Ext.util.Observable",
382       "doc": "<p>Removes all managed listeners for this object.</p>\n",
383       "params": [
384
385       ],
386       "return": {
387         "type": "void",
388         "doc": "\n"
389       },
390       "private": false,
391       "static": false,
392       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
393       "linenr": 412,
394       "html_filename": "Observable.html",
395       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
396       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
397     },
398     {
399       "tagname": "method",
400       "name": "enableBubble",
401       "member": "Ext.util.Observable",
402       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
403       "params": [
404         {
405           "type": "String/Array",
406           "name": "events",
407           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
408           "optional": false
409         }
410       ],
411       "return": {
412         "type": "void",
413         "doc": "\n"
414       },
415       "private": false,
416       "static": false,
417       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
418       "linenr": 554,
419       "html_filename": "Observable.html",
420       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
421       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
422     },
423     {
424       "tagname": "method",
425       "name": "fireEvent",
426       "member": "Ext.util.Observable",
427       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.chart.series.Series-method-enableBubble\" rel=\"Ext.chart.series.Series-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
428       "params": [
429         {
430           "type": "String",
431           "name": "eventName",
432           "doc": "<p>The name of the event to fire.</p>\n",
433           "optional": false
434         },
435         {
436           "type": "Object...",
437           "name": "args",
438           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
439           "optional": false
440         }
441       ],
442       "return": {
443         "type": "Boolean",
444         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
445       },
446       "private": false,
447       "static": false,
448       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
449       "linenr": 232,
450       "html_filename": "Observable.html",
451       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
452       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
453     },
454     {
455       "tagname": "method",
456       "name": "getItemForPoint",
457       "member": "Ext.chart.series.Series",
458       "doc": "<p>For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.</p>\n",
459       "params": [
460         {
461           "type": "Number",
462           "name": "x",
463           "doc": "\n",
464           "optional": false
465         },
466         {
467           "type": "Number",
468           "name": "y",
469           "doc": "\n",
470           "optional": false
471         }
472       ],
473       "return": {
474         "type": "Object",
475         "doc": "<p>An object describing the item, or null if there is no matching item. The exact contents of</p>\n\n<pre><code>             this object will vary by series type, but should always contain at least the following:\n             &lt;ul&gt;\n               &lt;li&gt;{Ext.chart.series.Series} series - the Series object to which the item belongs&lt;/li&gt;\n               &lt;li&gt;{Object} value - the value(s) of the item's data point&lt;/li&gt;\n               &lt;li&gt;{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.&lt;/li&gt;\n               &lt;li&gt;{Ext.draw.Sprite} sprite - the item's rendering Sprite.\n             &lt;/ul&gt;\n</code></pre>\n"
476       },
477       "private": false,
478       "static": false,
479       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
480       "linenr": 241,
481       "html_filename": "Series.html",
482       "href": "Series.html#Ext-chart-series-Series-method-getItemForPoint",
483       "shortDoc": "<p>For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.</p>\n"
484     },
485     {
486       "tagname": "method",
487       "name": "getLegendColor",
488       "member": "Ext.chart.series.Series",
489       "doc": "<p>Returns a string with the color to be used for the series legend item.</p>\n",
490       "params": [
491         {
492           "type": "Object",
493           "name": "index",
494           "doc": "\n",
495           "optional": false
496         }
497       ],
498       "return": {
499         "type": "void",
500         "doc": "\n"
501       },
502       "private": false,
503       "static": false,
504       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
505       "linenr": 321,
506       "html_filename": "Series.html",
507       "href": "Series.html#Ext-chart-series-Series-method-getLegendColor",
508       "shortDoc": "<p>Returns a string with the color to be used for the series legend item.</p>\n"
509     },
510     {
511       "tagname": "method",
512       "name": "hasListener",
513       "member": "Ext.util.Observable",
514       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
515       "params": [
516         {
517           "type": "String",
518           "name": "eventName",
519           "doc": "<p>The name of the event to check for</p>\n",
520           "optional": false
521         }
522       ],
523       "return": {
524         "type": "Boolean",
525         "doc": "<p>True if the event is being listened for, else false</p>\n"
526       },
527       "private": false,
528       "static": false,
529       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
530       "linenr": 480,
531       "html_filename": "Observable.html",
532       "href": "Observable.html#Ext-util-Observable-method-hasListener",
533       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
534     },
535     {
536       "tagname": "method",
537       "name": "hideAll",
538       "member": "Ext.chart.series.Series",
539       "doc": "<p>Hides all the elements in the series.</p>\n",
540       "params": [
541
542       ],
543       "return": {
544         "type": "void",
545         "doc": "\n"
546       },
547       "private": false,
548       "static": false,
549       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
550       "linenr": 282,
551       "html_filename": "Series.html",
552       "href": "Series.html#Ext-chart-series-Series-method-hideAll",
553       "shortDoc": "<p>Hides all the elements in the series.</p>\n"
554     },
555     {
556       "tagname": "method",
557       "name": "highlightItem",
558       "member": "Ext.chart.Highlight",
559       "doc": "<p>Highlight the given series item.</p>\n",
560       "params": [
561         {
562           "type": "Object",
563           "name": "item",
564           "doc": "<p>Info about the item; same format as returned by #getItemForPoint.</p>\n",
565           "optional": false
566         }
567       ],
568       "return": {
569         "type": "void",
570         "doc": "\n"
571       },
572       "private": false,
573       "static": false,
574       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js",
575       "linenr": 38,
576       "html_filename": "Highlight.html",
577       "href": "Highlight.html#Ext-chart-Highlight-method-highlightItem",
578       "shortDoc": "<p>Highlight the given series item.</p>\n"
579     },
580     {
581       "tagname": "method",
582       "name": "observe",
583       "member": "Ext.util.Observable",
584       "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>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</code></pre>\n",
585       "params": [
586         {
587           "type": "Function",
588           "name": "c",
589           "doc": "<p>The class constructor to make observable.</p>\n",
590           "optional": false
591         },
592         {
593           "type": "Object",
594           "name": "listeners",
595           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.chart.series.Series-method-addListener\" rel=\"Ext.chart.series.Series-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
596           "optional": false
597         }
598       ],
599       "return": {
600         "type": "void",
601         "doc": "\n"
602       },
603       "private": false,
604       "static": true,
605       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
606       "linenr": 69,
607       "html_filename": "Observable.html",
608       "href": "Observable.html#Ext-util-Observable-method-observe",
609       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
610     },
611     {
612       "tagname": "method",
613       "name": "on",
614       "member": "Ext.util.Observable",
615       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.chart.series.Series-method-addListener\" rel=\"Ext.chart.series.Series-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
616       "params": [
617         {
618           "type": "String",
619           "name": "eventName",
620           "doc": "<p>The type of event to listen for</p>\n",
621           "optional": false
622         },
623         {
624           "type": "Function",
625           "name": "handler",
626           "doc": "<p>The method the event invokes</p>\n",
627           "optional": false
628         },
629         {
630           "type": "Object",
631           "name": "scope",
632           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
633           "optional": true
634         },
635         {
636           "type": "Object",
637           "name": "options",
638           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
639           "optional": true
640         }
641       ],
642       "return": {
643         "type": "void",
644         "doc": "\n"
645       },
646       "private": false,
647       "static": false,
648       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
649       "linenr": 616,
650       "html_filename": "Observable.html",
651       "href": "Observable.html#Ext-util-Observable-method-on",
652       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.chart.series.Series-method-addListener\" rel=\"Ext.chart.series.Series-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
653     },
654     {
655       "tagname": "method",
656       "name": "relayEvents",
657       "member": "Ext.util.Observable",
658       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
659       "params": [
660         {
661           "type": "Object",
662           "name": "origin",
663           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
664           "optional": false
665         },
666         {
667           "type": "Array",
668           "name": "events",
669           "doc": "<p>Array of event names to relay.</p>\n",
670           "optional": false
671         },
672         {
673           "type": "Object",
674           "name": "prefix",
675           "doc": "\n",
676           "optional": false
677         }
678       ],
679       "return": {
680         "type": "void",
681         "doc": "\n"
682       },
683       "private": false,
684       "static": false,
685       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
686       "linenr": 520,
687       "html_filename": "Observable.html",
688       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
689       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
690     },
691     {
692       "tagname": "method",
693       "name": "releaseCapture",
694       "member": "Ext.util.Observable",
695       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
696       "params": [
697         {
698           "type": "Observable",
699           "name": "o",
700           "doc": "<p>The Observable to release</p>\n",
701           "optional": false
702         }
703       ],
704       "return": {
705         "type": "void",
706         "doc": "\n"
707       },
708       "private": false,
709       "static": true,
710       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
711       "linenr": 46,
712       "html_filename": "Observable.html",
713       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
714       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
715     },
716     {
717       "tagname": "method",
718       "name": "removeListener",
719       "member": "Ext.util.Observable",
720       "doc": "<p>Removes an event handler.</p>\n",
721       "params": [
722         {
723           "type": "String",
724           "name": "eventName",
725           "doc": "<p>The type of event the handler was associated with.</p>\n",
726           "optional": false
727         },
728         {
729           "type": "Function",
730           "name": "handler",
731           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.chart.series.Series-method-addListener\" rel=\"Ext.chart.series.Series-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
732           "optional": false
733         },
734         {
735           "type": "Object",
736           "name": "scope",
737           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
738           "optional": true
739         }
740       ],
741       "return": {
742         "type": "void",
743         "doc": "\n"
744       },
745       "private": false,
746       "static": false,
747       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
748       "linenr": 352,
749       "html_filename": "Observable.html",
750       "href": "Observable.html#Ext-util-Observable-method-removeListener",
751       "shortDoc": "<p>Removes an event handler.</p>\n"
752     },
753     {
754       "tagname": "method",
755       "name": "removeManagedListener",
756       "member": "Ext.util.Observable",
757       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.chart.series.Series--mon\" rel=\"Ext.chart.series.Series--mon\" class=\"docClass\">mon</a> method.</p>\n",
758       "params": [
759         {
760           "type": "Observable|Element",
761           "name": "item",
762           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
763           "optional": false
764         },
765         {
766           "type": "Object|String",
767           "name": "ename",
768           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
769           "optional": false
770         },
771         {
772           "type": "Function",
773           "name": "fn",
774           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
775           "optional": false
776         },
777         {
778           "type": "Object",
779           "name": "scope",
780           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
781           "optional": false
782         }
783       ],
784       "return": {
785         "type": "void",
786         "doc": "\n"
787       },
788       "private": false,
789       "static": false,
790       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
791       "linenr": 196,
792       "html_filename": "Observable.html",
793       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
794       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.chart.series.Series--mon\" rel=\"Ext.chart.series.Series--mon\" class=\"docClass\">mon</a> method.</p>\n"
795     },
796     {
797       "tagname": "method",
798       "name": "resumeEvents",
799       "member": "Ext.util.Observable",
800       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.chart.series.Series-method-suspendEvents\" rel=\"Ext.chart.series.Series-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
801       "params": [
802
803       ],
804       "return": {
805         "type": "void",
806         "doc": "\n"
807       },
808       "private": false,
809       "static": false,
810       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
811       "linenr": 502,
812       "html_filename": "Observable.html",
813       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
814       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
815     },
816     {
817       "tagname": "method",
818       "name": "setTitle",
819       "member": "Ext.chart.series.Series",
820       "doc": "<p>Changes the value of the <a href=\"#/api/Ext.chart.series.Series-cfg-title\" rel=\"Ext.chart.series.Series-cfg-title\" class=\"docClass\">title</a> for the series.\nArguments can take two forms:</p>\n\n<ul>\n<li>A single String value: this will be used as the new single title for the series (applies\nto series with only one yField)</li>\n<li>A numeric index and a String value: this will set the title for a single indexed yField.</li>\n</ul>\n\n",
821       "params": [
822         {
823           "type": "Number",
824           "name": "index",
825           "doc": "\n",
826           "optional": false
827         },
828         {
829           "type": "String",
830           "name": "title",
831           "doc": "\n",
832           "optional": false
833         }
834       ],
835       "return": {
836         "type": "void",
837         "doc": "\n"
838       },
839       "private": false,
840       "static": false,
841       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
842       "linenr": 350,
843       "html_filename": "Series.html",
844       "href": "Series.html#Ext-chart-series-Series-method-setTitle",
845       "shortDoc": "Changes the value of the title for the series.\nArguments can take two forms:\n\n\nA single String value: this will be us..."
846     },
847     {
848       "tagname": "method",
849       "name": "showAll",
850       "member": "Ext.chart.series.Series",
851       "doc": "<p>Shows all the elements in the series.</p>\n",
852       "params": [
853
854       ],
855       "return": {
856         "type": "void",
857         "doc": "\n"
858       },
859       "private": false,
860       "static": false,
861       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
862       "linenr": 308,
863       "html_filename": "Series.html",
864       "href": "Series.html#Ext-chart-series-Series-method-showAll",
865       "shortDoc": "<p>Shows all the elements in the series.</p>\n"
866     },
867     {
868       "tagname": "method",
869       "name": "suspendEvents",
870       "member": "Ext.util.Observable",
871       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.chart.series.Series-method-resumeEvents\" rel=\"Ext.chart.series.Series-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
872       "params": [
873         {
874           "type": "Boolean",
875           "name": "queueSuspended",
876           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.chart.series.Series-method-resumeEvents\" rel=\"Ext.chart.series.Series-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
877           "optional": false
878         }
879       ],
880       "return": {
881         "type": "void",
882         "doc": "\n"
883       },
884       "private": false,
885       "static": false,
886       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
887       "linenr": 490,
888       "html_filename": "Observable.html",
889       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
890       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.chart.series.Series-method-resumeEvents\" rel=\"Ext.chart.series.Series-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
891     },
892     {
893       "tagname": "method",
894       "name": "un",
895       "member": "Ext.util.Observable",
896       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.chart.series.Series-method-removeListener\" rel=\"Ext.chart.series.Series-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
897       "params": [
898         {
899           "type": "String",
900           "name": "eventName",
901           "doc": "<p>The type of event the handler was associated with.</p>\n",
902           "optional": false
903         },
904         {
905           "type": "Function",
906           "name": "handler",
907           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.chart.series.Series-method-addListener\" rel=\"Ext.chart.series.Series-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
908           "optional": false
909         },
910         {
911           "type": "Object",
912           "name": "scope",
913           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
914           "optional": true
915         }
916       ],
917       "return": {
918         "type": "void",
919         "doc": "\n"
920       },
921       "private": false,
922       "static": false,
923       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
924       "linenr": 608,
925       "html_filename": "Observable.html",
926       "href": "Observable.html#Ext-util-Observable-method-un",
927       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.chart.series.Series-method-removeListener\" rel=\"Ext.chart.series.Series-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
928     },
929     {
930       "tagname": "method",
931       "name": "unHighlightItem",
932       "member": "Ext.chart.Highlight",
933       "doc": "<p>Un-highlight any existing highlights</p>\n",
934       "params": [
935
936       ],
937       "return": {
938         "type": "void",
939         "doc": "\n"
940       },
941       "private": false,
942       "static": false,
943       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js",
944       "linenr": 109,
945       "html_filename": "Highlight.html",
946       "href": "Highlight.html#Ext-chart-Highlight-method-unHighlightItem",
947       "shortDoc": "<p>Un-highlight any existing highlights</p>\n"
948     }
949   ],
950   "property": [
951     {
952       "tagname": "property",
953       "name": "highlight",
954       "member": "Ext.chart.Highlight",
955       "type": "Boolean",
956       "doc": "<p>Highlight the given series item.</p>\n",
957       "private": false,
958       "static": false,
959       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js",
960       "linenr": 13,
961       "html_filename": "Highlight.html",
962       "href": "Highlight.html#Ext-chart-Highlight-property-highlight"
963     }
964   ],
965   "event": [
966     {
967       "tagname": "event",
968       "name": "titlechange",
969       "member": "Ext.chart.series.Series",
970       "doc": "<p>Fires when the series title is changed via <a href=\"#/api/Ext.chart.series.Series-method-setTitle\" rel=\"Ext.chart.series.Series-method-setTitle\" class=\"docClass\">setTitle</a>.</p>\n",
971       "params": [
972         {
973           "type": "String",
974           "name": "title",
975           "doc": "<p>The new title value</p>\n",
976           "optional": false
977         },
978         {
979           "type": "Number",
980           "name": "index",
981           "doc": "<p>The index in the collection of titles</p>\n",
982           "optional": false
983         }
984       ],
985       "private": false,
986       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
987       "linenr": 139,
988       "html_filename": "Series.html",
989       "href": "Series.html#Ext-chart-series-Series-event-titlechange",
990       "shortDoc": "<p>Fires when the series title is changed via <a href=\"#/api/Ext.chart.series.Series-method-setTitle\" rel=\"Ext.chart.series.Series-method-setTitle\" class=\"docClass\">setTitle</a>.</p>\n"
991     }
992   ],
993   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
994   "linenr": 1,
995   "html_filename": "Series.html",
996   "href": "Series.html#Ext-chart-series-Series",
997   "cssVar": [
998
999   ],
1000   "cssMixin": [
1001
1002   ],
1003   "component": false,
1004   "superclasses": [
1005
1006   ],
1007   "subclasses": [
1008     "Ext.chart.series.Cartesian",
1009     "Ext.chart.series.Gauge",
1010     "Ext.chart.series.Pie",
1011     "Ext.chart.series.Radar"
1012   ],
1013   "mixedInto": [
1014
1015   ],
1016   "allMixins": [
1017     "Ext.util.Observable",
1018     "Ext.chart.Label",
1019     "Ext.chart.Highlight",
1020     "Ext.chart.Tip",
1021     "Ext.chart.Callout"
1022   ]
1023 });