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