docs/output/Ext.chart.Mask.js

   1 Ext.data.JsonP.Ext_chart_Mask({
   2   "tagname": "class",
   3   "name": "Ext.chart.Mask",
   4   "doc": "<p>Defines a mask for a chart's series.\nThe 'chart' member must be set prior to rendering.</p>\n\n<p>A Mask can be used to select a certain region in a chart.\nWhen enabled, the <code>select</code> event will be triggered when a\nregion is selected by the mask, allowing the user to perform\nother tasks like zooming on that region, etc.</p>\n\n<p>In order to use the mask one has to set the Chart <code>mask</code> option to\n<code>true</code>, <code>vertical</code> or <code>horizontal</code>. Then a possible configuration for the\nlistener could be:</p>\n\n<pre><code>    items: {\n        xtype: 'chart',\n        animate: true,\n        store: store1,\n        mask: 'horizontal',\n        listeners: {\n            select: {\n                fn: function(me, selection) {\n                    me.setZoom(selection);\n                    me.mask.hide();\n                }\n            }\n        },\n</code></pre>\n\n<p>In this example we zoom the chart to that particular region. You can also get\na handle to a mask instance from the chart object. The <code>chart.mask</code> element is a\n<code>Ext.Panel</code>.</p>\n",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "Mask",
  24       "member": "Ext.chart.Mask",
  25       "doc": "\n",
  26       "params": [
  27
  28       ],
  29       "return": {
  30         "type": "void",
  31         "doc": "\n"
  32       },
  33       "private": false,
  34       "static": false,
  35       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Mask.js",
  36       "linenr": 1,
  37       "html_filename": "Mask.html",
  38       "href": "Mask.html#Ext-chart-Mask-method-constructor",
  39       "shortDoc": "\n"
  40     }
  41   ],
  42   "property": [
  43
  44   ],
  45   "event": [
  46
  47   ],
  48   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Mask.js",
  49   "linenr": 1,
  50   "html_filename": "Mask.html",
  51   "href": "Mask.html#Ext-chart-Mask",
  52   "cssVar": [
  53
  54   ],
  55   "cssMixin": [
  56
  57   ],
  58   "component": false,
  59   "superclasses": [
  60
  61   ],
  62   "subclasses": [
  63
  64   ],
  65   "mixedInto": [
  66     "Ext.chart.Chart"
  67   ],
  68   "allMixins": [
  69
  70   ]
  71 });