X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.chart.Legend.js diff --git a/docs/output/Ext.chart.Legend.js b/docs/output/Ext.chart.Legend.js index fbb14380..8b386a17 100644 --- a/docs/output/Ext.chart.Legend.js +++ b/docs/output/Ext.chart.Legend.js @@ -1,215 +1 @@ -Ext.data.JsonP.Ext_chart_Legend({ - "tagname": "class", - "name": "Ext.chart.Legend", - "doc": "
Defines a legend for a chart's series.\nThe 'chart' member must be set prior to rendering.\nThe legend class displays a list of legend items each of them related with a\nseries being rendered. In order to render the legend item of the proper series\nthe series configuration object must have showInSeries
set to true.
The legend configuration object accepts a position
as parameter.\nThe position
parameter can be left
, right
\ntop
or bottom
. For example:
legend: {\n position: 'right'\n},\n
\n\nFull example:
\n\n 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 \n Ext.create('Ext.chart.Chart', {\n renderTo: Ext.getBody(),\n width: 500,\n height: 300,\n animate: true,\n store: store,\n shadow: true,\n theme: 'Category1',\n legend: {\n position: 'top'\n },\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
\n\n",
- "extends": null,
- "mixins": [
-
- ],
- "alternateClassNames": [
-
- ],
- "xtype": null,
- "author": null,
- "docauthor": null,
- "singleton": false,
- "private": false,
- "cfg": [
- {
- "tagname": "cfg",
- "name": "boxFill",
- "member": "Ext.chart.Legend",
- "type": "String",
- "doc": "Fill style for the legend box
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 139, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-boxFill" - }, - { - "tagname": "cfg", - "name": "boxStroke", - "member": "Ext.chart.Legend", - "type": "String", - "doc": "Style of the stroke for the legend box
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 127, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-boxStroke" - }, - { - "tagname": "cfg", - "name": "boxStrokeWidth", - "member": "Ext.chart.Legend", - "type": "String", - "doc": "Width of the stroke for the legend box
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 133, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-boxStrokeWidth" - }, - { - "tagname": "cfg", - "name": "boxZIndex", - "member": "Ext.chart.Legend", - "type": "Number", - "doc": "Sets the z-index for the legend. Defaults to 100.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 162, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-boxZIndex" - }, - { - "tagname": "cfg", - "name": "itemSpacing", - "member": "Ext.chart.Legend", - "type": "Number", - "doc": "Amount of space between legend items
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 145, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-itemSpacing" - }, - { - "tagname": "cfg", - "name": "labelFont", - "member": "Ext.chart.Legend", - "type": "String", - "doc": "Font to be used for the legend labels, eg '12px Helvetica'
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 121, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-labelFont" - }, - { - "tagname": "cfg", - "name": "padding", - "member": "Ext.chart.Legend", - "type": "Number", - "doc": "Amount of padding between the legend box's border and its items
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 151, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-padding" - }, - { - "tagname": "cfg", - "name": "position", - "member": "Ext.chart.Legend", - "type": "String", - "doc": "The position of the legend in relation to the chart. One of: \"top\",\n\"bottom\", \"left\", \"right\", or \"float\". If set to \"float\", then the legend\nbox will be positioned at the point denoted by the x and y parameters.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 99, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-position", - "shortDoc": "The position of the legend in relation to the chart. One of: \"top\",\n\"bottom\", \"left\", \"right\", or \"float\". If set to ..." - }, - { - "tagname": "cfg", - "name": "visible", - "member": "Ext.chart.Legend", - "type": "Boolean", - "doc": "Whether or not the legend should be displayed.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 93, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-visible" - }, - { - "tagname": "cfg", - "name": "x", - "member": "Ext.chart.Legend", - "type": "Number", - "doc": "X-position of the legend box. Used directly if position is set to \"float\", otherwise\nit will be calculated dynamically.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 107, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-x" - }, - { - "tagname": "cfg", - "name": "y", - "member": "Ext.chart.Legend", - "type": "Number", - "doc": "Y-position of the legend box. Used directly if position is set to \"float\", otherwise\nit will be calculated dynamically.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 114, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-cfg-y" - } - ], - "method": [ - { - "tagname": "method", - "name": "Legend", - "member": "Ext.chart.Legend", - "doc": "\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 1, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-method-constructor", - "shortDoc": "\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "isVertical", - "member": "Ext.chart.Legend", - "type": "Boolean", - "doc": "Whether the legend box is oriented vertically, i.e. if it is on the left or right side or floating.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 174, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend-property-isVertical" - } - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Legend.js", - "linenr": 1, - "html_filename": "Legend.html", - "href": "Legend.html#Ext-chart-Legend", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_chart_Legend({"tagname":"class","html":"Hierarchy
Ext.BaseExt.chart.LegendRequires
Files
Defines a legend for a chart's series.\nThe 'chart' member must be set prior to rendering.\nThe legend class displays a list of legend items each of them related with a\nseries being rendered. In order to render the legend item of the proper series\nthe series configuration object must have showInSeries
set to true.
The legend configuration object accepts a position
as parameter.\nThe position
parameter can be left
, right
\ntop
or bottom
. For example:
legend: {\n position: 'right'\n},\n
\n\nvar 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 animate: true,\n store: store,\n shadow: true,\n theme: 'Category1',\n legend: {\n position: 'top'\n },\n axes: [\n {\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 {\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 ],\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
\nStyle of the stroke for the legend box
\nDefaults to: "#000"
Sets the z-index for the legend. Defaults to 100.
\nDefaults to: 100
Font to be used for the legend labels, eg '12px Helvetica'
\nDefaults to: "12px Helvetica, sans-serif"
Amount of padding between the legend box's border and its items
\nDefaults to: 5
The position of the legend in relation to the chart. One of: \"top\",\n\"bottom\", \"left\", \"right\", or \"float\". If set to \"float\", then the legend\nbox will be positioned at the point denoted by the x and y parameters.
\nDefaults to: "bottom"
Whether or not the legend should be displayed.
\nDefaults to: true
Whether the legend box is oriented vertically, i.e. if it is on the left or right side or floating.
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
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
\nCall the original method that was previously overridden with override
\n\nExt.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
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.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
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nInitialize configuration for this class. a typical example:
\n\nExt.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
\nmixins The mixin prototypes as key - value pairs
\nGet the reference to the class from which this object was instantiated. Note that unlike 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
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
\nAdd / override static properties of this class.
\n\nExt.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
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.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
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.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
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.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
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.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
\nthis
\n