docs/output/Ext.chart.Highlight.js

   1 Ext.data.JsonP.Ext_chart_Highlight({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9
  10     ],
  11     "method": [
  12       {
  13         "deprecated": null,
  14         "alias": null,
  15         "protected": false,
  16         "tagname": "method",
  17         "href": "Base3.html#Ext-Base-method-addStatics",
  18         "shortDoc": "Add / override static properties of this class. ...",
  19         "static": true,
  20         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
  21         "private": false,
  22         "params": [
  23           {
  24             "type": "Object",
  25             "optional": false,
  26             "doc": "\n",
  27             "name": "members"
  28           }
  29         ],
  30         "name": "addStatics",
  31         "owner": "Ext.Base",
  32         "doc": "<p>Add / override static properties of this class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n</code></pre>\n",
  33         "linenr": 388,
  34         "return": {
  35           "type": "Ext.Base",
  36           "doc": "<p>this</p>\n"
  37         },
  38         "html_filename": "Base3.html"
  39       },
  40       {
  41         "deprecated": null,
  42         "alias": null,
  43         "protected": false,
  44         "tagname": "method",
  45         "href": "Base3.html#Ext-Base-method-callOverridden",
  46         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
  47         "static": false,
  48         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
  49         "private": false,
  50         "params": [
  51           {
  52             "type": "Array/Arguments",
  53             "optional": false,
  54             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
  55             "name": "args"
  56           }
  57         ],
  58         "name": "callOverridden",
  59         "owner": "Ext.Base",
  60         "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">Ext.Base.override</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
  61         "linenr": 269,
  62         "return": {
  63           "type": "Mixed",
  64           "doc": "<p>Returns the result after calling the overridden method</p>\n"
  65         },
  66         "html_filename": "Base3.html"
  67       },
  68       {
  69         "deprecated": null,
  70         "alias": null,
  71         "protected": true,
  72         "tagname": "method",
  73         "href": "Base3.html#Ext-Base-method-callParent",
  74         "shortDoc": "Call the parent's overridden method. ...",
  75         "static": false,
  76         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
  77         "private": false,
  78         "params": [
  79           {
  80             "type": "Array/Arguments",
  81             "optional": false,
  82             "doc": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
  83             "name": "args"
  84           }
  85         ],
  86         "name": "callParent",
  87         "owner": "Ext.Base",
  88         "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n</code></pre>\n",
  89         "linenr": 124,
  90         "return": {
  91           "type": "Mixed",
  92           "doc": "<p>Returns the result from the superclass' method</p>\n"
  93         },
  94         "html_filename": "Base3.html"
  95       },
  96       {
  97         "deprecated": null,
  98         "alias": null,
  99         "protected": false,
 100         "tagname": "method",
 101         "href": "Base3.html#Ext-Base-method-create",
 102         "shortDoc": "Create a new instance of this Class. ...",
 103         "static": true,
 104         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 105         "private": false,
 106         "params": [
 107
 108         ],
 109         "name": "create",
 110         "owner": "Ext.Base",
 111         "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
 112         "linenr": 329,
 113         "return": {
 114           "type": "Object",
 115           "doc": "<p>the created instance.</p>\n"
 116         },
 117         "html_filename": "Base3.html"
 118       },
 119       {
 120         "deprecated": null,
 121         "alias": null,
 122         "protected": false,
 123         "tagname": "method",
 124         "href": "Base3.html#Ext-Base-method-createAlias",
 125         "shortDoc": "Create aliases for existing prototype methods. ...",
 126         "static": true,
 127         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 128         "private": false,
 129         "params": [
 130           {
 131             "type": "String/Object",
 132             "optional": false,
 133             "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
 134             "name": "alias"
 135           },
 136           {
 137             "type": "String/Object",
 138             "optional": false,
 139             "doc": "<p>The original method name</p>\n",
 140             "name": "origin"
 141           }
 142         ],
 143         "name": "createAlias",
 144         "owner": "Ext.Base",
 145         "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -&gt; test.method1()\n</code></pre>\n",
 146         "linenr": 648,
 147         "return": {
 148           "type": "void",
 149           "doc": "\n"
 150         },
 151         "html_filename": "Base3.html"
 152       },
 153       {
 154         "deprecated": null,
 155         "alias": null,
 156         "protected": false,
 157         "tagname": "method",
 158         "href": "Base3.html#Ext-Base-method-getName",
 159         "shortDoc": "Get the current class' name in string format. ...",
 160         "static": false,
 161         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 162         "private": false,
 163         "params": [
 164
 165         ],
 166         "name": "getName",
 167         "owner": "Ext.Base",
 168         "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n</code></pre>\n",
 169         "linenr": 631,
 170         "return": {
 171           "type": "String",
 172           "doc": "<p>className</p>\n"
 173         },
 174         "html_filename": "Base3.html"
 175       },
 176       {
 177         "deprecated": null,
 178         "alias": null,
 179         "protected": false,
 180         "tagname": "method",
 181         "href": "Highlight.html#Ext-chart-Highlight-method-highlightItem",
 182         "shortDoc": "Highlight the given series item. ...",
 183         "static": false,
 184         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js",
 185         "private": false,
 186         "params": [
 187           {
 188             "type": "Object",
 189             "optional": false,
 190             "doc": "<p>Info about the item; same format as returned by #getItemForPoint.</p>\n",
 191             "name": "item"
 192           }
 193         ],
 194         "name": "highlightItem",
 195         "owner": "Ext.chart.Highlight",
 196         "doc": "<p>Highlight the given series item.</p>\n",
 197         "linenr": 38,
 198         "return": {
 199           "type": "void",
 200           "doc": "\n"
 201         },
 202         "html_filename": "Highlight.html"
 203       },
 204       {
 205         "deprecated": null,
 206         "alias": null,
 207         "protected": false,
 208         "tagname": "method",
 209         "href": "Base3.html#Ext-Base-method-implement",
 210         "shortDoc": "Add methods / properties to the prototype of this class. ...",
 211         "static": true,
 212         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 213         "private": false,
 214         "params": [
 215           {
 216             "type": "Object",
 217             "optional": false,
 218             "doc": "\n",
 219             "name": "members"
 220           }
 221         ],
 222         "name": "implement",
 223         "owner": "Ext.Base",
 224         "doc": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n</code></pre>\n",
 225         "linenr": 415,
 226         "return": {
 227           "type": "void",
 228           "doc": "\n"
 229         },
 230         "html_filename": "Base3.html"
 231       },
 232       {
 233         "deprecated": null,
 234         "alias": null,
 235         "protected": true,
 236         "tagname": "method",
 237         "href": "Base3.html#Ext-Base-method-initConfig",
 238         "shortDoc": "Initialize configuration for this class. ...",
 239         "static": false,
 240         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 241         "private": false,
 242         "params": [
 243           {
 244             "type": "Object",
 245             "optional": false,
 246             "doc": "\n",
 247             "name": "config"
 248           }
 249         ],
 250         "name": "initConfig",
 251         "owner": "Ext.Base",
 252         "doc": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n\n        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n</code></pre>\n",
 253         "linenr": 63,
 254         "return": {
 255           "type": "Object",
 256           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
 257         },
 258         "html_filename": "Base3.html"
 259       },
 260       {
 261         "deprecated": null,
 262         "alias": null,
 263         "protected": false,
 264         "tagname": "method",
 265         "href": "Base3.html#Ext-Base-method-override",
 266         "shortDoc": "Override prototype members of this class. ...",
 267         "static": true,
 268         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 269         "private": false,
 270         "params": [
 271           {
 272             "type": "Object",
 273             "optional": false,
 274             "doc": "\n",
 275             "name": "members"
 276           }
 277         ],
 278         "name": "override",
 279         "owner": "Ext.Base",
 280         "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">Ext.Base.callOverridden</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
 281         "linenr": 518,
 282         "return": {
 283           "type": "Ext.Base",
 284           "doc": "<p>this</p>\n"
 285         },
 286         "html_filename": "Base3.html"
 287       },
 288       {
 289         "deprecated": null,
 290         "alias": null,
 291         "protected": true,
 292         "tagname": "method",
 293         "href": "Base3.html#Ext-Base-method-statics",
 294         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
 295         "static": false,
 296         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 297         "private": false,
 298         "params": [
 299
 300         ],
 301         "name": "statics",
 302         "owner": "Ext.Base",
 303         "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">Ext.Base.self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n\n        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n</code></pre>\n",
 304         "linenr": 199,
 305         "return": {
 306           "type": "Class",
 307           "doc": "\n"
 308         },
 309         "html_filename": "Base3.html"
 310       },
 311       {
 312         "deprecated": null,
 313         "alias": null,
 314         "protected": false,
 315         "tagname": "method",
 316         "href": "Highlight.html#Ext-chart-Highlight-method-unHighlightItem",
 317         "shortDoc": "Un-highlight any existing highlights ...",
 318         "static": false,
 319         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js",
 320         "private": false,
 321         "params": [
 322
 323         ],
 324         "name": "unHighlightItem",
 325         "owner": "Ext.chart.Highlight",
 326         "doc": "<p>Un-highlight any existing highlights</p>\n",
 327         "linenr": 106,
 328         "return": {
 329           "type": "void",
 330           "doc": "\n"
 331         },
 332         "html_filename": "Highlight.html"
 333       }
 334     ],
 335     "property": [
 336       {
 337         "type": "Boolean",
 338         "deprecated": null,
 339         "alias": null,
 340         "protected": false,
 341         "tagname": "property",
 342         "href": "Highlight.html#Ext-chart-Highlight-property-highlight",
 343         "static": false,
 344         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js",
 345         "private": false,
 346         "name": "highlight",
 347         "owner": "Ext.chart.Highlight",
 348         "doc": "<p>Highlight the given series item.</p>\n",
 349         "linenr": 13,
 350         "html_filename": "Highlight.html"
 351       },
 352       {
 353         "type": "Class",
 354         "deprecated": null,
 355         "alias": null,
 356         "protected": true,
 357         "tagname": "property",
 358         "href": "Base3.html#Ext-Base-property-self",
 359         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
 360         "static": false,
 361         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
 362         "private": false,
 363         "name": "self",
 364         "owner": "Ext.Base",
 365         "doc": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>\nfor a detailed comparison</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); / dependent on 'this'\n\n        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n</code></pre>\n",
 366         "linenr": 18,
 367         "html_filename": "Base3.html"
 368       }
 369     ],
 370     "cssVar": [
 371
 372     ],
 373     "cssMixin": [
 374
 375     ],
 376     "event": [
 377
 378     ]
 379   },
 380   "singleton": false,
 381   "alias": null,
 382   "superclasses": [
 383     "Ext.Base"
 384   ],
 385   "protected": false,
 386   "tagname": "class",
 387   "mixins": [
 388
 389   ],
 390   "href": "Highlight.html#Ext-chart-Highlight",
 391   "subclasses": [
 392
 393   ],
 394   "static": false,
 395   "author": null,
 396   "component": false,
 397   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js",
 398   "private": false,
 399   "alternateClassNames": [
 400
 401   ],
 402   "name": "Ext.chart.Highlight",
 403   "doc": "<p>A mixin providing highlight functionality for Ext.chart.series.Series.</p>\n",
 404   "mixedInto": [
 405     "Ext.chart.series.Series"
 406   ],
 407   "linenr": 1,
 408   "xtypes": [
 409
 410   ],
 411   "html_filename": "Highlight.html",
 412   "extends": "Ext.Base"
 413 });