X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.chart.axis.Gauge.js diff --git a/docs/output/Ext.chart.axis.Gauge.js b/docs/output/Ext.chart.axis.Gauge.js index 9c97dac1..25cbc32d 100644 --- a/docs/output/Ext.chart.axis.Gauge.js +++ b/docs/output/Ext.chart.axis.Gauge.js @@ -1,123 +1,467 @@ Ext.data.JsonP.Ext_chart_axis_Gauge({ - "tagname": "class", - "name": "Ext.chart.axis.Gauge", - "doc": "

Gauge Axis is the axis to be used with a Gauge series. The Gauge axis\ndisplays numeric data from an interval defined by the minimum, maximum and\nstep configuration properties. The placement of the numeric data can be changed\nby altering the margin option that is set to 10 by default.

\n\n

A possible configuration for this axis would look like:

\n\n
axes: [{\n    type: 'gauge',\n    position: 'gauge',\n    minimum: 0,\n    maximum: 100,\n    steps: 10,\n    margin: 7\n}],\n
\n", - "extends": "Ext.chart.axis.Abstract", - "mixins": [ - - ], - "alternateClassNames": [ + "allMixins": [ ], - "xtype": null, - "author": null, + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "margin", - "member": "Ext.chart.axis.Gauge", - "type": "Number", - "doc": "

(optional) the offset positioning of the tick marks and labels in pixels. Default's 10.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Gauge.js", - "linenr": 41, - "html_filename": "Gauge.html", - "href": "Gauge.html#Ext-chart-axis-Gauge-cfg-margin" - }, - { - "tagname": "cfg", - "name": "maximum", - "member": "Ext.chart.axis.Gauge", - "type": "Number", - "doc": "

(required) the maximum value of the interval to be displayed in the axis.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Gauge.js", - "linenr": 33, - "html_filename": "Gauge.html", - "href": "Gauge.html#Ext-chart-axis-Gauge-cfg-maximum" - }, - { - "tagname": "cfg", - "name": "minimum", - "member": "Ext.chart.axis.Gauge", - "type": "Number", - "doc": "

(required) the minimum value of the interval to be displayed in the axis.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Gauge.js", - "linenr": 29, - "html_filename": "Gauge.html", - "href": "Gauge.html#Ext-chart-axis-Gauge-cfg-minimum" - }, - { - "tagname": "cfg", - "name": "steps", - "member": "Ext.chart.axis.Gauge", - "type": "Number", - "doc": "

(required) the number of steps and tick marks to add to the interval.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Gauge.js", - "linenr": 37, - "html_filename": "Gauge.html", - "href": "Gauge.html#Ext-chart-axis-Gauge-cfg-steps" - } - ], - "method": [ - { - "tagname": "method", - "name": "setTitle", - "member": "Ext.chart.axis.Gauge", - "doc": "

Updates the title of this axis.

\n", - "params": [ - { + "members": { + "cfg": [ + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Gauge2.html#Ext-chart-axis-Gauge-cfg-margin", + "shortDoc": "(optional) the offset positioning of the tick marks and labels in pixels. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js", + "private": false, + "name": "margin", + "owner": "Ext.chart.axis.Gauge", + "doc": "

(optional) the offset positioning of the tick marks and labels in pixels. Default's 10.

\n", + "linenr": 41, + "html_filename": "Gauge2.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Gauge2.html#Ext-chart-axis-Gauge-cfg-maximum", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js", + "private": false, + "name": "maximum", + "owner": "Ext.chart.axis.Gauge", + "doc": "

(required) the maximum value of the interval to be displayed in the axis.

\n", + "linenr": 33, + "html_filename": "Gauge2.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Gauge2.html#Ext-chart-axis-Gauge-cfg-minimum", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js", + "private": false, + "name": "minimum", + "owner": "Ext.chart.axis.Gauge", + "doc": "

(required) the minimum value of the interval to be displayed in the axis.

\n", + "linenr": 29, + "html_filename": "Gauge2.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Gauge2.html#Ext-chart-axis-Gauge-cfg-steps", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js", + "private": false, + "name": "steps", + "owner": "Ext.chart.axis.Gauge", + "doc": "

(required) the number of steps and tick marks to add to the interval.

\n", + "linenr": 37, + "html_filename": "Gauge2.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Abstract.html#Ext-chart-axis-Abstract-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates new Axis. ...", + "static": false, + "params": [ + { + "type": "Object", + "optional": true, + "doc": "

(optional) Config options.

\n", + "name": "config" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Abstract.js", + "doc": "

Creates new Axis.

\n", + "owner": "Ext.chart.axis.Abstract", + "name": "Gauge", + "html_filename": "Abstract.html", + "return": { + "type": "Object", + "doc": "\n" + }, + "linenr": 13 + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-addStatics", + "shortDoc": "Add / override static properties of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "addStatics", + "owner": "Ext.Base", + "doc": "

Add / override static properties of this class.

\n\n
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
\n", + "linenr": 388, + "return": { + "type": "Ext.Base", + "doc": "

this

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callOverridden", + "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "

The arguments, either an array or the arguments object

\n", + "name": "args" + } + ], + "name": "callOverridden", + "owner": "Ext.Base", + "doc": "

Call the original method that was previously overridden with Ext.Base.override

\n\n
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
\n", + "linenr": 269, + "return": { + "type": "Mixed", + "doc": "

Returns the result after calling the overridden method

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callParent", + "shortDoc": "Call the parent's overridden method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "

The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

\n", + "name": "args" + } + ], + "name": "callParent", + "owner": "Ext.Base", + "doc": "

Call the parent's overridden method. For example:

\n\n
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
\n", + "linenr": 124, + "return": { + "type": "Mixed", + "doc": "

Returns the result from the superclass' method

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-create", + "shortDoc": "Create a new instance of this Class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "create", + "owner": "Ext.Base", + "doc": "

Create a new instance of this Class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
\n\n

All parameters are passed to the constructor of the class.

\n", + "linenr": 329, + "return": { + "type": "Object", + "doc": "

the created instance.

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-createAlias", + "shortDoc": "Create aliases for existing prototype methods. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "String/Object", + "optional": false, + "doc": "

The new method name, or an object to set multiple aliases. See\nflexSetter

\n", + "name": "alias" + }, + { + "type": "String/Object", + "optional": false, + "doc": "

The original method name

\n", + "name": "origin" + } + ], + "name": "createAlias", + "owner": "Ext.Base", + "doc": "

Create aliases for existing prototype methods. Example:

\n\n
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() -> test.method1()\n
\n", + "linenr": 648, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-getName", + "shortDoc": "Get the current class' name in string format. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "getName", + "owner": "Ext.Base", + "doc": "

Get the current class' name in string format.

\n\n
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
\n", + "linenr": 631, + "return": { "type": "String", - "name": "title", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "

className

\n" + }, + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Gauge.js", - "linenr": 130, - "html_filename": "Gauge.html", - "href": "Gauge.html#Ext-chart-axis-Gauge-method-setTitle", - "shortDoc": "

Updates the title of this axis.

\n" - } - ], - "property": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-implement", + "shortDoc": "Add methods / properties to the prototype of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "implement", + "owner": "Ext.Base", + "doc": "

Add methods / properties to the prototype of this class.

\n\n
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
\n", + "linenr": 415, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-initConfig", + "shortDoc": "Initialize configuration for this class. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "config" + } + ], + "name": "initConfig", + "owner": "Ext.Base", + "doc": "

Initialize configuration for this class. a typical example:

\n\n
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
\n", + "linenr": 63, + "return": { + "type": "Object", + "doc": "

mixins The mixin prototypes as key - value pairs

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-override", + "shortDoc": "Override prototype members of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "override", + "owner": "Ext.Base", + "doc": "

Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden

\n\n
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
\n", + "linenr": 518, + "return": { + "type": "Ext.Base", + "doc": "

this

\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Gauge2.html#Ext-chart-axis-Gauge-method-setTitle", + "shortDoc": "Updates the title of this axis. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "\n", + "name": "title" + } + ], + "name": "setTitle", + "owner": "Ext.chart.axis.Gauge", + "doc": "

Updates the title of this axis.

\n", + "linenr": 130, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Gauge2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-statics", + "shortDoc": "Get the reference to the class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ - ], - "event": [ + ], + "name": "statics", + "owner": "Ext.Base", + "doc": "

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n
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
\n", + "linenr": 199, + "return": { + "type": "Class", + "doc": "\n" + }, + "html_filename": "Base3.html" + } + ], + "property": [ + { + "type": "Class", + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "property", + "href": "Base3.html#Ext-Base-property-self", + "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "name": "self", + "owner": "Ext.Base", + "doc": "

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison

\n\n
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
\n", + "linenr": 18, + "html_filename": "Base3.html" + } + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/axis/Gauge.js", - "linenr": 1, - "html_filename": "Gauge.html", - "href": "Gauge.html#Ext-chart-axis-Gauge", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": false, + "alias": null, "superclasses": [ + "Ext.Base", "Ext.chart.axis.Abstract" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Gauge2.html#Ext-chart-axis-Gauge", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/axis/Gauge.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.chart.axis.Gauge", + "doc": "

Gauge Axis is the axis to be used with a Gauge series. The Gauge axis\ndisplays numeric data from an interval defined by the minimum, maximum and\nstep configuration properties. The placement of the numeric data can be changed\nby altering the margin option that is set to 10 by default.

\n\n

A possible configuration for this axis would look like:

\n\n
axes: [{\n    type: 'gauge',\n    position: 'gauge',\n    minimum: 0,\n    maximum: 100,\n    steps: 10,\n    margin: 7\n}],\n
\n", "mixedInto": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "Gauge2.html", + "extends": "Ext.chart.axis.Abstract" }); \ No newline at end of file