docs/api/Ext.chart.axis.Gauge.html

   1 <!DOCTYPE html><html><head><title>Ext.chart.axis.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.axis.Gauge',
  13         docClass: 'Ext.chart.axis.Gauge',
  14         docReq: 'Ext.chart.axis.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 = 'Gauge.html#Ext-chart.axis.Gauge';
  33     clsInfo = {"methods":["setTitle"],"cfgs":["margin","maximum","minimum","steps"],"properties":[],"events":[],"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/Gauge.html#Ext-chart.axis.Gauge" target="_blank">Ext.chart.axis.Gauge</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.axis.Abstract.html" rel="Ext.chart.axis.Abstract" class="cls docClass">Ext.chart.axis.Abstract</a><div class="subclass"><strong>Ext.chart.axis.Gauge</strong></div></div></pre><p>Gauge Axis is the axis to be used with a Gauge series. The Gauge axis
  38 displays numeric data from an interval defined by the <code>minimum</code>, <code>maximum</code> and
  39 <code>step</code> configuration properties. The placement of the numeric data can be changed
  40 by altering the <code>margin</code> option that is set to <code>10</code> by default.</p>
  41
  42 <p>A possible configuration for this axis would look like:</p>
  43
  44 <pre class="prettyprint"><code>axes: [{
  45     type: 'gauge',
  46     position: 'gauge',
  47     minimum: 0,
  48     maximum: 100,
  49     steps: 10,
  50     margin: 7
  51 }],
  52 </code></pre>
  53 <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-margin" class="member f ni"><a href="Ext.chart.axis.Gauge.html#config-margin" rel="config-margin" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Gauge.html" class="definedIn docClass">Ext.chart.axis.Gauge</a><br/><a href="../source/Gauge.html#Ext-chart.axis.Gauge-cfg-margin" class="viewSource">view source</a></div><a name="margin"></a><a name="config-margin"></a><a href="Ext.chart.axis.Gauge.html#" rel="config-margin" class="cls expand">margin</a><span> : Number</span></div><div class="description"><div class="short"><p>(optional) the offset positioning of the tick marks and labels in pixels. Default's 10.</p>
  54 </div><div class="long"><p>(optional) the offset positioning of the tick marks and labels in pixels. Default's 10.</p>
  55 </div></div></div><div id="config-maximum" class="member ni"><a href="Ext.chart.axis.Gauge.html#config-maximum" rel="config-maximum" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Gauge.html" class="definedIn docClass">Ext.chart.axis.Gauge</a><br/><a href="../source/Gauge.html#Ext-chart.axis.Gauge-cfg-maximum" class="viewSource">view source</a></div><a name="maximum"></a><a name="config-maximum"></a><a href="Ext.chart.axis.Gauge.html#" rel="config-maximum" class="cls expand">maximum</a><span> : Number</span></div><div class="description"><div class="short"><p>(required) the maximum value of the interval to be displayed in the axis.</p>
  56 </div><div class="long"><p>(required) the maximum value of the interval to be displayed in the axis.</p>
  57 </div></div></div><div id="config-minimum" class="member ni"><a href="Ext.chart.axis.Gauge.html#config-minimum" rel="config-minimum" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Gauge.html" class="definedIn docClass">Ext.chart.axis.Gauge</a><br/><a href="../source/Gauge.html#Ext-chart.axis.Gauge-cfg-minimum" class="viewSource">view source</a></div><a name="minimum"></a><a name="config-minimum"></a><a href="Ext.chart.axis.Gauge.html#" rel="config-minimum" class="cls expand">minimum</a><span> : Number</span></div><div class="description"><div class="short"><p>(required) the minimum value of the interval to be displayed in the axis.</p>
  58 </div><div class="long"><p>(required) the minimum value of the interval to be displayed in the axis.</p>
  59 </div></div></div><div id="config-steps" class="member ni"><a href="Ext.chart.axis.Gauge.html#config-steps" rel="config-steps" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Gauge.html" class="definedIn docClass">Ext.chart.axis.Gauge</a><br/><a href="../source/Gauge.html#Ext-chart.axis.Gauge-cfg-steps" class="viewSource">view source</a></div><a name="steps"></a><a name="config-steps"></a><a href="Ext.chart.axis.Gauge.html#" rel="config-steps" class="cls expand">steps</a><span> : Number</span></div><div class="description"><div class="short"><p>(required) the number of steps and tick marks to add to the interval.</p>
  60 </div><div class="long"><p>(required) the number of steps and tick marks to add to the interval.</p>
  61 </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-setTitle" class="member f ni"><a href="Ext.chart.axis.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.axis.Gauge.html" class="definedIn docClass">Ext.chart.axis.Gauge</a><br/><a href="../source/Gauge.html#Ext-chart.axis.Gauge-method-setTitle" class="viewSource">view source</a></div><a name="setTitle"></a><a name="method-setTitle"></a><a href="Ext.chart.axis.Gauge.html#" rel="method-setTitle" class="cls expand">setTitle</a>(
  62 <span class="pre">String title</span>)
  63  : void</div><div class="description"><div class="short"><p>Updates the <a href="Ext.chart.axis.Gauge.html#title" rel="Ext.chart.axis.Gauge#title" class="docClass">title</a> of this axis.</p>
  64 </div><div class="long"><p>Updates the <a href="Ext.chart.axis.Gauge.html#title" rel="Ext.chart.axis.Gauge#title" class="docClass">title</a> of this axis.</p>
  65 <h3 class="pa">Parameters</h3><ul><li><span class="pre">title</span> : String<div class="sub-desc">
  66 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
  67 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>