Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.chart.axis.Gauge.js
1 Ext.data.JsonP.Ext_chart_axis_Gauge({
2   "allMixins": [
3
4   ],
5   "deprecated": null,
6   "docauthor": null,
7   "members": {
8     "cfg": [
9       {
10         "type": "Number",
11         "deprecated": null,
12         "alias": null,
13         "protected": false,
14         "tagname": "cfg",
15         "href": "Gauge2.html#Ext-chart-axis-Gauge-cfg-margin",
16         "shortDoc": "(optional) the offset positioning of the tick marks and labels in pixels. ...",
17         "static": false,
18         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js",
19         "private": false,
20         "name": "margin",
21         "owner": "Ext.chart.axis.Gauge",
22         "doc": "<p>(optional) the offset positioning of the tick marks and labels in pixels. Default's 10.</p>\n",
23         "linenr": 41,
24         "html_filename": "Gauge2.html"
25       },
26       {
27         "type": "Number",
28         "deprecated": null,
29         "alias": null,
30         "protected": false,
31         "tagname": "cfg",
32         "href": "Gauge2.html#Ext-chart-axis-Gauge-cfg-maximum",
33         "static": false,
34         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js",
35         "private": false,
36         "name": "maximum",
37         "owner": "Ext.chart.axis.Gauge",
38         "doc": "<p>(required) the maximum value of the interval to be displayed in the axis.</p>\n",
39         "linenr": 33,
40         "html_filename": "Gauge2.html"
41       },
42       {
43         "type": "Number",
44         "deprecated": null,
45         "alias": null,
46         "protected": false,
47         "tagname": "cfg",
48         "href": "Gauge2.html#Ext-chart-axis-Gauge-cfg-minimum",
49         "static": false,
50         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js",
51         "private": false,
52         "name": "minimum",
53         "owner": "Ext.chart.axis.Gauge",
54         "doc": "<p>(required) the minimum value of the interval to be displayed in the axis.</p>\n",
55         "linenr": 29,
56         "html_filename": "Gauge2.html"
57       },
58       {
59         "type": "Number",
60         "deprecated": null,
61         "alias": null,
62         "protected": false,
63         "tagname": "cfg",
64         "href": "Gauge2.html#Ext-chart-axis-Gauge-cfg-steps",
65         "static": false,
66         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js",
67         "private": false,
68         "name": "steps",
69         "owner": "Ext.chart.axis.Gauge",
70         "doc": "<p>(required) the number of steps and tick marks to add to the interval.</p>\n",
71         "linenr": 37,
72         "html_filename": "Gauge2.html"
73       }
74     ],
75     "method": [
76       {
77         "deprecated": null,
78         "alias": null,
79         "href": "Abstract.html#Ext-chart-axis-Abstract-method-constructor",
80         "tagname": "method",
81         "protected": false,
82         "shortDoc": "Creates new Axis. ...",
83         "static": false,
84         "params": [
85           {
86             "type": "Object",
87             "optional": true,
88             "doc": "<p>(optional) Config options.</p>\n",
89             "name": "config"
90           }
91         ],
92         "private": false,
93         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Abstract.js",
94         "doc": "<p>Creates new Axis.</p>\n",
95         "owner": "Ext.chart.axis.Abstract",
96         "name": "Gauge",
97         "html_filename": "Abstract.html",
98         "return": {
99           "type": "Object",
100           "doc": "\n"
101         },
102         "linenr": 13
103       },
104       {
105         "deprecated": null,
106         "alias": null,
107         "protected": false,
108         "tagname": "method",
109         "href": "Base3.html#Ext-Base-method-addStatics",
110         "shortDoc": "Add / override static properties of this class. ...",
111         "static": true,
112         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
113         "private": false,
114         "params": [
115           {
116             "type": "Object",
117             "optional": false,
118             "doc": "\n",
119             "name": "members"
120           }
121         ],
122         "name": "addStatics",
123         "owner": "Ext.Base",
124         "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",
125         "linenr": 388,
126         "return": {
127           "type": "Ext.Base",
128           "doc": "<p>this</p>\n"
129         },
130         "html_filename": "Base3.html"
131       },
132       {
133         "deprecated": null,
134         "alias": null,
135         "protected": false,
136         "tagname": "method",
137         "href": "Base3.html#Ext-Base-method-callOverridden",
138         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
139         "static": false,
140         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
141         "private": false,
142         "params": [
143           {
144             "type": "Array/Arguments",
145             "optional": false,
146             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
147             "name": "args"
148           }
149         ],
150         "name": "callOverridden",
151         "owner": "Ext.Base",
152         "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",
153         "linenr": 269,
154         "return": {
155           "type": "Mixed",
156           "doc": "<p>Returns the result after calling the overridden method</p>\n"
157         },
158         "html_filename": "Base3.html"
159       },
160       {
161         "deprecated": null,
162         "alias": null,
163         "protected": true,
164         "tagname": "method",
165         "href": "Base3.html#Ext-Base-method-callParent",
166         "shortDoc": "Call the parent's overridden method. ...",
167         "static": false,
168         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
169         "private": false,
170         "params": [
171           {
172             "type": "Array/Arguments",
173             "optional": false,
174             "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",
175             "name": "args"
176           }
177         ],
178         "name": "callParent",
179         "owner": "Ext.Base",
180         "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",
181         "linenr": 124,
182         "return": {
183           "type": "Mixed",
184           "doc": "<p>Returns the result from the superclass' method</p>\n"
185         },
186         "html_filename": "Base3.html"
187       },
188       {
189         "deprecated": null,
190         "alias": null,
191         "protected": false,
192         "tagname": "method",
193         "href": "Base3.html#Ext-Base-method-create",
194         "shortDoc": "Create a new instance of this Class. ...",
195         "static": true,
196         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
197         "private": false,
198         "params": [
199
200         ],
201         "name": "create",
202         "owner": "Ext.Base",
203         "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",
204         "linenr": 329,
205         "return": {
206           "type": "Object",
207           "doc": "<p>the created instance.</p>\n"
208         },
209         "html_filename": "Base3.html"
210       },
211       {
212         "deprecated": null,
213         "alias": null,
214         "protected": false,
215         "tagname": "method",
216         "href": "Base3.html#Ext-Base-method-createAlias",
217         "shortDoc": "Create aliases for existing prototype methods. ...",
218         "static": true,
219         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
220         "private": false,
221         "params": [
222           {
223             "type": "String/Object",
224             "optional": false,
225             "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",
226             "name": "alias"
227           },
228           {
229             "type": "String/Object",
230             "optional": false,
231             "doc": "<p>The original method name</p>\n",
232             "name": "origin"
233           }
234         ],
235         "name": "createAlias",
236         "owner": "Ext.Base",
237         "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",
238         "linenr": 648,
239         "return": {
240           "type": "void",
241           "doc": "\n"
242         },
243         "html_filename": "Base3.html"
244       },
245       {
246         "deprecated": null,
247         "alias": null,
248         "protected": false,
249         "tagname": "method",
250         "href": "Base3.html#Ext-Base-method-getName",
251         "shortDoc": "Get the current class' name in string format. ...",
252         "static": false,
253         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
254         "private": false,
255         "params": [
256
257         ],
258         "name": "getName",
259         "owner": "Ext.Base",
260         "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",
261         "linenr": 631,
262         "return": {
263           "type": "String",
264           "doc": "<p>className</p>\n"
265         },
266         "html_filename": "Base3.html"
267       },
268       {
269         "deprecated": null,
270         "alias": null,
271         "protected": false,
272         "tagname": "method",
273         "href": "Base3.html#Ext-Base-method-implement",
274         "shortDoc": "Add methods / properties to the prototype of this class. ...",
275         "static": true,
276         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
277         "private": false,
278         "params": [
279           {
280             "type": "Object",
281             "optional": false,
282             "doc": "\n",
283             "name": "members"
284           }
285         ],
286         "name": "implement",
287         "owner": "Ext.Base",
288         "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",
289         "linenr": 415,
290         "return": {
291           "type": "void",
292           "doc": "\n"
293         },
294         "html_filename": "Base3.html"
295       },
296       {
297         "deprecated": null,
298         "alias": null,
299         "protected": true,
300         "tagname": "method",
301         "href": "Base3.html#Ext-Base-method-initConfig",
302         "shortDoc": "Initialize configuration for this class. ...",
303         "static": false,
304         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
305         "private": false,
306         "params": [
307           {
308             "type": "Object",
309             "optional": false,
310             "doc": "\n",
311             "name": "config"
312           }
313         ],
314         "name": "initConfig",
315         "owner": "Ext.Base",
316         "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",
317         "linenr": 63,
318         "return": {
319           "type": "Object",
320           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
321         },
322         "html_filename": "Base3.html"
323       },
324       {
325         "deprecated": null,
326         "alias": null,
327         "protected": false,
328         "tagname": "method",
329         "href": "Base3.html#Ext-Base-method-override",
330         "shortDoc": "Override prototype members of this class. ...",
331         "static": true,
332         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
333         "private": false,
334         "params": [
335           {
336             "type": "Object",
337             "optional": false,
338             "doc": "\n",
339             "name": "members"
340           }
341         ],
342         "name": "override",
343         "owner": "Ext.Base",
344         "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",
345         "linenr": 518,
346         "return": {
347           "type": "Ext.Base",
348           "doc": "<p>this</p>\n"
349         },
350         "html_filename": "Base3.html"
351       },
352       {
353         "deprecated": null,
354         "alias": null,
355         "protected": false,
356         "tagname": "method",
357         "href": "Gauge2.html#Ext-chart-axis-Gauge-method-setTitle",
358         "shortDoc": "Updates the title of this axis. ...",
359         "static": false,
360         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js",
361         "private": false,
362         "params": [
363           {
364             "type": "String",
365             "optional": false,
366             "doc": "\n",
367             "name": "title"
368           }
369         ],
370         "name": "setTitle",
371         "owner": "Ext.chart.axis.Gauge",
372         "doc": "<p>Updates the title of this axis.</p>\n",
373         "linenr": 130,
374         "return": {
375           "type": "void",
376           "doc": "\n"
377         },
378         "html_filename": "Gauge2.html"
379       },
380       {
381         "deprecated": null,
382         "alias": null,
383         "protected": true,
384         "tagname": "method",
385         "href": "Base3.html#Ext-Base-method-statics",
386         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
387         "static": false,
388         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
389         "private": false,
390         "params": [
391
392         ],
393         "name": "statics",
394         "owner": "Ext.Base",
395         "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",
396         "linenr": 199,
397         "return": {
398           "type": "Class",
399           "doc": "\n"
400         },
401         "html_filename": "Base3.html"
402       }
403     ],
404     "property": [
405       {
406         "type": "Class",
407         "deprecated": null,
408         "alias": null,
409         "protected": true,
410         "tagname": "property",
411         "href": "Base3.html#Ext-Base-property-self",
412         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
413         "static": false,
414         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
415         "private": false,
416         "name": "self",
417         "owner": "Ext.Base",
418         "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",
419         "linenr": 18,
420         "html_filename": "Base3.html"
421       }
422     ],
423     "cssVar": [
424
425     ],
426     "cssMixin": [
427
428     ],
429     "event": [
430
431     ]
432   },
433   "singleton": false,
434   "alias": null,
435   "superclasses": [
436     "Ext.Base",
437     "Ext.chart.axis.Abstract"
438   ],
439   "protected": false,
440   "tagname": "class",
441   "mixins": [
442
443   ],
444   "href": "Gauge2.html#Ext-chart-axis-Gauge",
445   "subclasses": [
446
447   ],
448   "static": false,
449   "author": null,
450   "component": false,
451   "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js",
452   "private": false,
453   "alternateClassNames": [
454
455   ],
456   "name": "Ext.chart.axis.Gauge",
457   "doc": "<p>Gauge Axis is the axis to be used with a Gauge series. The Gauge axis\ndisplays numeric data from an interval defined by the <code>minimum</code>, <code>maximum</code> and\n<code>step</code> configuration properties. The placement of the numeric data can be changed\nby altering the <code>margin</code> option that is set to <code>10</code> by default.</p>\n\n<p>A possible configuration for this axis would look like:</p>\n\n<pre><code>axes: [{\n    type: 'gauge',\n    position: 'gauge',\n    minimum: 0,\n    maximum: 100,\n    steps: 10,\n    margin: 7\n}],\n</code></pre>\n",
458   "mixedInto": [
459
460   ],
461   "linenr": 1,
462   "xtypes": [
463
464   ],
465   "html_filename": "Gauge2.html",
466   "extends": "Ext.chart.axis.Abstract"
467 });