docs/output/Ext.chart.axis.Category.js

   1 Ext.data.JsonP.Ext_chart_axis_Category({
   2   "tagname": "class",
   3   "name": "Ext.chart.axis.Category",
   4   "doc": "<p>A type of axis that displays items in categories. This axis is generally used to\ndisplay categorical information like names of items, month names, quarters, etc.\nbut no quantitative values. For that other type of information <em>Number</em>\naxis are more suitable.</p>\n\n<p>As with other axis you can set the position of the axis and its title. For example:</p>\n\n<p><p><img src=\"doc-resources/Ext.chart.axis.Category/Ext.chart.axis.Category.png\" alt=\"Ext.chart.axis.Category chart axis\"></p></p>\n\n<pre><code>var store = Ext.create('Ext.data.JsonStore', {\n    fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'],\n    data: [\n        {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13},\n        {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3},\n        {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7},\n        {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23},\n        {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33}                                                \n    ]\n});\n\nExt.create('Ext.chart.Chart', {\n    renderTo: Ext.getBody(),\n    width: 500,\n    height: 300,\n    store: store,\n    axes: [{\n        type: 'Numeric',\n        grid: true,\n        position: 'left',\n        fields: ['data1', 'data2', 'data3', 'data4', 'data5'],\n        title: 'Sample Values',\n        grid: {\n            odd: {\n                opacity: 1,\n                fill: '#ddd',\n                stroke: '#bbb',\n                'stroke-width': 1\n            }\n        },\n        minimum: 0,\n        adjustMinimumByMajorUnit: 0\n    }, {\n        type: 'Category',\n        position: 'bottom',\n        fields: ['name'],\n        title: 'Sample Metrics',\n        grid: true,\n        label: {\n            rotate: {\n                degrees: 315\n            }\n        }\n    }],\n    series: [{\n        type: 'area',\n        highlight: false,\n        axis: 'left',\n        xField: 'name',\n        yField: ['data1', 'data2', 'data3', 'data4', 'data5'],\n        style: {\n            opacity: 0.93\n        }\n    }]\n});\n</code></pre>\n\n<p>In this example with set the category axis to the bottom of the surface, bound the axis to\nthe <em>name</em> property and set as title <em>Month of the Year</em>.</p>\n",
   5   "extends": "Ext.chart.axis.Axis",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10     "Ext.chart.CategoryAxis"
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "dashSize",
  21       "member": "Ext.chart.axis.Axis",
  22       "type": "Number",
  23       "doc": "<p>The size of the dash marker. Default's 3.</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
  26       "linenr": 69,
  27       "html_filename": "Axis.html",
  28       "href": "Axis.html#Ext-chart-axis-Axis-cfg-dashSize"
  29     },
  30     {
  31       "tagname": "cfg",
  32       "name": "length",
  33       "member": "Ext.chart.axis.Axis",
  34       "type": "Number",
  35       "doc": "<p>Offset axis position. Default's 0.</p>\n",
  36       "private": false,
  37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
  38       "linenr": 84,
  39       "html_filename": "Axis.html",
  40       "href": "Axis.html#Ext-chart-axis-Axis-cfg-length"
  41     },
  42     {
  43       "tagname": "cfg",
  44       "name": "majorTickSteps",
  45       "member": "Ext.chart.axis.Axis",
  46       "type": "Number",
  47       "doc": "<p>If <code>minimum</code> and <code>maximum</code> are specified it forces the number of major ticks to the specified value.</p>\n",
  48       "private": false,
  49       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
  50       "linenr": 56,
  51       "html_filename": "Axis.html",
  52       "href": "Axis.html#Ext-chart-axis-Axis-cfg-majorTickSteps"
  53     },
  54     {
  55       "tagname": "cfg",
  56       "name": "minorTickSteps",
  57       "member": "Ext.chart.axis.Axis",
  58       "type": "Number",
  59       "doc": "<p>The number of small ticks between two major ticks. Default is zero.</p>\n",
  60       "private": false,
  61       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
  62       "linenr": 61,
  63       "html_filename": "Axis.html",
  64       "href": "Axis.html#Ext-chart-axis-Axis-cfg-minorTickSteps"
  65     },
  66     {
  67       "tagname": "cfg",
  68       "name": "position",
  69       "member": "Ext.chart.axis.Axis",
  70       "type": "String",
  71       "doc": "<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>\n",
  72       "private": false,
  73       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
  74       "linenr": 75,
  75       "html_filename": "Axis.html",
  76       "href": "Axis.html#Ext-chart-axis-Axis-cfg-position"
  77     },
  78     {
  79       "tagname": "cfg",
  80       "name": "width",
  81       "member": "Ext.chart.axis.Axis",
  82       "type": "Number",
  83       "doc": "<p>Offset axis width. Default's 0.</p>\n",
  84       "private": false,
  85       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
  86       "linenr": 90,
  87       "html_filename": "Axis.html",
  88       "href": "Axis.html#Ext-chart-axis-Axis-cfg-width"
  89     }
  90   ],
  91   "method": [
  92     {
  93       "tagname": "method",
  94       "name": "drawAxis",
  95       "member": "Ext.chart.axis.Axis",
  96       "doc": "<p>Renders the axis into the screen and updates it's position.</p>\n",
  97       "params": [
  98         {
  99           "type": "Object",
 100           "name": "init",
 101           "doc": "\n",
 102           "optional": false
 103         }
 104       ],
 105       "return": {
 106         "type": "void",
 107         "doc": "\n"
 108       },
 109       "private": false,
 110       "static": false,
 111       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
 112       "linenr": 199,
 113       "html_filename": "Axis.html",
 114       "href": "Axis.html#Ext-chart-axis-Axis-method-drawAxis",
 115       "shortDoc": "<p>Renders the axis into the screen and updates it's position.</p>\n"
 116     },
 117     {
 118       "tagname": "method",
 119       "name": "drawGrid",
 120       "member": "Ext.chart.axis.Axis",
 121       "doc": "<p>Renders an horizontal and/or vertical grid into the Surface.</p>\n",
 122       "params": [
 123
 124       ],
 125       "return": {
 126         "type": "void",
 127         "doc": "\n"
 128       },
 129       "private": false,
 130       "static": false,
 131       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
 132       "linenr": 333,
 133       "html_filename": "Axis.html",
 134       "href": "Axis.html#Ext-chart-axis-Axis-method-drawGrid",
 135       "shortDoc": "<p>Renders an horizontal and/or vertical grid into the Surface.</p>\n"
 136     },
 137     {
 138       "tagname": "method",
 139       "name": "drawLabel",
 140       "member": "Ext.chart.axis.Axis",
 141       "doc": "<p>Renders the labels in the axes.</p>\n",
 142       "params": [
 143
 144       ],
 145       "return": {
 146         "type": "void",
 147         "doc": "\n"
 148       },
 149       "private": false,
 150       "static": false,
 151       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
 152       "linenr": 647,
 153       "html_filename": "Axis.html",
 154       "href": "Axis.html#Ext-chart-axis-Axis-method-drawLabel",
 155       "shortDoc": "<p>Renders the labels in the axes.</p>\n"
 156     },
 157     {
 158       "tagname": "method",
 159       "name": "setTitle",
 160       "member": "Ext.chart.axis.Axis",
 161       "doc": "<p>Updates the <a href=\"#/api/Ext.chart.axis.Category--title\" rel=\"Ext.chart.axis.Category--title\" class=\"docClass\">title</a> of this axis.</p>\n",
 162       "params": [
 163         {
 164           "type": "String",
 165           "name": "title",
 166           "doc": "\n",
 167           "optional": false
 168         }
 169       ],
 170       "return": {
 171         "type": "void",
 172         "doc": "\n"
 173       },
 174       "private": false,
 175       "static": false,
 176       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
 177       "linenr": 708,
 178       "html_filename": "Axis.html",
 179       "href": "Axis.html#Ext-chart-axis-Axis-method-setTitle",
 180       "shortDoc": "<p>Updates the <a href=\"#/api/Ext.chart.axis.Category--title\" rel=\"Ext.chart.axis.Category--title\" class=\"docClass\">title</a> of this axis.</p>\n"
 181     }
 182   ],
 183   "property": [
 184     {
 185       "tagname": "property",
 186       "name": "calculateCategoryCount",
 187       "member": "Ext.chart.axis.Category",
 188       "type": "Boolean",
 189       "doc": "<p>Indicates whether or not to calculate the number of categories (ticks and\nlabels) when there is not enough room to display all labels on the axis.\nIf set to true, the axis will determine the number of categories to plot.\nIf not, all categories will be plotted.</p>\n",
 190       "private": false,
 191       "static": false,
 192       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Category.js",
 193       "linenr": 94,
 194       "html_filename": "Category.html",
 195       "href": "Category.html#Ext-chart-axis-Category-property-calculateCategoryCount",
 196       "shortDoc": "Indicates whether or not to calculate the number of categories (ticks and\nlabels) when there is not enough room to di..."
 197     },
 198     {
 199       "tagname": "property",
 200       "name": "categoryNames",
 201       "member": "Ext.chart.axis.Category",
 202       "type": "Array",
 203       "doc": "<p>A list of category names to display along this axis.</p>\n",
 204       "private": false,
 205       "static": false,
 206       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Category.js",
 207       "linenr": 86,
 208       "html_filename": "Category.html",
 209       "href": "Category.html#Ext-chart-axis-Category-property-categoryNames"
 210     }
 211   ],
 212   "event": [
 213
 214   ],
 215   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Category.js",
 216   "linenr": 1,
 217   "html_filename": "Category.html",
 218   "href": "Category.html#Ext-chart-axis-Category",
 219   "cssVar": [
 220
 221   ],
 222   "cssMixin": [
 223
 224   ],
 225   "component": false,
 226   "superclasses": [
 227     "Ext.chart.axis.Abstract",
 228     "Ext.chart.axis.Axis"
 229   ],
 230   "subclasses": [
 231
 232   ],
 233   "mixedInto": [
 234
 235   ],
 236   "allMixins": [
 237
 238   ]
 239 });