Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.chart.axis.Category.html
diff --git a/docs/api/Ext.chart.axis.Category.html b/docs/api/Ext.chart.axis.Category.html
new file mode 100644 (file)
index 0000000..3814bbb
--- /dev/null
@@ -0,0 +1,142 @@
+<!DOCTYPE html><html><head><title>Ext.chart.axis.Category | 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]>
+<style type="text/css">.head-band { display: none; }
+.header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
+.doc-tab .members .member a.more { background-color: #efefef; }
+</style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
+</head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
+<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">
+
+    req = {
+        liveURL: '.',
+        standAloneMode: true,
+        origDocClass: 'Ext.chart.axis.Category',
+        docClass: 'Ext.chart.axis.Category',
+        docReq: 'Ext.chart.axis.Category',
+        version: '4.0',
+        baseURL: '.',
+        baseDocURL: '.',
+        baseProdURL: '.'
+    };
+
+    clsInfo = {};
+
+
+
+</script>
+
+<script type="text/javascript" src="../search.js"></script>
+<!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
+<script type="text/javascript" src="../class_tree.js"></script>
+<script type="text/javascript" src="../class_doc.js"></script>
+<script type="text/javascript">
+    req.source = 'Category.html#Ext-chart.axis.Category';
+    clsInfo = {"methods":["drawAxis","drawGrid","drawLabel","setTitle"],"cfgs":["dashSize","length","majorTickSteps","minorTickSteps","position","width"],"properties":["calculateCategoryCount","categoryNames"],"events":[],"subclasses":[]};
+    Ext.onReady(function() {
+        Ext.create('Docs.classPanel');
+    });
+</script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Category.html#Ext-chart.axis.Category" target="_blank">Ext.chart.axis.Category</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"><a href="Ext.chart.axis.Axis.html" rel="Ext.chart.axis.Axis" class="cls docClass">Ext.chart.axis.Axis</a><div class="subclass"><strong>Ext.chart.axis.Category</strong></div></div></div></pre><p>A type of axis that displays items in categories. This axis is generally used to
+display categorical information like names of items, month names, quarters, etc.
+but no quantitative values. For that other type of information <em>Number</em>
+axis are more suitable.</p>
+
+<p>As with other axis you can set the position of the axis and its title. For example:</p>
+
+<p><img class="screenshot" src="../Ext.chart.axis.Category.png" alt="Ext.chart.axis.Category chart axis" /></p>
+
+<pre class="prettyprint"><code>var store = Ext.create('Ext.data.JsonStore', {
+    fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'],
+    data: [
+        {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13},
+        {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3},
+        {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7},
+        {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23},
+        {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33}                                                
+    ]
+});
+
+Ext.create('Ext.chart.Chart', {
+    renderTo: Ext.getBody(),
+    width: 500,
+    height: 300,
+    store: store,
+    axes: [{
+        type: 'Numeric',
+        grid: true,
+        position: 'left',
+        fields: ['data1', 'data2', 'data3', 'data4', 'data5'],
+        title: 'Sample Values',
+        grid: {
+            odd: {
+                opacity: 1,
+                fill: '#ddd',
+                stroke: '#bbb',
+                'stroke-width': 1
+            }
+        },
+        minimum: 0,
+        adjustMinimumByMajorUnit: 0
+    }, {
+        type: 'Category',
+        position: 'bottom',
+        fields: ['name'],
+        title: 'Sample Metrics',
+        grid: true,
+        label: {
+            rotate: {
+                degrees: 315
+            }
+        }
+    }],
+    series: [{
+        type: 'area',
+        highlight: false,
+        axis: 'left',
+        xField: 'name',
+        yField: ['data1', 'data2', 'data3', 'data4', 'data5'],
+        style: {
+            opacity: 0.93
+        }
+    }]
+});
+</code></pre>
+
+<p>In this example with set the category axis to the bottom of the surface, bound the axis to
+the <em>name</em> property and set as title <em>Month of the Year</em>.</p>
+<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-dashSize" class="member f inherited"><a href="Ext.chart.axis.Category.html#config-dashSize" rel="config-dashSize" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-cfg-dashSize" class="viewSource">view source</a></div><a name="dashSize"></a><a name="config-dashSize"></a><a href="Ext.chart.axis.Category.html#" rel="config-dashSize" class="cls expand">dashSize</a><span> : Number</span></div><div class="description"><div class="short"><p>The size of the dash marker. Default's 3.</p>
+</div><div class="long"><p>The size of the dash marker. Default's 3.</p>
+</div></div></div><div id="config-length" class="member inherited"><a href="Ext.chart.axis.Category.html#config-length" rel="config-length" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-cfg-length" class="viewSource">view source</a></div><a name="length"></a><a name="config-length"></a><a href="Ext.chart.axis.Category.html#" rel="config-length" class="cls expand">length</a><span> : Number</span></div><div class="description"><div class="short"><p>Offset axis position. Default's 0.</p>
+</div><div class="long"><p>Offset axis position. Default's 0.</p>
+</div></div></div><div id="config-majorTickSteps" class="member inherited"><a href="Ext.chart.axis.Category.html#config-majorTickSteps" rel="config-majorTickSteps" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-cfg-majorTickSteps" class="viewSource">view source</a></div><a name="majorTickSteps"></a><a name="config-majorTickSteps"></a><a href="Ext.chart.axis.Category.html#" rel="config-majorTickSteps" class="cls expand">majorTickSteps</a><span> : Number</span></div><div class="description"><div class="short"><p>If <code>minimum</code> and <code>maximum</code> are specified it forces the number of major ticks to the specified value.</p>
+</div><div class="long"><p>If <code>minimum</code> and <code>maximum</code> are specified it forces the number of major ticks to the specified value.</p>
+</div></div></div><div id="config-minorTickSteps" class="member inherited"><a href="Ext.chart.axis.Category.html#config-minorTickSteps" rel="config-minorTickSteps" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-cfg-minorTickSteps" class="viewSource">view source</a></div><a name="minorTickSteps"></a><a name="config-minorTickSteps"></a><a href="Ext.chart.axis.Category.html#" rel="config-minorTickSteps" class="cls expand">minorTickSteps</a><span> : Number</span></div><div class="description"><div class="short"><p>The number of small ticks between two major ticks. Default is zero.</p>
+</div><div class="long"><p>The number of small ticks between two major ticks. Default is zero.</p>
+</div></div></div><div id="config-position" class="member inherited"><a href="Ext.chart.axis.Category.html#config-position" rel="config-position" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-cfg-position" class="viewSource">view source</a></div><a name="position"></a><a name="config-position"></a><a href="Ext.chart.axis.Category.html#" rel="config-position" class="cls expand">position</a><span> : String</span></div><div class="description"><div class="short"><p>Where to set the axis. Available options are <code>left</code>, <code>bottom</code>, <code>right</code>, <code>top</code>. Default's <code>bottom</code>.</p>
+</div><div class="long"><p>Where to set the axis. Available options are <code>left</code>, <code>bottom</code>, <code>right</code>, <code>top</code>. Default's <code>bottom</code>.</p>
+</div></div></div><div id="config-width" class="member inherited"><a href="Ext.chart.axis.Category.html#config-width" rel="config-width" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-cfg-width" class="viewSource">view source</a></div><a name="width"></a><a name="config-width"></a><a href="Ext.chart.axis.Category.html#" rel="config-width" class="cls expand">width</a><span> : Number</span></div><div class="description"><div class="short"><p>Offset axis width. Default's 0.</p>
+</div><div class="long"><p>Offset axis width. Default's 0.</p>
+</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-calculateCategoryCount" class="member f ni"><a href="Ext.chart.axis.Category.html#property-calculateCategoryCount" rel="property-calculateCategoryCount" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Category.html" class="definedIn docClass">Ext.chart.axis.Category</a><br/><a href="../source/Category.html#Ext-chart.axis.Category-property-calculateCategoryCount" class="viewSource">view source</a></div><a name="calculateCategoryCount"></a><a name="property-calculateCategoryCount"></a><a href="Ext.chart.axis.Category.html#" rel="property-calculateCategoryCount" class="cls expand">calculateCategoryCount</a><span> : Boolean</span></div><div class="description"><div class="short">Indicates whether or not to calculate the number of categories (ticks and
+labels) when there is not enough room to di...</div><div class="long"><p>Indicates whether or not to calculate the number of categories (ticks and
+labels) when there is not enough room to display all labels on the axis.
+If set to true, the axis will determine the number of categories to plot.
+If not, all categories will be plotted.</p>
+</div></div></div><div id="property-categoryNames" class="member ni"><a href="Ext.chart.axis.Category.html#property-categoryNames" rel="property-categoryNames" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Category.html" class="definedIn docClass">Ext.chart.axis.Category</a><br/><a href="../source/Category.html#Ext-chart.axis.Category-property-categoryNames" class="viewSource">view source</a></div><a name="categoryNames"></a><a name="property-categoryNames"></a><a href="Ext.chart.axis.Category.html#" rel="property-categoryNames" class="cls expand">categoryNames</a><span> : Array</span></div><div class="description"><div class="short"><p>A list of category names to display along this axis.</p>
+</div><div class="long"><p>A list of category names to display along this axis.</p>
+</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-drawAxis" class="member f inherited"><a href="Ext.chart.axis.Category.html#method-drawAxis" rel="method-drawAxis" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-method-drawAxis" class="viewSource">view source</a></div><a name="drawAxis"></a><a name="method-drawAxis"></a><a href="Ext.chart.axis.Category.html#" rel="method-drawAxis" class="cls expand">drawAxis</a>(
+<span class="pre">Object init</span>)
+ : void</div><div class="description"><div class="short"><p>Renders the axis into the screen and updates it's position.</p>
+</div><div class="long"><p>Renders the axis into the screen and updates it's position.</p>
+<h3 class="pa">Parameters</h3><ul><li><span class="pre">init</span> : Object<div class="sub-desc">
+</div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
+</li></ul></div></div></div><div id="method-drawGrid" class="member inherited"><a href="Ext.chart.axis.Category.html#method-drawGrid" rel="method-drawGrid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-method-drawGrid" class="viewSource">view source</a></div><a name="drawGrid"></a><a name="method-drawGrid"></a><a href="Ext.chart.axis.Category.html#" rel="method-drawGrid" class="cls expand">drawGrid</a> : void</div><div class="description"><div class="short"><p>Renders an horizontal and/or vertical grid into the Surface.</p>
+</div><div class="long"><p>Renders an horizontal and/or vertical grid into the Surface.</p>
+<h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
+</li></ul></div></div></div><div id="method-drawLabel" class="member inherited"><a href="Ext.chart.axis.Category.html#method-drawLabel" rel="method-drawLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.chart.axis.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-method-drawLabel" class="viewSource">view source</a></div><a name="drawLabel"></a><a name="method-drawLabel"></a><a href="Ext.chart.axis.Category.html#" rel="method-drawLabel" class="cls expand">drawLabel</a> : void</div><div class="description"><div class="short"><p>Renders the labels in the axes.</p>
+</div><div class="long"><p>Renders the labels in the axes.</p>
+<h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
+</li></ul></div></div></div><div id="method-setTitle" class="member inherited"><a href="Ext.chart.axis.Category.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.Axis.html" class="definedIn docClass">Ext.chart.axis.Axis</a><br/><a href="../source/Axis.html#Ext-chart.axis.Axis-method-setTitle" class="viewSource">view source</a></div><a name="setTitle"></a><a name="method-setTitle"></a><a href="Ext.chart.axis.Category.html#" rel="method-setTitle" class="cls expand">setTitle</a>(
+<span class="pre">String title</span>)
+ : void</div><div class="description"><div class="short"><p>Updates the <a href="Ext.chart.axis.Category.html#title" rel="Ext.chart.axis.Category#title" class="docClass">title</a> of this axis.</p>
+</div><div class="long"><p>Updates the <a href="Ext.chart.axis.Category.html#title" rel="Ext.chart.axis.Category#title" class="docClass">title</a> of this axis.</p>
+<h3 class="pa">Parameters</h3><ul><li><span class="pre">title</span> : String<div class="sub-desc">
+</div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
+</li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>
\ No newline at end of file