Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.chart.Label.js
1 Ext.data.JsonP.Ext_chart_Label({
2   "tagname": "class",
3   "name": "Ext.chart.Label",
4   "doc": "<p>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.</p>\n\n<p>The methods implemented by the Series are:</p>\n\n<ul>\n<li><p><strong><code>onCreateLabel(storeItem, item, i, display)</code></strong> Called each time a new label is created.\nThe arguments of the method are:</p>\n\n<ul>\n<li><em><code>storeItem</code></em> The element of the store that is related to the label sprite.</li>\n<li><em><code>item</code></em> 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).</li>\n<li><em><code>i</code></em> The index of the element created (i.e the first created label, second created label, etc)</li>\n<li><em><code>display</code></em> The display type. May be <b>false</b> if the label is hidden</li>\n</ul>\n</li>\n<li><p><strong><code>onPlaceLabel(label, storeItem, item, i, display, animate)</code></strong> Called for updating the position of the label.\nThe arguments of the method are:</p>\n\n<ul>\n<li><em><code>label</code></em> The sprite label.</li></li>\n<li><em><code>storeItem</code></em> The element of the store that is related to the label sprite</li></li>\n<li><em><code>item</code></em> 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).</li>\n<li><em><code>i</code></em> The index of the element to be updated (i.e. whether it is the first, second, third from the labelGroup)</li>\n<li><em><code>display</code></em> The display type. May be <b>false</b> if the label is hidden.</li>\n<li><em><code>animate</code></em> A boolean value to set or unset animations for the labels.</li>\n</ul>\n</li>\n</ul>\n\n",
5   "extends": null,
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "color",
21       "member": "Ext.chart.Label",
22       "type": "String",
23       "doc": "<p>The color of the label text.\nDefault value: '#000' (black).</p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
26       "linenr": 42,
27       "html_filename": "Label2.html",
28       "href": "Label2.html#Ext-chart-Label-cfg-color"
29     },
30     {
31       "tagname": "cfg",
32       "name": "display",
33       "member": "Ext.chart.Label",
34       "type": "String",
35       "doc": "<p>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'.</p>\n",
36       "private": false,
37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
38       "linenr": 35,
39       "html_filename": "Label2.html",
40       "href": "Label2.html#Ext-chart-Label-cfg-display",
41       "shortDoc": "Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEn..."
42     },
43     {
44       "tagname": "cfg",
45       "name": "field",
46       "member": "Ext.chart.Label",
47       "type": "String",
48       "doc": "<p>The name of the field to be displayed in the label.\nDefault value: 'name'.</p>\n",
49       "private": false,
50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
51       "linenr": 48,
52       "html_filename": "Label2.html",
53       "href": "Label2.html#Ext-chart-Label-cfg-field"
54     },
55     {
56       "tagname": "cfg",
57       "name": "font",
58       "member": "Ext.chart.Label",
59       "type": "String",
60       "doc": "<p>The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".</p>\n",
61       "private": false,
62       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
63       "linenr": 61,
64       "html_filename": "Label2.html",
65       "href": "Label2.html#Ext-chart-Label-cfg-font"
66     },
67     {
68       "tagname": "cfg",
69       "name": "minMargin",
70       "member": "Ext.chart.Label",
71       "type": "Number",
72       "doc": "<p>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.</p>\n",
73       "private": false,
74       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
75       "linenr": 54,
76       "html_filename": "Label2.html",
77       "href": "Label2.html#Ext-chart-Label-cfg-minMargin",
78       "shortDoc": "Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using P..."
79     },
80     {
81       "tagname": "cfg",
82       "name": "orientation",
83       "member": "Ext.chart.Label",
84       "type": "String",
85       "doc": "<p>Either \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".</p>\n",
86       "private": false,
87       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
88       "linenr": 67,
89       "html_filename": "Label2.html",
90       "href": "Label2.html#Ext-chart-Label-cfg-orientation"
91     },
92     {
93       "tagname": "cfg",
94       "name": "renderer",
95       "member": "Ext.chart.Label",
96       "type": "Function",
97       "doc": "<p>Optional function for formatting the label into a displayable value.\nDefault value: function(v) { return v; }</p>\n",
98       "private": false,
99       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
100       "linenr": 73,
101       "html_filename": "Label2.html",
102       "href": "Label2.html#Ext-chart-Label-cfg-renderer"
103     }
104   ],
105   "method": [
106
107   ],
108   "property": [
109
110   ],
111   "event": [
112
113   ],
114   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js",
115   "linenr": 1,
116   "html_filename": "Label2.html",
117   "href": "Label2.html#Ext-chart-Label",
118   "cssVar": [
119
120   ],
121   "cssMixin": [
122
123   ],
124   "component": false,
125   "superclasses": [
126
127   ],
128   "subclasses": [
129
130   ],
131   "mixedInto": [
132     "Ext.chart.series.Series"
133   ],
134   "allMixins": [
135
136   ]
137 });