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

   1 Ext.data.JsonP.Ext_chart_axis_Axis({
   2   "tagname": "class",
   3   "name": "Ext.chart.axis.Axis",
   4   "doc": "<p>Defines axis for charts. The axis position, type, style can be configured.\nThe axes are defined in an axes array of configuration objects where the type,\nfield, grid and other configuration options can be set. To know more about how\nto create a Chart please check the Chart class documentation. Here's an example for the axes part:\nAn example of axis for a series (in this case for an area chart that has multiple layers of yFields) could be:</p>\n\n<pre><code>axes: [{\n    type: 'Numeric',\n    grid: true,\n    position: 'left',\n    fields: ['data1', 'data2', 'data3'],\n    title: 'Number of Hits',\n    grid: {\n        odd: {\n            opacity: 1,\n            fill: '#ddd',\n            stroke: '#bbb',\n            'stroke-width': 1\n        }\n    },\n    minimum: 0\n}, {\n    type: 'Category',\n    position: 'bottom',\n    fields: ['name'],\n    title: 'Month of the Year',\n    grid: true,\n    label: {\n        rotate: {\n            degrees: 315\n        }\n    }\n}]\n</code></pre>\n\n<p>In this case we use a <code>Numeric</code> axis for displaying the values of the Area series and a <code>Category</code> axis for displaying the names of\nthe store elements. The numeric axis is placed on the left of the screen, while the category axis is placed at the bottom of the chart.\nBoth the category and numeric axes have <code>grid</code> set, which means that horizontal and vertical lines will cover the chart background. In the\ncategory axis the labels will be rotated so they can fit the space better.</p>\n",
   5   "extends": "Ext.chart.axis.Abstract",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10     "Ext.chart.Axis"
  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.Axis--title\" rel=\"Ext.chart.axis.Axis--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.Axis--title\" rel=\"Ext.chart.axis.Axis--title\" class=\"docClass\">title</a> of this axis.</p>\n"
 181     }
 182   ],
 183   "property": [
 184
 185   ],
 186   "event": [
 187
 188   ],
 189   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
 190   "linenr": 1,
 191   "html_filename": "Axis.html",
 192   "href": "Axis.html#Ext-chart-axis-Axis",
 193   "cssVar": [
 194
 195   ],
 196   "cssMixin": [
 197
 198   ],
 199   "component": false,
 200   "superclasses": [
 201     "Ext.chart.axis.Abstract"
 202   ],
 203   "subclasses": [
 204     "Ext.chart.axis.Category",
 205     "Ext.chart.axis.Numeric",
 206     "Ext.chart.axis.Time"
 207   ],
 208   "mixedInto": [
 209
 210   ],
 211   "allMixins": [
 212
 213   ]
 214 });