Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.chart.series.Gauge.html
1 <!DOCTYPE html><html><head><title>Ext.chart.series.Gauge | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.chart.series.Gauge',
13         docClass: 'Ext.chart.series.Gauge',
14         docReq: 'Ext.chart.series.Gauge',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Gauge2.html#Ext-chart.series.Gauge';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","drawSeries","enableBubble","fireEvent","getItemForPoint","getLegendColor","hasListener","hideAll","highlightItem","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","setTitle","setValue","showAll","suspendEvents","un","unHighlightItem"],"cfgs":["angleField","color","display","donut","field","font","highlight","highlightDuration","listeners","minMargin","needle","orientation","renderer","shadowAttributes","showInLegend","style","tips","title","type"],"properties":["highlight"],"events":["titlechange"],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Gauge2.html#Ext-chart.series.Gauge" target="_blank">Ext.chart.series.Gauge</a><span>xtype: gauge</span></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.chart.series.Series.html" rel="Ext.chart.series.Series" class="cls docClass">Ext.chart.series.Series</a><div class="subclass"><strong>Ext.chart.series.Gauge</strong></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div><div class="mixin"><a href="Ext.chart.Label.html" rel="Ext.chart.Label" class="cls docClass">Ext.chart.Label</a></div><div class="mixin"><a href="Ext.chart.Highlight.html" rel="Ext.chart.Highlight" class="cls docClass">Ext.chart.Highlight</a></div><div class="mixin"><a href="Ext.chart.Tip.html" rel="Ext.chart.Tip" class="cls docClass">Ext.chart.Tip</a></div><div class="mixin"><a href="Ext.chart.Callout.html" rel="Ext.chart.Callout" class="cls docClass">Ext.chart.Callout</a></div></pre><p>Creates a Gauge Chart. Gauge Charts are used to show progress in a certain variable. There are two ways of using the Gauge chart.
38 One is setting a store element into the Gauge and selecting the field to be used from that store. Another one is instanciating the
39 visualization and using the <code>setValue</code> method to adjust the value you want.</p>
40
41 <p>A chart/series configuration for the Gauge visualization could look like this:</p>
42
43 <pre class="prettyprint"><code>{
44     xtype: 'chart',
45     store: store,
46     axes: [{
47         type: 'gauge',
48         position: 'gauge',
49         minimum: 0,
50         maximum: 100,
51         steps: 10,
52         margin: -10
53     }],
54     series: [{
55         type: 'gauge',
56         field: 'data1',
57         donut: false,
58         colorSet: ['#F49D10', '#ddd']
59     }]
60 }
61 </code></pre>
62
63 <p>In this configuration we create a special Gauge axis to be used with the gauge visualization (describing half-circle markers), and also we're
64 setting a maximum, minimum and steps configuration options into the axis. The Gauge series configuration contains the store field to be bound to
65 the visual display and the color set to be used with the visualization.</p>
66 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-angleField" class="member f ni"><a href="Ext.chart.series.Gauge.html#config-angleField" rel="config-angleField" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-cfg-angleField" class="viewSource">view source</a></div><a name="angleField"></a><a name="config-angleField"></a><a href="Ext.chart.series.Gauge.html#" rel="config-angleField" class="cls expand">angleField</a><span> : String</span></div><div class="description"><div class="short">The store record field name to be used for the pie angles.
67 The values bound to this field name must be positive real ...</div><div class="long"><p>The store record field name to be used for the pie angles.
68 The values bound to this field name must be positive real numbers.
69 This parameter is required.</p>
70 </div></div></div><div id="config-color" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-color" rel="config-color" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Label.html" class="definedIn docClass">Ext.chart.Label</a><br/><a href="../source/Label2.html#Ext-chart.Label-cfg-color" class="viewSource">view source</a></div><a name="color"></a><a name="config-color"></a><a href="Ext.chart.series.Gauge.html#" rel="config-color" class="cls expand">color</a><span> : String</span></div><div class="description"><div class="short"><p>The color of the label text.
71 Default value: '#000' (black).</p>
72 </div><div class="long"><p>The color of the label text.
73 Default value: '#000' (black).</p>
74 </div></div></div><div id="config-display" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-display" rel="config-display" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Label.html" class="definedIn docClass">Ext.chart.Label</a><br/><a href="../source/Label2.html#Ext-chart.Label-cfg-display" class="viewSource">view source</a></div><a name="display"></a><a name="config-display"></a><a href="Ext.chart.series.Gauge.html#" rel="config-display" class="cls expand">display</a><span> : String</span></div><div class="description"><div class="short">Specifies the presence and position of labels for each pie slice. Either "rotate", "middle", "insideStart",
75 "insideEn...</div><div class="long"><p>Specifies the presence and position of labels for each pie slice. Either "rotate", "middle", "insideStart",
76 "insideEnd", "outside", "over", "under", or "none" to prevent label rendering.
77 Default value: 'none'.</p>
78 </div></div></div><div id="config-donut" class="member ni"><a href="Ext.chart.series.Gauge.html#config-donut" rel="config-donut" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-cfg-donut" class="viewSource">view source</a></div><a name="donut"></a><a name="config-donut"></a><a href="Ext.chart.series.Gauge.html#" rel="config-donut" class="cls expand">donut</a><span> : Boolean|Number</span></div><div class="description"><div class="short"><p>Use the entire disk or just a fraction of it for the gauge. Default's false.</p>
79 </div><div class="long"><p>Use the entire disk or just a fraction of it for the gauge. Default's false.</p>
80 </div></div></div><div id="config-field" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-field" rel="config-field" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Label.html" class="definedIn docClass">Ext.chart.Label</a><br/><a href="../source/Label2.html#Ext-chart.Label-cfg-field" class="viewSource">view source</a></div><a name="field"></a><a name="config-field"></a><a href="Ext.chart.series.Gauge.html#" rel="config-field" class="cls expand">field</a><span> : String</span></div><div class="description"><div class="short"><p>The name of the field to be displayed in the label.
81 Default value: 'name'.</p>
82 </div><div class="long"><p>The name of the field to be displayed in the label.
83 Default value: 'name'.</p>
84 </div></div></div><div id="config-font" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-font" rel="config-font" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Label.html" class="definedIn docClass">Ext.chart.Label</a><br/><a href="../source/Label2.html#Ext-chart.Label-cfg-font" class="viewSource">view source</a></div><a name="font"></a><a name="config-font"></a><a href="Ext.chart.series.Gauge.html#" rel="config-font" class="cls expand">font</a><span> : String</span></div><div class="description"><div class="short"><p>The font used for the labels.
85 Defautl value: "11px Helvetica, sans-serif".</p>
86 </div><div class="long"><p>The font used for the labels.
87 Defautl value: "11px Helvetica, sans-serif".</p>
88 </div></div></div><div id="config-highlight" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-highlight" rel="config-highlight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-cfg-highlight" class="viewSource">view source</a></div><a name="highlight"></a><a name="config-highlight"></a><a href="Ext.chart.series.Gauge.html#" rel="config-highlight" class="cls expand">highlight</a><span> : Boolean|Object</span></div><div class="description"><div class="short">If set to true it will highlight the markers or the series when hovering
89 with the mouse. This parameter can also be a...</div><div class="long"><p>If set to <code>true</code> it will highlight the markers or the series when hovering
90 with the mouse. This parameter can also be an object with the same style
91 properties you would apply to a <a href="Ext.draw.Sprite.html" rel="Ext.draw.Sprite" class="docClass">Ext.draw.Sprite</a> to apply custom
92 styles to markers and series.</p>
93 </div></div></div><div id="config-highlightDuration" class="member ni"><a href="Ext.chart.series.Gauge.html#config-highlightDuration" rel="config-highlightDuration" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-cfg-highlightDuration" class="viewSource">view source</a></div><a name="highlightDuration"></a><a name="config-highlightDuration"></a><a href="Ext.chart.series.Gauge.html#" rel="config-highlightDuration" class="cls expand">highlightDuration</a><span> : Number</span></div><div class="description"><div class="short"><p>The duration for the pie slice highlight effect.</p>
94 </div><div class="long"><p>The duration for the pie slice highlight effect.</p>
95 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.chart.series.Gauge.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
96 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
97 object during initialization.  This should be a valid listeners config object as specified in the
98 <a href="Ext.chart.series.Gauge.html#addListener" rel="Ext.chart.series.Gauge#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
99
100 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
101
102
103 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
104
105
106 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
107 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
108 events directly from a child element of a Component, we need to specify the <code>element</code> option to
109 identify the Component property to add a DOM listener to:</p>
110
111 <pre><code>new Ext.panel.Panel({
112     width: 400,
113     height: 200,
114     dockedItems: [{
115         xtype: 'toolbar'
116     }],
117     listeners: {
118         click: {
119             element: 'el', //bind to the underlying el property on the panel
120             fn: function(){ console.log('click el'); }
121         },
122         dblclick: {
123             element: 'body', //bind to the underlying body property on the panel
124             fn: function(){ console.log('dblclick body'); }
125         }
126     }
127 });
128 </code></pre>
129
130
131 <p></p></p>
132 </div></div></div><div id="config-minMargin" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-minMargin" rel="config-minMargin" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Label.html" class="definedIn docClass">Ext.chart.Label</a><br/><a href="../source/Label2.html#Ext-chart.Label-cfg-minMargin" class="viewSource">view source</a></div><a name="minMargin"></a><a name="config-minMargin"></a><a href="Ext.chart.series.Gauge.html#" rel="config-minMargin" class="cls expand">minMargin</a><span> : Number</span></div><div class="description"><div class="short">Specifies the minimum distance from a label to the origin of the visualization.
133 This parameter is useful when using P...</div><div class="long"><p>Specifies the minimum distance from a label to the origin of the visualization.
134 This parameter is useful when using PieSeries width variable pie slice lengths.
135 Default value: 50.</p>
136 </div></div></div><div id="config-needle" class="member ni"><a href="Ext.chart.series.Gauge.html#config-needle" rel="config-needle" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-cfg-needle" class="viewSource">view source</a></div><a name="needle"></a><a name="config-needle"></a><a href="Ext.chart.series.Gauge.html#" rel="config-needle" class="cls expand">needle</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Use the Gauge Series as an area series or add a needle to it. Default's false.</p>
137 </div><div class="long"><p>Use the Gauge Series as an area series or add a needle to it. Default's false.</p>
138 </div></div></div><div id="config-orientation" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-orientation" rel="config-orientation" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Label.html" class="definedIn docClass">Ext.chart.Label</a><br/><a href="../source/Label2.html#Ext-chart.Label-cfg-orientation" class="viewSource">view source</a></div><a name="orientation"></a><a name="config-orientation"></a><a href="Ext.chart.series.Gauge.html#" rel="config-orientation" class="cls expand">orientation</a><span> : String</span></div><div class="description"><div class="short"><p>Either "horizontal" or "vertical".
139 Dafault value: "horizontal".</p>
140 </div><div class="long"><p>Either "horizontal" or "vertical".
141 Dafault value: "horizontal".</p>
142 </div></div></div><div id="config-renderer" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-renderer" rel="config-renderer" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Label.html" class="definedIn docClass">Ext.chart.Label</a><br/><a href="../source/Label2.html#Ext-chart.Label-cfg-renderer" class="viewSource">view source</a></div><a name="renderer"></a><a name="config-renderer"></a><a href="Ext.chart.series.Gauge.html#" rel="config-renderer" class="cls expand">renderer</a><span> : Function</span></div><div class="description"><div class="short"><p>Optional function for formatting the label into a displayable value.
143 Default value: function(v) { return v; }</p>
144 </div><div class="long"><p>Optional function for formatting the label into a displayable value.
145 Default value: function(v) { return v; }</p>
146 </div></div></div><div id="config-shadowAttributes" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-shadowAttributes" rel="config-shadowAttributes" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-cfg-shadowAttributes" class="viewSource">view source</a></div><a name="shadowAttributes"></a><a name="config-shadowAttributes"></a><a href="Ext.chart.series.Gauge.html#" rel="config-shadowAttributes" class="cls expand">shadowAttributes</a><span> : Array</span></div><div class="description"><div class="short"><p>An array with shadow attributes</p>
147 </div><div class="long"><p>An array with shadow attributes</p>
148 </div></div></div><div id="config-showInLegend" class="member ni"><a href="Ext.chart.series.Gauge.html#config-showInLegend" rel="config-showInLegend" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-cfg-showInLegend" class="viewSource">view source</a></div><a name="showInLegend"></a><a name="config-showInLegend"></a><a href="Ext.chart.series.Gauge.html#" rel="config-showInLegend" class="cls expand">showInLegend</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Whether to add the pie chart elements as legend items. Default's false.</p>
149 </div><div class="long"><p>Whether to add the pie chart elements as legend items. Default's false.</p>
150 </div></div></div><div id="config-style" class="member ni"><a href="Ext.chart.series.Gauge.html#config-style" rel="config-style" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-cfg-style" class="viewSource">view source</a></div><a name="style"></a><a name="config-style"></a><a href="Ext.chart.series.Gauge.html#" rel="config-style" class="cls expand">style</a><span> : Object</span></div><div class="description"><div class="short"><p>An object containing styles for overriding series styles from Theming.</p>
151 </div><div class="long"><p>An object containing styles for overriding series styles from Theming.</p>
152 </div></div></div><div id="config-tips" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-tips" rel="config-tips" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-cfg-tips" class="viewSource">view source</a></div><a name="tips"></a><a name="config-tips"></a><a href="Ext.chart.series.Gauge.html#" rel="config-tips" class="cls expand">tips</a><span> : Object</span></div><div class="description"><div class="short">Add tooltips to the visualization's markers. The options for the tips are the
153 same configuration used with Ext.tip.To...</div><div class="long"><p>Add tooltips to the visualization's markers. The options for the tips are the
154 same configuration used with <a href="Ext.tip.ToolTip.html" rel="Ext.tip.ToolTip" class="docClass">Ext.tip.ToolTip</a>. For example:</p>
155
156 <pre><code>tips: {
157   trackMouse: true,
158   width: 140,
159   height: 28,
160   renderer: function(storeItem, item) {
161     this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');
162   }
163 },
164 </code></pre>
165 </div></div></div><div id="config-title" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-title" rel="config-title" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-cfg-title" class="viewSource">view source</a></div><a name="title"></a><a name="config-title"></a><a href="Ext.chart.series.Gauge.html#" rel="config-title" class="cls expand">title</a><span> : String</span></div><div class="description"><div class="short"><p>The human-readable name of the series.</p>
166 </div><div class="long"><p>The human-readable name of the series.</p>
167 </div></div></div><div id="config-type" class="member inherited"><a href="Ext.chart.series.Gauge.html#config-type" rel="config-type" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-cfg-type" class="viewSource">view source</a></div><a name="type"></a><a name="config-type"></a><a href="Ext.chart.series.Gauge.html#" rel="config-type" class="cls expand">type</a><span> : String</span></div><div class="description"><div class="short"><p>The type of series. Set in subclasses.</p>
168 </div><div class="long"><p>The type of series. Set in subclasses.</p>
169 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-highlight" class="member f inherited"><a href="Ext.chart.series.Gauge.html#property-highlight" rel="property-highlight" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Highlight.html" class="definedIn docClass">Ext.chart.Highlight</a><br/><a href="../source/Highlight.html#Ext-chart.Highlight-property-highlight" class="viewSource">view source</a></div><a name="highlight"></a><a name="property-highlight"></a><a href="Ext.chart.series.Gauge.html#" rel="property-highlight" class="cls expand">highlight</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Highlight the given series item.</p>
170 </div><div class="long"><p>Highlight the given series item.</p>
171 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-addEvents" class="member f inherited"><a href="Ext.chart.series.Gauge.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.chart.series.Gauge.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
172 <span class="pre">Object/String o, String </span>)
173  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
174 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
175 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
176 or the first event name string if multiple event names are being passed as separate parameters.</p>
177 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
178 Usage:</p>
179
180 <pre><code>this.addEvents('storeloaded', 'storecleared');
181 </code></pre>
182
183 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
184 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.chart.series.Gauge.html#" rel="method-addListener" class="cls expand">addListener</a>(
185 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
186  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
187 </div><div class="long"><p>Appends an event handler to this object.</p>
188 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
189 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
190 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
191 <b>If omitted, defaults to the object which fired the event.</b></p>
192 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
193 properties. This may contain any of the following properties:<ul>
194 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
195 <b>If omitted, defaults to the object which fired the event.</b></div></li>
196 <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>
197 <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>
198 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
199 by the specified number of milliseconds. If the event fires again within that time, the original
200 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
201 <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>
202 if the event was bubbled up from a child Observable.</div></li>
203 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
204 The name of a Component property which references an element to add a listener to.</p>
205
206 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
207 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
208 <pre><code>new Ext.panel.Panel({
209     title: 'The title',
210     listeners: {
211         click: this.handlePanelClick,
212         element: 'body'
213     }
214 });
215 </code></pre></p>
216
217
218 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
219
220
221 <p></div></li>
222 </ul><br></p>
223
224 <p>
225 <b>Combining Options</b><br>
226 Using the options argument, it is possible to combine different types of listeners:<br>
227 <br>
228 A delayed, one-time listener.
229 <pre><code>myPanel.on('hide', this.handleClick, this, {
230 single: true,
231 delay: 100
232 });</code></pre>
233 <p>
234 <b>Attaching multiple handlers in 1 call</b><br>
235 The method also allows for a single argument to be passed which is a config object containing properties
236 which specify multiple events. For example:
237 <pre><code>myGridPanel.on({
238     cellClick: this.onCellClick,
239     mouseover: this.onMouseOver,
240     mouseout: this.onMouseOut,
241     scope: this // Important. Ensure "this" is correct during handler execution
242 });
243 </code></pre>.
244 <p>
245
246 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
247 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.chart.series.Gauge.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
248 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
249  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
250 is destroyed.
251
252 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
253 is destroyed.
254
255 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
256 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
257 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
258 is the handler function.</p>
259 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
260 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
261 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
262 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
263 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
264 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.chart.series.Gauge.html#" rel="method-capture" class="cls expand">capture</a>(
265 <span class="pre">Observable o, Function fn, [Object scope]</span>)
266  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
267 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
268 to the supplied function with the event name + standard signature of the event
269 <b>before</b> the event is fired. If the supplied function returns false,
270 the event will not fire.</p>
271 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
272 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
273 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
274 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
275 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.chart.series.Gauge.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
276 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
277 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
278 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.chart.series.Gauge.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
279 </div><div class="long"><p>Removes all managed listeners for this object.</p>
280 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
281 </li></ul></div></div></div><div id="method-drawSeries" class="member ni"><a href="Ext.chart.series.Gauge.html#method-drawSeries" rel="method-drawSeries" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-method-drawSeries" class="viewSource">view source</a></div><a name="drawSeries"></a><a name="method-drawSeries"></a><a href="Ext.chart.series.Gauge.html#" rel="method-drawSeries" class="cls expand">drawSeries</a> : void</div><div class="description"><div class="short"><p>Draws the series for the current chart.</p>
282 </div><div class="long"><p>Draws the series for the current chart.</p>
283 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
284 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.chart.series.Gauge.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
285 <span class="pre">String/Array events</span>)
286  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
287 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
288 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
289
290
291 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
292 implementation in <a href="Ext.Component.html" 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
293 access the required target more quickly.</p>
294
295
296 <p>Example:</p>
297
298
299 <pre><code>Ext.override(Ext.form.field.Base, {
300 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
301 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
302     this.enableBubble('change');
303 }),
304
305 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
306 getBubbleTarget : function() {
307     if (!this.formPanel) {
308         this.formPanel = this.findParentByType('form');
309     }
310     return this.formPanel;
311 }
312 });
313
314 var myForm = new Ext.formPanel({
315 title: 'User Details',
316 items: [{
317     ...
318 }],
319 listeners: {
320     change: function() {
321         // Title goes red if form has been modified.
322         myForm.header.setStyle('color', 'red');
323     }
324 }
325 });
326 </code></pre>
327
328 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
329 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
330 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.chart.series.Gauge.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
331 <span class="pre">String eventName, Object... args</span>)
332  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
333
334
335 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
336
337
338 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
339 by calling <a href="Ext.chart.series.Gauge.html#enableBubble" rel="Ext.chart.series.Gauge#enableBubble" class="docClass">enableBubble</a>.</p>
340
341 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
342 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
343 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
344 </li></ul></div></div></div><div id="method-getItemForPoint" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-getItemForPoint" rel="method-getItemForPoint" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-method-getItemForPoint" class="viewSource">view source</a></div><a name="getItemForPoint"></a><a name="method-getItemForPoint"></a><a href="Ext.chart.series.Gauge.html#" rel="method-getItemForPoint" class="cls expand">getItemForPoint</a>(
345 <span class="pre">Number x, Number y</span>)
346  : Object</div><div class="description"><div class="short"><p>For a given x/y point relative to the Surface, find a corresponding item from this
347 series, if any.</p>
348 </div><div class="long"><p>For a given x/y point relative to the Surface, find a corresponding item from this
349 series, if any.</p>
350 <h3 class="pa">Parameters</h3><ul><li><span class="pre">x</span> : Number<div class="sub-desc">
351 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc">
352 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>An object describing the item, or null if there is no matching item. The exact contents of</p>
353
354 <pre><code>             this object will vary by series type, but should always contain at least the following:
355              &lt;ul&gt;
356                &lt;li&gt;{Ext.chart.series.Series} series - the Series object to which the item belongs&lt;/li&gt;
357                &lt;li&gt;{Object} value - the value(s) of the item's data point&lt;/li&gt;
358                &lt;li&gt;{Array} point - the x/y coordinates relative to the chart box of a single point
359                    for this data item, which can be used as e.g. a tooltip anchor point.&lt;/li&gt;
360                &lt;li&gt;{Ext.draw.Sprite} sprite - the item's rendering Sprite.
361              &lt;/ul&gt;
362 </code></pre>
363 </li></ul></div></div></div><div id="method-getLegendColor" class="member ni"><a href="Ext.chart.series.Gauge.html#method-getLegendColor" rel="method-getLegendColor" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-method-getLegendColor" class="viewSource">view source</a></div><a name="getLegendColor"></a><a name="method-getLegendColor"></a><a href="Ext.chart.series.Gauge.html#" rel="method-getLegendColor" class="cls expand">getLegendColor</a>(
364 <span class="pre">Object item</span>)
365  : void</div><div class="description"><div class="short"><p>Returns the color of the series (to be displayed as color for the series legend item).</p>
366 </div><div class="long"><p>Returns the color of the series (to be displayed as color for the series legend item).</p>
367 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Object<div class="sub-desc"><p>{Object} Info about the item; same format as returned by #getItemForPoint</p>
368 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
369 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.chart.series.Gauge.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
370 <span class="pre">String eventName</span>)
371  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
372 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
373 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
374 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
375 </li></ul></div></div></div><div id="method-hideAll" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-hideAll" rel="method-hideAll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-method-hideAll" class="viewSource">view source</a></div><a name="hideAll"></a><a name="method-hideAll"></a><a href="Ext.chart.series.Gauge.html#" rel="method-hideAll" class="cls expand">hideAll</a> : void</div><div class="description"><div class="short"><p>Hides all the elements in the series.</p>
376 </div><div class="long"><p>Hides all the elements in the series.</p>
377 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
378 </li></ul></div></div></div><div id="method-highlightItem" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-highlightItem" rel="method-highlightItem" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Highlight.html" class="definedIn docClass">Ext.chart.Highlight</a><br/><a href="../source/Highlight.html#Ext-chart.Highlight-method-highlightItem" class="viewSource">view source</a></div><a name="highlightItem"></a><a name="method-highlightItem"></a><a href="Ext.chart.series.Gauge.html#" rel="method-highlightItem" class="cls expand">highlightItem</a>(
379 <span class="pre">Object item</span>)
380  : void</div><div class="description"><div class="short"><p>Highlight the given series item.</p>
381 </div><div class="long"><p>Highlight the given series item.</p>
382 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Object<div class="sub-desc"><p>Info about the item; same format as returned by #getItemForPoint.</p>
383 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
384 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.chart.series.Gauge.html#" rel="method-observe" class="cls expand">observe</a>(
385 <span class="pre">Function c, Object listeners</span>)
386  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
387
388 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
389
390 <p>This makes any event fired on any instance of the passed class also fire a single event through
391 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
392
393 <p>Usage:</p>
394
395 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
396 Ext.data.Connection.on('beforerequest', function(con, options) {
397     console.log('Ajax request made to ' + options.url);
398 });
399 </code></pre>
400 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
401 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.chart.series.Gauge.html#addListener" rel="Ext.chart.series.Gauge#addListener" class="docClass">addListener</a>.</p>
402 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
403 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.chart.series.Gauge.html#" rel="method-on" class="cls expand">on</a>(
404 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
405  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.chart.series.Gauge.html#addListener" rel="Ext.chart.series.Gauge#addListener" class="docClass">addListener</a>.)</p>
406 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.chart.series.Gauge.html#addListener" rel="Ext.chart.series.Gauge#addListener" class="docClass">addListener</a>.)</p>
407 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
408 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
409 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
410 <b>If omitted, defaults to the object which fired the event.</b></p>
411 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
412 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
413 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.chart.series.Gauge.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
414 <span class="pre">Object origin, Array events, Object prefix</span>)
415  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
416 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
417 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
418 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
419 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
420 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
421 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.chart.series.Gauge.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
422 <span class="pre">Observable o</span>)
423  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
424 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
425 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
426 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
427 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.chart.series.Gauge.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
428 <span class="pre">String eventName, Function handler, [Object scope]</span>)
429  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
430 </div><div class="long"><p>Removes an event handler.</p>
431 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
432 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.chart.series.Gauge.html#addListener" rel="Ext.chart.series.Gauge#addListener" class="docClass">addListener</a> call.</b></p>
433 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
434 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
435 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.chart.series.Gauge.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
436 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
437  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.chart.series.Gauge.html#mon" rel="Ext.chart.series.Gauge#mon" class="docClass">mon</a> method.</p>
438 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.chart.series.Gauge.html#mon" rel="Ext.chart.series.Gauge#mon" class="docClass">mon</a> method.</p>
439 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
440 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
441 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
442 is the handler function.</p>
443 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
444 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
445 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
446 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.chart.series.Gauge.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
447 If events were suspended using the queueSuspended parameter, then all
448 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.chart.series.Gauge.html#suspendEvents" rel="Ext.chart.series.Gauge#suspendEvents" class="docClass">suspendEvents</a>)
449 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
450 events fired during event suspension will be sent to any listeners now.</p>
451 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
452 </li></ul></div></div></div><div id="method-setTitle" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-setTitle" rel="method-setTitle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-method-setTitle" class="viewSource">view source</a></div><a name="setTitle"></a><a name="method-setTitle"></a><a href="Ext.chart.series.Gauge.html#" rel="method-setTitle" class="cls expand">setTitle</a>(
453 <span class="pre">Number index, String title</span>)
454  : void</div><div class="description"><div class="short">Changes the value of the title for the series.
455 Arguments can take two forms:
456
457
458 A single String value: this will be us...</div><div class="long"><p>Changes the value of the <a href="Ext.chart.series.Gauge.html#title" rel="Ext.chart.series.Gauge#title" class="docClass">title</a> for the series.
459 Arguments can take two forms:</p>
460
461 <ul>
462 <li>A single String value: this will be used as the new single title for the series (applies
463 to series with only one yField)</li>
464 <li>A numeric index and a String value: this will set the title for a single indexed yField.</li>
465 </ul>
466
467 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc">
468 </div></li><li><span class="pre">title</span> : String<div class="sub-desc">
469 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
470 </li></ul></div></div></div><div id="method-setValue" class="member ni"><a href="Ext.chart.series.Gauge.html#method-setValue" rel="method-setValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Gauge.html" class="definedIn docClass">Ext.chart.series.Gauge</a><br/><a href="../source/Gauge2.html#Ext-chart.series.Gauge-method-setValue" class="viewSource">view source</a></div><a name="setValue"></a><a name="method-setValue"></a><a href="Ext.chart.series.Gauge.html#" rel="method-setValue" class="cls expand">setValue</a>(
471 <span class="pre">Object value</span>)
472  : void</div><div class="description"><div class="short"><p>Sets the Gauge chart to the current specified value.</p>
473 </div><div class="long"><p>Sets the Gauge chart to the current specified value.</p>
474 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Object<div class="sub-desc">
475 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
476 </li></ul></div></div></div><div id="method-showAll" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-showAll" rel="method-showAll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-method-showAll" class="viewSource">view source</a></div><a name="showAll"></a><a name="method-showAll"></a><a href="Ext.chart.series.Gauge.html#" rel="method-showAll" class="cls expand">showAll</a> : void</div><div class="description"><div class="short"><p>Shows all the elements in the series.</p>
477 </div><div class="long"><p>Shows all the elements in the series.</p>
478 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
479 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.chart.series.Gauge.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
480 <span class="pre">Boolean queueSuspended</span>)
481  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.chart.series.Gauge.html#resumeEvents" rel="Ext.chart.series.Gauge#resumeEvents" class="docClass">resumeEvents</a>)</p>
482 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.chart.series.Gauge.html#resumeEvents" rel="Ext.chart.series.Gauge#resumeEvents" class="docClass">resumeEvents</a>)</p>
483 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
484 after the <a href="Ext.chart.series.Gauge.html#resumeEvents" rel="Ext.chart.series.Gauge#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
485 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
486 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.chart.series.Gauge.html#" rel="method-un" class="cls expand">un</a>(
487 <span class="pre">String eventName, Function handler, [Object scope]</span>)
488  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.chart.series.Gauge.html#removeListener" rel="Ext.chart.series.Gauge#removeListener" class="docClass">removeListener</a>.)</p>
489 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.chart.series.Gauge.html#removeListener" rel="Ext.chart.series.Gauge#removeListener" class="docClass">removeListener</a>.)</p>
490 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
491 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.chart.series.Gauge.html#addListener" rel="Ext.chart.series.Gauge#addListener" class="docClass">addListener</a> call.</b></p>
492 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
493 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
494 </li></ul></div></div></div><div id="method-unHighlightItem" class="member inherited"><a href="Ext.chart.series.Gauge.html#method-unHighlightItem" rel="method-unHighlightItem" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.Highlight.html" class="definedIn docClass">Ext.chart.Highlight</a><br/><a href="../source/Highlight.html#Ext-chart.Highlight-method-unHighlightItem" class="viewSource">view source</a></div><a name="unHighlightItem"></a><a name="method-unHighlightItem"></a><a href="Ext.chart.series.Gauge.html#" rel="method-unHighlightItem" class="cls expand">unHighlightItem</a> : void</div><div class="description"><div class="short"><p>Un-highlight any existing highlights</p>
495 </div><div class="long"><p>Un-highlight any existing highlights</p>
496 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
497 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-titlechange" class="member f inherited"><a href="Ext.chart.series.Gauge.html#event-titlechange" rel="event-titlechange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Series.html" class="definedIn docClass">Ext.chart.series.Series</a><br/><a href="../source/Series.html#Ext-chart.series.Series-event-titlechange" class="viewSource">view source</a></div><a name="titlechange"></a><a name="event-titlechange"></a><a href="Ext.chart.series.Gauge.html#" rel="event-titlechange" class="cls expand">titlechange</a>(
498 <span class="pre">String title, Number index</span>)
499 </div><div class="description"><div class="short"><p>Fires when the series title is changed via <a href="Ext.chart.series.Gauge.html#setTitle" rel="Ext.chart.series.Gauge#setTitle" class="docClass">setTitle</a>.</p>
500 </div><div class="long"><p>Fires when the series title is changed via <a href="Ext.chart.series.Gauge.html#setTitle" rel="Ext.chart.series.Gauge#setTitle" class="docClass">setTitle</a>.</p>
501 <h3 class="pa">Parameters</h3><ul><li><span class="pre">title</span> : String<div class="sub-desc"><p>The new title value</p>
502 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index in the collection of titles</p>
503 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>