1 <!DOCTYPE html><html><head><title>Ext.chart.series.Bar | 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">
12 origDocClass: 'Ext.chart.series.Bar',
13 docClass: 'Ext.chart.series.Bar',
14 docReq: 'Ext.chart.series.Bar',
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 = 'Bar2.html#Ext-chart.series.Bar';
33 clsInfo = {"methods":["Bar","addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","drawSeries","enableBubble","fireEvent","getItemForPoint","getLegendColor","hasListener","hideAll","highlightItem","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","setTitle","showAll","suspendEvents","un","unHighlightItem"],"cfgs":["color","column","display","field","font","groupGutter","gutter","highlight","listeners","minMargin","orientation","renderer","shadowAttributes","showInLegend","style","tips","title","type","xPadding","yPadding"],"properties":["axis","highlight","xField","yField"],"events":["titlechange"],"subclasses":["Ext.chart.series.Column"]};
34 Ext.onReady(function() {
35 Ext.create('Docs.classPanel');
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Bar2.html#Ext-chart.series.Bar" target="_blank">Ext.chart.series.Bar</a></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"><a href="Ext.chart.series.Cartesian.html" rel="Ext.chart.series.Cartesian" class="cls docClass">Ext.chart.series.Cartesian</a><div class="subclass"><strong>Ext.chart.series.Bar</strong></div></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 Bar Chart. A Bar Chart is a useful visualization technique to display quantitative information for
38 different categories that can show some progression (or regression) in the dataset. As with all other series, the Bar
39 Series must be appended in the <em>series</em> Chart array configuration. See the Chart documentation for more information.
40 A typical configuration object for the bar series could be:</p>
42 <p><img class="screenshot" src="../Ext.chart.series.Bar.png" alt="Ext.chart.series.Bar chart series" /></p>
44 <pre class="prettyprint"><code>var store = Ext.create('Ext.data.JsonStore', {
45 fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'],
47 {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13},
48 {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3},
49 {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7},
50 {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23},
51 {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33}
55 Ext.create('Ext.chart.Chart', {
56 renderTo: Ext.getBody(),
66 renderer: Ext.util.Format.numberRenderer('0,0')
68 title: 'Sample Values',
75 title: 'Sample Metrics'
85 renderer: function(storeItem, item) {
86 this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');
92 renderer: Ext.util.Format.numberRenderer('0'),
93 orientation: 'horizontal',
95 'text-anchor': 'middle'
103 <p>In this configuration we set <code>bar</code> as the series type, bind the values of the bar to the bottom axis and set the
104 xField or category field to the <code>name</code> parameter of the store. We also set <code>highlight</code> to true which enables smooth
105 animations when bars are hovered. We also set some configuration for the bar labels to be displayed inside the bar,
106 to display the information found in the <code>data1</code> property of each element store, to render a formated text with the
107 <code>Ext.util.Format</code> we pass in, to have an <code>horizontal</code> orientation (as opposed to a vertical one) and we also set
108 other styles like <code>color</code>, <code>text-anchor</code>, etc.</p>
109 <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-color" class="member f inherited"><a href="Ext.chart.series.Bar.html#config-color" rel="config-color" class="expand more"><span> </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.Bar.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.
110 Default value: '#000' (black).</p>
111 </div><div class="long"><p>The color of the label text.
112 Default value: '#000' (black).</p>
113 </div></div></div><div id="config-column" class="member ni"><a href="Ext.chart.series.Bar.html#config-column" rel="config-column" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Bar.html" class="definedIn docClass">Ext.chart.series.Bar</a><br/><a href="../source/Bar2.html#Ext-chart.series.Bar-cfg-column" class="viewSource">view source</a></div><a name="column"></a><a name="config-column"></a><a href="Ext.chart.series.Bar.html#" rel="config-column" class="cls expand">column</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Whether to set the visualization as column chart or horizontal bar chart.</p>
114 </div><div class="long"><p>Whether to set the visualization as column chart or horizontal bar chart.</p>
115 </div></div></div><div id="config-display" class="member inherited"><a href="Ext.chart.series.Bar.html#config-display" rel="config-display" class="expand more ar"><span> </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.Bar.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",
116 "insideEn...</div><div class="long"><p>Specifies the presence and position of labels for each pie slice. Either "rotate", "middle", "insideStart",
117 "insideEnd", "outside", "over", "under", or "none" to prevent label rendering.
118 Default value: 'none'.</p>
119 </div></div></div><div id="config-field" class="member inherited"><a href="Ext.chart.series.Bar.html#config-field" rel="config-field" class="expand more"><span> </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.Bar.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.
120 Default value: 'name'.</p>
121 </div><div class="long"><p>The name of the field to be displayed in the label.
122 Default value: 'name'.</p>
123 </div></div></div><div id="config-font" class="member inherited"><a href="Ext.chart.series.Bar.html#config-font" rel="config-font" class="expand more"><span> </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.Bar.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.
124 Defautl value: "11px Helvetica, sans-serif".</p>
125 </div><div class="long"><p>The font used for the labels.
126 Defautl value: "11px Helvetica, sans-serif".</p>
127 </div></div></div><div id="config-groupGutter" class="member ni"><a href="Ext.chart.series.Bar.html#config-groupGutter" rel="config-groupGutter" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Bar.html" class="definedIn docClass">Ext.chart.series.Bar</a><br/><a href="../source/Bar2.html#Ext-chart.series.Bar-cfg-groupGutter" class="viewSource">view source</a></div><a name="groupGutter"></a><a name="config-groupGutter"></a><a href="Ext.chart.series.Bar.html#" rel="config-groupGutter" class="cls expand">groupGutter</a><span> : Number</span></div><div class="description"><div class="short"><p>The gutter space between groups of bars, as a percentage of the bar width</p>
128 </div><div class="long"><p>The gutter space between groups of bars, as a percentage of the bar width</p>
129 </div></div></div><div id="config-gutter" class="member ni"><a href="Ext.chart.series.Bar.html#config-gutter" rel="config-gutter" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Bar.html" class="definedIn docClass">Ext.chart.series.Bar</a><br/><a href="../source/Bar2.html#Ext-chart.series.Bar-cfg-gutter" class="viewSource">view source</a></div><a name="gutter"></a><a name="config-gutter"></a><a href="Ext.chart.series.Bar.html#" rel="config-gutter" class="cls expand">gutter</a><span> : Number</span></div><div class="description"><div class="short"><p>The gutter space between single bars, as a percentage of the bar width</p>
130 </div><div class="long"><p>The gutter space between single bars, as a percentage of the bar width</p>
131 </div></div></div><div id="config-highlight" class="member inherited"><a href="Ext.chart.series.Bar.html#config-highlight" rel="config-highlight" class="expand more ar"><span> </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.Bar.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
132 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
133 with the mouse. This parameter can also be an object with the same style
134 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
135 styles to markers and series.</p>
136 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.chart.series.Bar.html#config-listeners" rel="config-listeners" class="expand more ar"><span> </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.Bar.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
137 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
138 object during initialization. This should be a valid listeners config object as specified in the
139 <a href="Ext.chart.series.Bar.html#addListener" rel="Ext.chart.series.Bar#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
141 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
144 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
147 <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
148 <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
149 events directly from a child element of a Component, we need to specify the <code>element</code> option to
150 identify the Component property to add a DOM listener to:</p>
152 <pre><code>new Ext.panel.Panel({
160 element: 'el', //bind to the underlying el property on the panel
161 fn: function(){ console.log('click el'); }
164 element: 'body', //bind to the underlying body property on the panel
165 fn: function(){ console.log('dblclick body'); }
173 </div></div></div><div id="config-minMargin" class="member inherited"><a href="Ext.chart.series.Bar.html#config-minMargin" rel="config-minMargin" class="expand more ar"><span> </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.Bar.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.
174 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.
175 This parameter is useful when using PieSeries width variable pie slice lengths.
176 Default value: 50.</p>
177 </div></div></div><div id="config-orientation" class="member inherited"><a href="Ext.chart.series.Bar.html#config-orientation" rel="config-orientation" class="expand more"><span> </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.Bar.html#" rel="config-orientation" class="cls expand">orientation</a><span> : String</span></div><div class="description"><div class="short"><p>Either "horizontal" or "vertical".
178 Dafault value: "horizontal".</p>
179 </div><div class="long"><p>Either "horizontal" or "vertical".
180 Dafault value: "horizontal".</p>
181 </div></div></div><div id="config-renderer" class="member inherited"><a href="Ext.chart.series.Bar.html#config-renderer" rel="config-renderer" class="expand more"><span> </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.Bar.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.
182 Default value: function(v) { return v; }</p>
183 </div><div class="long"><p>Optional function for formatting the label into a displayable value.
184 Default value: function(v) { return v; }</p>
185 </div></div></div><div id="config-shadowAttributes" class="member inherited"><a href="Ext.chart.series.Bar.html#config-shadowAttributes" rel="config-shadowAttributes" class="expand more"><span> </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.Bar.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>
186 </div><div class="long"><p>An array with shadow attributes</p>
187 </div></div></div><div id="config-showInLegend" class="member inherited"><a href="Ext.chart.series.Bar.html#config-showInLegend" rel="config-showInLegend" class="expand more"><span> </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-showInLegend" class="viewSource">view source</a></div><a name="showInLegend"></a><a name="config-showInLegend"></a><a href="Ext.chart.series.Bar.html#" rel="config-showInLegend" class="cls expand">showInLegend</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Whether to show this series in the legend.</p>
188 </div><div class="long"><p>Whether to show this series in the legend.</p>
189 </div></div></div><div id="config-style" class="member ni"><a href="Ext.chart.series.Bar.html#config-style" rel="config-style" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Bar.html" class="definedIn docClass">Ext.chart.series.Bar</a><br/><a href="../source/Bar2.html#Ext-chart.series.Bar-cfg-style" class="viewSource">view source</a></div><a name="style"></a><a name="config-style"></a><a href="Ext.chart.series.Bar.html#" rel="config-style" class="cls expand">style</a><span> : Object</span></div><div class="description"><div class="short"><p>Style properties that will override the theming series styles.</p>
190 </div><div class="long"><p>Style properties that will override the theming series styles.</p>
191 </div></div></div><div id="config-tips" class="member inherited"><a href="Ext.chart.series.Bar.html#config-tips" rel="config-tips" class="expand more ar"><span> </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.Bar.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
192 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
193 same configuration used with <a href="Ext.tip.ToolTip.html" rel="Ext.tip.ToolTip" class="docClass">Ext.tip.ToolTip</a>. For example:</p>
199 renderer: function(storeItem, item) {
200 this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');
204 </div></div></div><div id="config-title" class="member inherited"><a href="Ext.chart.series.Bar.html#config-title" rel="config-title" class="expand more"><span> </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.Bar.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>
205 </div><div class="long"><p>The human-readable name of the series.</p>
206 </div></div></div><div id="config-type" class="member inherited"><a href="Ext.chart.series.Bar.html#config-type" rel="config-type" class="expand more"><span> </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.Bar.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>
207 </div><div class="long"><p>The type of series. Set in subclasses.</p>
208 </div></div></div><div id="config-xPadding" class="member ni"><a href="Ext.chart.series.Bar.html#config-xPadding" rel="config-xPadding" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Bar.html" class="definedIn docClass">Ext.chart.series.Bar</a><br/><a href="../source/Bar2.html#Ext-chart.series.Bar-cfg-xPadding" class="viewSource">view source</a></div><a name="xPadding"></a><a name="config-xPadding"></a><a href="Ext.chart.series.Bar.html#" rel="config-xPadding" class="cls expand">xPadding</a><span> : Number</span></div><div class="description"><div class="short"><p>Padding between the left/right axes and the bars</p>
209 </div><div class="long"><p>Padding between the left/right axes and the bars</p>
210 </div></div></div><div id="config-yPadding" class="member ni"><a href="Ext.chart.series.Bar.html#config-yPadding" rel="config-yPadding" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Bar.html" class="definedIn docClass">Ext.chart.series.Bar</a><br/><a href="../source/Bar2.html#Ext-chart.series.Bar-cfg-yPadding" class="viewSource">view source</a></div><a name="yPadding"></a><a name="config-yPadding"></a><a href="Ext.chart.series.Bar.html#" rel="config-yPadding" class="cls expand">yPadding</a><span> : Number</span></div><div class="description"><div class="short"><p>Padding between the top/bottom axes and the bars</p>
211 </div><div class="long"><p>Padding between the top/bottom axes and the bars</p>
212 </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-axis" class="member f inherited"><a href="Ext.chart.series.Bar.html#property-axis" rel="property-axis" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Cartesian.html" class="definedIn docClass">Ext.chart.series.Cartesian</a><br/><a href="../source/Cartesian.html#Ext-chart.series.Cartesian-property-axis" class="viewSource">view source</a></div><a name="axis"></a><a name="property-axis"></a><a href="Ext.chart.series.Bar.html#" rel="property-axis" class="cls expand">axis</a><span> : String</span></div><div class="description"><div class="short"><p>Indicates which axis the series will bind to</p>
213 </div><div class="long"><p>Indicates which axis the series will bind to</p>
214 </div></div></div><div id="property-highlight" class="member inherited"><a href="Ext.chart.series.Bar.html#property-highlight" rel="property-highlight" class="expand more"><span> </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.Bar.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>
215 </div><div class="long"><p>Highlight the given series item.</p>
216 </div></div></div><div id="property-xField" class="member inherited"><a href="Ext.chart.series.Bar.html#property-xField" rel="property-xField" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Cartesian.html" class="definedIn docClass">Ext.chart.series.Cartesian</a><br/><a href="../source/Cartesian.html#Ext-chart.series.Cartesian-property-xField" class="viewSource">view source</a></div><a name="xField"></a><a name="property-xField"></a><a href="Ext.chart.series.Bar.html#" rel="property-xField" class="cls expand">xField</a><span> : String</span></div><div class="description"><div class="short"><p>The field used to access the x axis value from the items from the data
218 </div><div class="long"><p>The field used to access the x axis value from the items from the data
220 </div></div></div><div id="property-yField" class="member inherited"><a href="Ext.chart.series.Bar.html#property-yField" rel="property-yField" class="expand more"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Cartesian.html" class="definedIn docClass">Ext.chart.series.Cartesian</a><br/><a href="../source/Cartesian.html#Ext-chart.series.Cartesian-property-yField" class="viewSource">view source</a></div><a name="yField"></a><a name="property-yField"></a><a href="Ext.chart.series.Bar.html#" rel="property-yField" class="cls expand">yField</a><span> : String</span></div><div class="description"><div class="short"><p>The field used to access the y-axis value from the items from the data
222 </div><div class="long"><p>The field used to access the y-axis value from the items from the data
224 </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-Bar" class="member f inherited"><a href="Ext.chart.series.Bar.html#method-Bar" rel="method-Bar" class="expand more ar"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Cartesian.html" class="definedIn docClass">Ext.chart.series.Cartesian</a><br/><a href="../source/Cartesian.html#Ext-chart.series.Cartesian-method-constructor" class="viewSource">view source</a></div><a name="Bar"></a><a name="method-Bar"></a><a href="Ext.chart.series.Bar.html#" rel="method-Bar" class="cls expand">Bar</a> : void</div><div class="description"><div class="short"><p> </p></div><div class="long">
225 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
226 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.chart.series.Bar.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span> </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.Bar.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
227 <span class="pre">Object/String o, String </span>)
228 : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
229 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
230 <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>
231 or the first event name string if multiple event names are being passed as separate parameters.</p>
232 </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.
235 <pre><code>this.addEvents('storeloaded', 'storecleared');
238 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
239 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.chart.series.Bar.html#method-addListener" rel="method-addListener" class="expand more ar"><span> </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.Bar.html#" rel="method-addListener" class="cls expand">addListener</a>(
240 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
241 : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
242 </div><div class="long"><p>Appends an event handler to this object.</p>
243 <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>
244 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
245 </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.
246 <b>If omitted, defaults to the object which fired the event.</b></p>
247 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
248 properties. This may contain any of the following properties:<ul>
249 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
250 <b>If omitted, defaults to the object which fired the event.</b></div></li>
251 <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>
252 <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>
253 <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
254 by the specified number of milliseconds. If the event fires again within that time, the original
255 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
256 <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>
257 if the event was bubbled up from a child Observable.</div></li>
258 <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>
259 The name of a Component property which references an element to add a listener to.</p>
261 <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
262 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
263 <pre><code>new Ext.panel.Panel({
266 click: this.handlePanelClick,
273 <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>
280 <b>Combining Options</b><br>
281 Using the options argument, it is possible to combine different types of listeners:<br>
283 A delayed, one-time listener.
284 <pre><code>myPanel.on('hide', this.handleClick, this, {
289 <b>Attaching multiple handlers in 1 call</b><br>
290 The method also allows for a single argument to be passed which is a config object containing properties
291 which specify multiple events. For example:
292 <pre><code>myGridPanel.on({
293 cellClick: this.onCellClick,
294 mouseover: this.onMouseOver,
295 mouseout: this.onMouseOut,
296 scope: this // Important. Ensure "this" is correct during handler execution
301 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
302 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.chart.series.Bar.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span> </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.Bar.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
303 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
304 : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
307 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
310 <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>
311 </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>
312 </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
313 is the handler function.</p>
314 </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
315 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
316 </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
317 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
318 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
319 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.chart.series.Bar.html#method-capture" rel="method-capture" class="expand more ar"><span> </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.Bar.html#" rel="method-capture" class="cls expand">capture</a>(
320 <span class="pre">Observable o, Function fn, [Object scope]</span>)
321 : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
322 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
323 to the supplied function with the event name + standard signature of the event
324 <b>before</b> the event is fired. If the supplied function returns false,
325 the event will not fire.</p>
326 <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>
327 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
328 </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>
329 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
330 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.chart.series.Bar.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span> </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.Bar.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>
331 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
332 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
333 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.chart.series.Bar.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span> </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.Bar.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>
334 </div><div class="long"><p>Removes all managed listeners for this object.</p>
335 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
336 </li></ul></div></div></div><div id="method-drawSeries" class="member ni"><a href="Ext.chart.series.Bar.html#method-drawSeries" rel="method-drawSeries" class="expand more ar"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Bar.html" class="definedIn docClass">Ext.chart.series.Bar</a><br/><a href="../source/Bar2.html#Ext-chart.series.Bar-method-drawSeries" class="viewSource">view source</a></div><a name="drawSeries"></a><a name="method-drawSeries"></a><a href="Ext.chart.series.Bar.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>
337 </div><div class="long"><p>Draws the series for the current chart.</p>
338 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
339 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.chart.series.Bar.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span> </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.Bar.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
340 <span class="pre">String/Array events</span>)
341 : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
342 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
343 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
346 <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
347 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
348 access the required target more quickly.</p>
354 <pre><code>Ext.override(Ext.form.field.Base, {
355 // Add functionality to Field's initComponent to enable the change event to bubble
356 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
357 this.enableBubble('change');
360 // We know that we want Field's events to bubble directly to the FormPanel.
361 getBubbleTarget : function() {
362 if (!this.formPanel) {
363 this.formPanel = this.findParentByType('form');
365 return this.formPanel;
369 var myForm = new Ext.formPanel({
370 title: 'User Details',
376 // Title goes red if form has been modified.
377 myForm.header.setStyle('color', 'red');
383 <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>
384 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
385 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.chart.series.Bar.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span> </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.Bar.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
386 <span class="pre">String eventName, Object... args</span>)
387 : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
390 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>
393 <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>)
394 by calling <a href="Ext.chart.series.Bar.html#enableBubble" rel="Ext.chart.series.Bar#enableBubble" class="docClass">enableBubble</a>.</p>
396 <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>
397 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
398 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span> <p>returns false if any of the handlers return false otherwise it returns true.</p>
399 </li></ul></div></div></div><div id="method-getItemForPoint" class="member inherited"><a href="Ext.chart.series.Bar.html#method-getItemForPoint" rel="method-getItemForPoint" class="expand more ar"><span> </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.Bar.html#" rel="method-getItemForPoint" class="cls expand">getItemForPoint</a>(
400 <span class="pre">Number x, Number y</span>)
401 : 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
403 </div><div class="long"><p>For a given x/y point relative to the Surface, find a corresponding item from this
405 <h3 class="pa">Parameters</h3><ul><li><span class="pre">x</span> : Number<div class="sub-desc">
406 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc">
407 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span> <p>An object describing the item, or null if there is no matching item. The exact contents of</p>
409 <pre><code> this object will vary by series type, but should always contain at least the following:
411 <li>{Ext.chart.series.Series} series - the Series object to which the item belongs</li>
412 <li>{Object} value - the value(s) of the item's data point</li>
413 <li>{Array} point - the x/y coordinates relative to the chart box of a single point
414 for this data item, which can be used as e.g. a tooltip anchor point.</li>
415 <li>{Ext.draw.Sprite} sprite - the item's rendering Sprite.
418 </li></ul></div></div></div><div id="method-getLegendColor" class="member ni"><a href="Ext.chart.series.Bar.html#method-getLegendColor" rel="method-getLegendColor" class="expand more ar"><span> </span></a><div class="title"><div class="meta"><a href="Ext.chart.series.Bar.html" class="definedIn docClass">Ext.chart.series.Bar</a><br/><a href="../source/Bar2.html#Ext-chart.series.Bar-method-getLegendColor" class="viewSource">view source</a></div><a name="getLegendColor"></a><a name="method-getLegendColor"></a><a href="Ext.chart.series.Bar.html#" rel="method-getLegendColor" class="cls expand">getLegendColor</a>(
419 <span class="pre">Object index</span>)
420 : void</div><div class="description"><div class="short"><p>Returns a string with the color to be used for the series legend item.</p>
421 </div><div class="long"><p>Returns a string with the color to be used for the series legend item.</p>
422 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Object<div class="sub-desc">
423 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
424 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.chart.series.Bar.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span> </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.Bar.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
425 <span class="pre">String eventName</span>)
426 : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
427 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
428 <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>
429 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span> <p>True if the event is being listened for, else false</p>
430 </li></ul></div></div></div><div id="method-hideAll" class="member inherited"><a href="Ext.chart.series.Bar.html#method-hideAll" rel="method-hideAll" class="expand more ar"><span> </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.Bar.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>
431 </div><div class="long"><p>Hides all the elements in the series.</p>
432 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
433 </li></ul></div></div></div><div id="method-highlightItem" class="member inherited"><a href="Ext.chart.series.Bar.html#method-highlightItem" rel="method-highlightItem" class="expand more ar"><span> </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.Bar.html#" rel="method-highlightItem" class="cls expand">highlightItem</a>(
434 <span class="pre">Object item</span>)
435 : void</div><div class="description"><div class="short"><p>Highlight the given series item.</p>
436 </div><div class="long"><p>Highlight the given series item.</p>
437 <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>
438 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
439 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.chart.series.Bar.html#method-observe" rel="method-observe" class="expand more ar"><span> </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.Bar.html#" rel="method-observe" class="cls expand">observe</a>(
440 <span class="pre">Function c, Object listeners</span>)
441 : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
443 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>
445 <p>This makes any event fired on any instance of the passed class also fire a single event through
446 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
450 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
451 Ext.data.Connection.on('beforerequest', function(con, options) {
452 console.log('Ajax request made to ' + options.url);
455 <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>
456 </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.Bar.html#addListener" rel="Ext.chart.series.Bar#addListener" class="docClass">addListener</a>.</p>
457 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
458 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.chart.series.Bar.html#method-on" rel="method-on" class="expand more ar"><span> </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.Bar.html#" rel="method-on" class="cls expand">on</a>(
459 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
460 : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.chart.series.Bar.html#addListener" rel="Ext.chart.series.Bar#addListener" class="docClass">addListener</a>.)</p>
461 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.chart.series.Bar.html#addListener" rel="Ext.chart.series.Bar#addListener" class="docClass">addListener</a>.)</p>
462 <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>
463 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
464 </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.
465 <b>If omitted, defaults to the object which fired the event.</b></p>
466 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
467 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
468 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.chart.series.Bar.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span> </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.Bar.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
469 <span class="pre">Object origin, Array events, Object prefix</span>)
470 : 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>
471 </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>
472 <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>
473 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
474 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
475 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
476 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.chart.series.Bar.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span> </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.Bar.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
477 <span class="pre">Observable o</span>)
478 : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
479 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
480 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
481 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
482 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.chart.series.Bar.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span> </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.Bar.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
483 <span class="pre">String eventName, Function handler, [Object scope]</span>)
484 : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
485 </div><div class="long"><p>Removes an event handler.</p>
486 <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>
487 </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.Bar.html#addListener" rel="Ext.chart.series.Bar#addListener" class="docClass">addListener</a> call.</b></p>
488 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
489 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
490 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.chart.series.Bar.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span> </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.Bar.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
491 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
492 : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.chart.series.Bar.html#mon" rel="Ext.chart.series.Bar#mon" class="docClass">mon</a> method.</p>
493 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.chart.series.Bar.html#mon" rel="Ext.chart.series.Bar#mon" class="docClass">mon</a> method.</p>
494 <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>
495 </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>
496 </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
497 is the handler function.</p>
498 </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
499 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
500 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
501 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.chart.series.Bar.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span> </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.Bar.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
502 If events were suspended using the queueSuspended parameter, then all
503 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.chart.series.Bar.html#suspendEvents" rel="Ext.chart.series.Bar#suspendEvents" class="docClass">suspendEvents</a>)
504 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
505 events fired during event suspension will be sent to any listeners now.</p>
506 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
507 </li></ul></div></div></div><div id="method-setTitle" class="member inherited"><a href="Ext.chart.series.Bar.html#method-setTitle" rel="method-setTitle" class="expand more ar"><span> </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.Bar.html#" rel="method-setTitle" class="cls expand">setTitle</a>(
508 <span class="pre">Number index, String title</span>)
509 : void</div><div class="description"><div class="short">Changes the value of the title for the series.
510 Arguments can take two forms:
513 A single String value: this will be us...</div><div class="long"><p>Changes the value of the <a href="Ext.chart.series.Bar.html#title" rel="Ext.chart.series.Bar#title" class="docClass">title</a> for the series.
514 Arguments can take two forms:</p>
517 <li>A single String value: this will be used as the new single title for the series (applies
518 to series with only one yField)</li>
519 <li>A numeric index and a String value: this will set the title for a single indexed yField.</li>
522 <h3 class="pa">Parameters</h3><ul><li><span class="pre">index</span> : Number<div class="sub-desc">
523 </div></li><li><span class="pre">title</span> : String<div class="sub-desc">
524 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
525 </li></ul></div></div></div><div id="method-showAll" class="member inherited"><a href="Ext.chart.series.Bar.html#method-showAll" rel="method-showAll" class="expand more ar"><span> </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.Bar.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>
526 </div><div class="long"><p>Shows all the elements in the series.</p>
527 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
528 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.chart.series.Bar.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span> </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.Bar.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
529 <span class="pre">Boolean queueSuspended</span>)
530 : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.chart.series.Bar.html#resumeEvents" rel="Ext.chart.series.Bar#resumeEvents" class="docClass">resumeEvents</a>)</p>
531 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.chart.series.Bar.html#resumeEvents" rel="Ext.chart.series.Bar#resumeEvents" class="docClass">resumeEvents</a>)</p>
532 <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
533 after the <a href="Ext.chart.series.Bar.html#resumeEvents" rel="Ext.chart.series.Bar#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
534 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
535 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.chart.series.Bar.html#method-un" rel="method-un" class="expand more ar"><span> </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.Bar.html#" rel="method-un" class="cls expand">un</a>(
536 <span class="pre">String eventName, Function handler, [Object scope]</span>)
537 : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.chart.series.Bar.html#removeListener" rel="Ext.chart.series.Bar#removeListener" class="docClass">removeListener</a>.)</p>
538 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.chart.series.Bar.html#removeListener" rel="Ext.chart.series.Bar#removeListener" class="docClass">removeListener</a>.)</p>
539 <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>
540 </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.Bar.html#addListener" rel="Ext.chart.series.Bar#addListener" class="docClass">addListener</a> call.</b></p>
541 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
542 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
543 </li></ul></div></div></div><div id="method-unHighlightItem" class="member inherited"><a href="Ext.chart.series.Bar.html#method-unHighlightItem" rel="method-unHighlightItem" class="expand more ar"><span> </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.Bar.html#" rel="method-unHighlightItem" class="cls expand">unHighlightItem</a> : void</div><div class="description"><div class="short"><p>Un-highlight any existing highlights</p>
544 </div><div class="long"><p>Un-highlight any existing highlights</p>
545 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>
546 </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.Bar.html#event-titlechange" rel="event-titlechange" class="expand more ar"><span> </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.Bar.html#" rel="event-titlechange" class="cls expand">titlechange</a>(
547 <span class="pre">String title, Number index</span>)
548 </div><div class="description"><div class="short"><p>Fires when the series title is changed via <a href="Ext.chart.series.Bar.html#setTitle" rel="Ext.chart.series.Bar#setTitle" class="docClass">setTitle</a>.</p>
549 </div><div class="long"><p>Fires when the series title is changed via <a href="Ext.chart.series.Bar.html#setTitle" rel="Ext.chart.series.Bar#setTitle" class="docClass">setTitle</a>.</p>
550 <h3 class="pa">Parameters</h3><ul><li><span class="pre">title</span> : String<div class="sub-desc"><p>The new title value</p>
551 </div></li><li><span class="pre">index</span> : Number<div class="sub-desc"><p>The index in the collection of titles</p>
552 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>