X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..HEAD:/docs/output/Ext.chart.Label.js diff --git a/docs/output/Ext.chart.Label.js b/docs/output/Ext.chart.Label.js index d863bf32..be2955dd 100644 --- a/docs/output/Ext.chart.Label.js +++ b/docs/output/Ext.chart.Label.js @@ -1,137 +1 @@ -Ext.data.JsonP.Ext_chart_Label({ - "tagname": "class", - "name": "Ext.chart.Label", - "doc": "
Labels is a mixin whose methods are appended onto the Series class. Labels is an interface with methods implemented\nin each of the Series (Pie, Bar, etc) for label creation and label placement.
\n\nThe methods implemented by the Series are:
\n\nonCreateLabel(storeItem, item, i, display)
Called each time a new label is created.\nThe arguments of the method are:
storeItem
The element of the store that is related to the label sprite.item
The item related to the label sprite. An item is an object containing the position of the shape\nused to describe the visualization and also pointing to the actual shape (circle, rectangle, path, etc).i
The index of the element created (i.e the first created label, second created label, etc)display
The display type. May be false if the label is hiddenonPlaceLabel(label, storeItem, item, i, display, animate)
Called for updating the position of the label.\nThe arguments of the method are:
label
The sprite label.storeItem
The element of the store that is related to the label spriteitem
The item related to the label sprite. An item is an object containing the position of the shape\nused to describe the visualization and also pointing to the actual shape (circle, rectangle, path, etc).i
The index of the element to be updated (i.e. whether it is the first, second, third from the labelGroup)display
The display type. May be false if the label is hidden.animate
A boolean value to set or unset animations for the labels.The color of the label text.\nDefault value: '#000' (black).
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 42, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-color" - }, - { - "tagname": "cfg", - "name": "display", - "member": "Ext.chart.Label", - "type": "String", - "doc": "Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEnd\", \"outside\", \"over\", \"under\", or \"none\" to prevent label rendering.\nDefault value: 'none'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 35, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-display", - "shortDoc": "Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEn..." - }, - { - "tagname": "cfg", - "name": "field", - "member": "Ext.chart.Label", - "type": "String", - "doc": "The name of the field to be displayed in the label.\nDefault value: 'name'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 48, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-field" - }, - { - "tagname": "cfg", - "name": "font", - "member": "Ext.chart.Label", - "type": "String", - "doc": "The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 61, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-font" - }, - { - "tagname": "cfg", - "name": "minMargin", - "member": "Ext.chart.Label", - "type": "Number", - "doc": "Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using PieSeries width variable pie slice lengths.\nDefault value: 50.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 54, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-minMargin", - "shortDoc": "Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using P..." - }, - { - "tagname": "cfg", - "name": "orientation", - "member": "Ext.chart.Label", - "type": "String", - "doc": "Either \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 67, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-orientation" - }, - { - "tagname": "cfg", - "name": "renderer", - "member": "Ext.chart.Label", - "type": "Function", - "doc": "Optional function for formatting the label into a displayable value.\nDefault value: function(v) { return v; }
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 73, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-renderer" - } - ], - "method": [ - - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 1, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - "Ext.chart.series.Series" - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_chart_Label({"tagname":"class","html":"Hierarchy
Ext.BaseExt.chart.LabelRequires
Files
Labels is a mixin to the Series class. Labels methods are implemented\nin each of the Series (Pie, Bar, etc) for label creation and placement.
\n\nThe methods implemented by the Series are:
\n\nonCreateLabel(storeItem, item, i, display)
Called each time a new label is created.\nThe arguments of the method are:
storeItem
The element of the store that is related to the label sprite.item
The item related to the label sprite. An item is an object containing the position of the shape\nused to describe the visualization and also pointing to the actual shape (circle, rectangle, path, etc).i
The index of the element created (i.e the first created label, second created label, etc)display
The display type. May be false if the label is hiddenonPlaceLabel(label, storeItem, item, i, display, animate)
Called for updating the position of the label.\nThe arguments of the method are:
label
The sprite label.storeItem
The element of the store that is related to the label spriteitem
The item related to the label sprite. An item is an object containing the position of the shape\nused to describe the visualization and also pointing to the actual shape (circle, rectangle, path, etc).i
The index of the element to be updated (i.e. whether it is the first, second, third from the labelGroup)display
The display type. May be false if the label is hidden.animate
A boolean value to set or unset animations for the labels.Object with the following properties:
\n\ndisplay : String
\n\nSpecifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEnd\", \"outside\", \"over\", \"under\", or \"none\" to prevent label rendering.\nDefault value: 'none'.
color : String
\n\nThe color of the label text.\nDefault value: '#000' (black).
contrast : Boolean
\n\nTrue to render the label in contrasting color with the backround.\nDefault value: false.
field : String
\n\nThe name of the field to be displayed in the label.\nDefault value: 'name'.
minMargin : Number
\n\nSpecifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using PieSeries width variable pie slice lengths.\nDefault value: 50.
font : String
\n\nThe font used for the labels.\nDefault value: \"11px Helvetica, sans-serif\".
orientation : String
\n\nEither \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".
renderer : Function
\n\nOptional function for formatting the label into a displayable value.\nDefault value: function(v) { return v; }
Get 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