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

   1 Ext.data.JsonP.Ext_chart_axis_Numeric({
   2   "tagname": "class",
   3   "name": "Ext.chart.axis.Numeric",
   4   "doc": "<p>An axis to handle numeric values. This axis is used for quantitative data as\nopposed to the category axis. You can set mininum and maximum values to the\naxis so that the values are bound to that. If no values are set, then the\nscale will auto-adjust to the values.</p>\n\n<p><p><img src=\"doc-resources/Ext.chart.axis.Numeric/Ext.chart.axis.Numeric.png\" alt=\"Ext.chart.axis.Numeric chart axis\"></p></p>\n\n<p>For example:</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 we create an axis of Numeric type. We set a minimum value so that\neven if all series have values greater than zero, the grid starts at zero. We bind\nthe axis onto the left part of the surface by setting <em>position</em> to <em>left</em>.\nWe bind three different store fields to this axis by setting <em>fields</em> to an array.\nWe set the title of the axis to <em>Number of Hits</em> by using the <em>title</em> property.\nWe use a <em>grid</em> configuration to set odd background rows to a certain style and even rows\nto be transparent/ignored.</p>\n",
   5   "extends": "Ext.chart.axis.Axis",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10     "Ext.chart.NumericAxis"
  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": "Numeric",
  95       "member": "Ext.chart.axis.Numeric",
  96       "doc": "\n",
  97       "params": [
  98
  99       ],
 100       "return": {
 101         "type": "void",
 102         "doc": "\n"
 103       },
 104       "private": false,
 105       "static": false,
 106       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 107       "linenr": 1,
 108       "html_filename": "Numeric.html",
 109       "href": "Numeric.html#Ext-chart-axis-Numeric-method-constructor",
 110       "shortDoc": "\n"
 111     },
 112     {
 113       "tagname": "method",
 114       "name": "drawAxis",
 115       "member": "Ext.chart.axis.Axis",
 116       "doc": "<p>Renders the axis into the screen and updates it's position.</p>\n",
 117       "params": [
 118         {
 119           "type": "Object",
 120           "name": "init",
 121           "doc": "\n",
 122           "optional": false
 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": 199,
 133       "html_filename": "Axis.html",
 134       "href": "Axis.html#Ext-chart-axis-Axis-method-drawAxis",
 135       "shortDoc": "<p>Renders the axis into the screen and updates it's position.</p>\n"
 136     },
 137     {
 138       "tagname": "method",
 139       "name": "drawGrid",
 140       "member": "Ext.chart.axis.Axis",
 141       "doc": "<p>Renders an horizontal and/or vertical grid into the Surface.</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": 333,
 153       "html_filename": "Axis.html",
 154       "href": "Axis.html#Ext-chart-axis-Axis-method-drawGrid",
 155       "shortDoc": "<p>Renders an horizontal and/or vertical grid into the Surface.</p>\n"
 156     },
 157     {
 158       "tagname": "method",
 159       "name": "drawLabel",
 160       "member": "Ext.chart.axis.Axis",
 161       "doc": "<p>Renders the labels in the axes.</p>\n",
 162       "params": [
 163
 164       ],
 165       "return": {
 166         "type": "void",
 167         "doc": "\n"
 168       },
 169       "private": false,
 170       "static": false,
 171       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
 172       "linenr": 647,
 173       "html_filename": "Axis.html",
 174       "href": "Axis.html#Ext-chart-axis-Axis-method-drawLabel",
 175       "shortDoc": "<p>Renders the labels in the axes.</p>\n"
 176     },
 177     {
 178       "tagname": "method",
 179       "name": "setTitle",
 180       "member": "Ext.chart.axis.Axis",
 181       "doc": "<p>Updates the <a href=\"#/api/Ext.chart.axis.Numeric--title\" rel=\"Ext.chart.axis.Numeric--title\" class=\"docClass\">title</a> of this axis.</p>\n",
 182       "params": [
 183         {
 184           "type": "String",
 185           "name": "title",
 186           "doc": "\n",
 187           "optional": false
 188         }
 189       ],
 190       "return": {
 191         "type": "void",
 192         "doc": "\n"
 193       },
 194       "private": false,
 195       "static": false,
 196       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Axis.js",
 197       "linenr": 708,
 198       "html_filename": "Axis.html",
 199       "href": "Axis.html#Ext-chart-axis-Axis-method-setTitle",
 200       "shortDoc": "<p>Updates the <a href=\"#/api/Ext.chart.axis.Numeric--title\" rel=\"Ext.chart.axis.Numeric--title\" class=\"docClass\">title</a> of this axis.</p>\n"
 201     }
 202   ],
 203   "property": [
 204     {
 205       "tagname": "property",
 206       "name": "adjustMaximumByMajorUnit",
 207       "member": "Ext.chart.axis.Numeric",
 208       "type": "Boolean",
 209       "doc": "<p>Indicates whether to extend maximum beyond data's maximum to the nearest\nmajorUnit.</p>\n",
 210       "private": false,
 211       "static": false,
 212       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 213       "linenr": 160,
 214       "html_filename": "Numeric.html",
 215       "href": "Numeric.html#Ext-chart-axis-Numeric-property-adjustMaximumByMajorUnit"
 216     },
 217     {
 218       "tagname": "property",
 219       "name": "adjustMinimumByMajorUnit",
 220       "member": "Ext.chart.axis.Numeric",
 221       "type": "Boolean",
 222       "doc": "<p>Indicates whether to extend the minimum beyond data's minimum to the\nnearest majorUnit.</p>\n",
 223       "private": false,
 224       "static": false,
 225       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 226       "linenr": 169,
 227       "html_filename": "Numeric.html",
 228       "href": "Numeric.html#Ext-chart-axis-Numeric-property-adjustMinimumByMajorUnit"
 229     },
 230     {
 231       "tagname": "property",
 232       "name": "decimals",
 233       "member": "Ext.chart.axis.Numeric",
 234       "type": "Number",
 235       "doc": "<p>The number of decimals to round the value to.\nDefault's 2.</p>\n",
 236       "private": false,
 237       "static": false,
 238       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 239       "linenr": 134,
 240       "html_filename": "Numeric.html",
 241       "href": "Numeric.html#Ext-chart-axis-Numeric-property-decimals"
 242     },
 243     {
 244       "tagname": "property",
 245       "name": "maximum",
 246       "member": "Ext.chart.axis.Numeric",
 247       "type": "Number",
 248       "doc": "<p>The maximum value drawn by the axis. If not set explicitly, the axis\nmaximum will be calculated automatically.</p>\n",
 249       "private": false,
 250       "static": false,
 251       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 252       "linenr": 125,
 253       "html_filename": "Numeric.html",
 254       "href": "Numeric.html#Ext-chart-axis-Numeric-property-maximum"
 255     },
 256     {
 257       "tagname": "property",
 258       "name": "minimum",
 259       "member": "Ext.chart.axis.Numeric",
 260       "type": "Number",
 261       "doc": "<p>The minimum value drawn by the axis. If not set explicitly, the axis\nminimum will be calculated automatically.</p>\n",
 262       "private": false,
 263       "static": false,
 264       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 265       "linenr": 116,
 266       "html_filename": "Numeric.html",
 267       "href": "Numeric.html#Ext-chart-axis-Numeric-property-minimum"
 268     },
 269     {
 270       "tagname": "property",
 271       "name": "position",
 272       "member": "Ext.chart.axis.Numeric",
 273       "type": "String",
 274       "doc": "<p>Indicates the position of the axis relative to the chart</p>\n",
 275       "private": false,
 276       "static": false,
 277       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 278       "linenr": 152,
 279       "html_filename": "Numeric.html",
 280       "href": "Numeric.html#Ext-chart-axis-Numeric-property-position"
 281     },
 282     {
 283       "tagname": "property",
 284       "name": "scale",
 285       "member": "Ext.chart.axis.Numeric",
 286       "type": "String",
 287       "doc": "<p>The scaling algorithm to use on this axis. May be \"linear\" or\n\"logarithmic\".</p>\n",
 288       "private": false,
 289       "static": false,
 290       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 291       "linenr": 143,
 292       "html_filename": "Numeric.html",
 293       "href": "Numeric.html#Ext-chart-axis-Numeric-property-scale"
 294     }
 295   ],
 296   "event": [
 297
 298   ],
 299   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Numeric.js",
 300   "linenr": 1,
 301   "html_filename": "Numeric.html",
 302   "href": "Numeric.html#Ext-chart-axis-Numeric",
 303   "cssVar": [
 304
 305   ],
 306   "cssMixin": [
 307
 308   ],
 309   "component": false,
 310   "superclasses": [
 311     "Ext.chart.axis.Abstract",
 312     "Ext.chart.axis.Axis"
 313   ],
 314   "subclasses": [
 315
 316   ],
 317   "mixedInto": [
 318
 319   ],
 320   "allMixins": [
 321
 322   ]
 323 });