Ext.data.JsonP.Ext_chart_series_Line({
- "tagname": "class",
- "name": "Ext.chart.series.Line",
- "doc": "<p>Creates a Line Chart. A Line Chart is a useful visualization technique to display quantitative information for different\ncategories or other real values (as opposed to the bar chart), that can show some progression (or regression) in the dataset.\nAs with all other series, the Line Series must be appended in the <em>series</em> Chart array configuration. See the Chart\ndocumentation for more information. A typical configuration object for the line series could be:</p>\n\n<p><p><img src=\"doc-resources/Ext.chart.series.Line/Ext.chart.series.Line.png\" alt=\"Ext.chart.series.Line chart series\"></p></p>\n\n<pre><code>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\nExt.create('Ext.chart.Chart', {\n renderTo: Ext.getBody(),\n width: 500,\n height: 300,\n animate: true,\n store: store,\n axes: [{\n type: 'Numeric',\n position: 'bottom',\n fields: ['data1'],\n label: {\n renderer: Ext.util.Format.numberRenderer('0,0')\n },\n title: 'Sample Values',\n grid: true,\n minimum: 0\n }, {\n type: 'Category',\n position: 'left',\n fields: ['name'],\n title: 'Sample Metrics'\n }],\n series: [{\n type: 'line',\n highlight: {\n size: 7,\n radius: 7\n },\n axis: 'left',\n xField: 'name',\n yField: 'data1',\n markerCfg: {\n type: 'cross',\n size: 4,\n radius: 4,\n 'stroke-width': 0\n }\n }, {\n type: 'line',\n highlight: {\n size: 7,\n radius: 7\n },\n axis: 'left',\n fill: true,\n xField: 'name',\n yField: 'data3',\n markerCfg: {\n type: 'circle',\n size: 4,\n radius: 4,\n 'stroke-width': 0\n }\n }]\n});\n</code></pre>\n\n<p>In this configuration we're adding two series (or lines), one bound to the <code>data1</code>\nproperty of the store and the other to <code>data3</code>. The type for both configurations is\n<code>line</code>. The <code>xField</code> for both series is the same, the name propert of the store.\nBoth line series share the same axis, the left axis. You can set particular marker\nconfiguration by adding properties onto the markerConfig object. Both series have\nan object as highlight so that markers animate smoothly to the properties in highlight\nwhen hovered. The second series has <code>fill=true</code> which means that the line will also\nhave an area below it of the same color.</p>\n\n<p><strong>Note:</strong> In the series definition remember to explicitly set the axis to bind the\nvalues of the line series to. This can be done by using the <code>axis</code> configuration property.</p>\n",
- "extends": "Ext.chart.series.Cartesian",
- "mixins": [
-
- ],
- "alternateClassNames": [
- "Ext.chart.LineSeries",
- "Ext.chart.LineChart"
+ "allMixins": [
+ "Ext.util.Observable",
+ "Ext.chart.Label",
+ "Ext.chart.Highlight",
+ "Ext.chart.Tip",
+ "Ext.chart.Callout"
],
- "xtype": null,
- "author": null,
+ "deprecated": null,
"docauthor": null,
- "singleton": false,
- "private": false,
- "cfg": [
- {
- "tagname": "cfg",
- "name": "axis",
- "member": "Ext.chart.series.Line",
- "type": "String",
- "doc": "<p>The position of the axis to bind the values to. Possible values are 'left', 'bottom', 'top' and 'right'.\nYou must explicitly set this value to bind the values of the line series to the ones in the axis, otherwise a\nrelative scale will be used.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 107,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line-cfg-axis",
- "shortDoc": "The position of the axis to bind the values to. Possible values are 'left', 'bottom', 'top' and 'right'.\nYou must exp..."
- },
- {
- "tagname": "cfg",
- "name": "color",
- "member": "Ext.chart.Label",
- "type": "String",
- "doc": "<p>The color of the label text.\nDefault value: '#000' (black).</p>\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": "<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",
- "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": "<p>The name of the field to be displayed in the label.\nDefault value: 'name'.</p>\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": "fill",
- "member": "Ext.chart.series.Line",
- "type": "Boolean",
- "doc": "<p>If true, the area below the line will be filled in using the <a href=\"#/api/Ext.chart.series.Line--style.eefill\" rel=\"Ext.chart.series.Line--style.eefill\" class=\"docClass\">style.eefill</a> and\n<a href=\"#/api/Ext.chart.series.Line--style.opacity\" rel=\"Ext.chart.series.Line--style.opacity\" class=\"docClass\">style.opacity</a> config properties. Defaults to false.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 159,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line-cfg-fill",
- "shortDoc": "If true, the area below the line will be filled in using the style.eefill and\nstyle.opacity config properties. Defaul..."
- },
- {
- "tagname": "cfg",
- "name": "font",
- "member": "Ext.chart.Label",
- "type": "String",
- "doc": "<p>The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".</p>\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": "highlight",
- "member": "Ext.chart.series.Series",
- "type": "Boolean|Object",
- "doc": "<p>If set to <code>true</code> it will highlight the markers or the series when hovering\nwith the mouse. This parameter can also be an object with the same style\nproperties you would apply to a <a href=\"#/api/Ext.draw.Sprite\" rel=\"Ext.draw.Sprite\" class=\"docClass\">Ext.draw.Sprite</a> to apply custom\nstyles to markers and series.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 46,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-cfg-highlight",
- "shortDoc": "If set to true it will highlight the markers or the series when hovering\nwith the mouse. This parameter can also be a..."
- },
- {
- "tagname": "cfg",
- "name": "listeners",
- "member": "Ext.chart.series.Series",
- "type": "Object",
- "doc": "<p>An (optional) object with event callbacks. All event callbacks get the target <em>item</em> as first parameter. The callback functions are:</p>\n\n<p> <ul></p>\n\n<pre><code> <li>itemmouseover</li>\n <li>itemmouseout</li>\n <li>itemmousedown</li>\n <li>itemmouseup</li>\n</code></pre>\n\n<p> </ul></p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 105,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-cfg-listeners",
- "shortDoc": "An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback f..."
- },
- {
- "tagname": "cfg",
- "name": "markerConfig",
- "member": "Ext.chart.series.Line",
- "type": "Object",
- "doc": "<p>The display style for the markers. Only used if <a href=\"#/api/Ext.chart.series.Line-cfg-showMarkers\" rel=\"Ext.chart.series.Line-cfg-showMarkers\" class=\"docClass\">showMarkers</a> is true.\nThe markerConfig is a configuration object containing the same set of properties defined in\nthe Sprite class. For example, if we were to set red circles as markers to the line series we could\npass the object:</p>\n\n<pre><code> markerConfig: {\n type: 'circle',\n radius: 4,\n 'fill': '#f00'\n }\n </code></pre>\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 127,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line-cfg-markerConfig",
- "shortDoc": "The display style for the markers. Only used if showMarkers is true.\nThe markerConfig is a configuration object conta..."
- },
- {
- "tagname": "cfg",
- "name": "minMargin",
- "member": "Ext.chart.Label",
- "type": "Number",
- "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",
- "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": "<p>Either \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".</p>\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.series.Series",
- "type": "Function",
- "doc": "<p>A function that can be overridden to set custom styling properties to each rendered element.\nPasses in (sprite, record, attributes, index, store) to the function.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 87,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-cfg-renderer",
- "shortDoc": "A function that can be overridden to set custom styling properties to each rendered element.\nPasses in (sprite, recor..."
- },
- {
- "tagname": "cfg",
- "name": "selectionTolerance",
- "member": "Ext.chart.series.Line",
- "type": "Number",
- "doc": "<p>The offset distance from the cursor position to the line series to trigger events (then used for highlighting series, etc).</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 114,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line-cfg-selectionTolerance",
- "shortDoc": "The offset distance from the cursor position to the line series to trigger events (then used for highlighting series,..."
- },
- {
- "tagname": "cfg",
- "name": "shadowAttributes",
- "member": "Ext.chart.series.Series",
- "type": "Array",
- "doc": "<p>An array with shadow attributes</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 96,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-cfg-shadowAttributes"
- },
- {
- "tagname": "cfg",
- "name": "showInLegend",
- "member": "Ext.chart.series.Series",
- "type": "Boolean",
- "doc": "<p>Whether to show this series in the legend.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 81,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-cfg-showInLegend"
- },
- {
- "tagname": "cfg",
- "name": "showMarkers",
- "member": "Ext.chart.series.Line",
- "type": "Boolean",
- "doc": "<p>Whether markers should be displayed at the data points along the line. If true,\nthen the <a href=\"#/api/Ext.chart.series.Line-cfg-markerConfig\" rel=\"Ext.chart.series.Line-cfg-markerConfig\" class=\"docClass\">markerConfig</a> config item will determine the markers' styling.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 120,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line-cfg-showMarkers",
- "shortDoc": "Whether markers should be displayed at the data points along the line. If true,\nthen the markerConfig config item wil..."
- },
- {
- "tagname": "cfg",
- "name": "smooth",
- "member": "Ext.chart.series.Line",
- "type": "Boolean",
- "doc": "<p>If true, the line will be smoothed/rounded around its points, otherwise straight line\nsegments will be drawn. Defaults to false.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 152,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line-cfg-smooth",
- "shortDoc": "If true, the line will be smoothed/rounded around its points, otherwise straight line\nsegments will be drawn. Default..."
- },
- {
- "tagname": "cfg",
- "name": "style",
- "member": "Ext.chart.series.Line",
- "type": "Object",
- "doc": "<p>An object containing styles for the visualization lines. These styles will override the theme styles.\nSome options contained within the style object will are described next.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 145,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line-cfg-style",
- "shortDoc": "An object containing styles for the visualization lines. These styles will override the theme styles.\nSome options co..."
- },
- {
- "tagname": "cfg",
- "name": "tips",
- "member": "Ext.chart.series.Series",
- "type": "Object",
- "doc": "<p>Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with <a href=\"#/api/Ext.tip.ToolTip\" rel=\"Ext.tip.ToolTip\" class=\"docClass\">Ext.tip.ToolTip</a>. For example:</p>\n\n<pre><code>tips: {\n trackMouse: true,\n width: 140,\n height: 28,\n renderer: function(storeItem, item) {\n this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');\n }\n},\n</code></pre>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 54,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-cfg-tips",
- "shortDoc": "Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with Ext.tip.To..."
- },
- {
- "tagname": "cfg",
- "name": "title",
- "member": "Ext.chart.series.Series",
- "type": "String",
- "doc": "<p>The human-readable name of the series.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 75,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-cfg-title"
- },
- {
- "tagname": "cfg",
- "name": "type",
- "member": "Ext.chart.series.Series",
- "type": "String",
- "doc": "<p>The type of series. Set in subclasses.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 69,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-cfg-type"
- }
- ],
- "method": [
- {
- "tagname": "method",
- "name": "Line",
- "member": "Ext.chart.series.Cartesian",
- "doc": "\n",
- "params": [
-
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "members": {
+ "cfg": [
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Line.html#Ext-chart-series-Line-cfg-axis",
+ "shortDoc": "The position of the axis to bind the values to. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "name": "axis",
+ "owner": "Ext.chart.series.Line",
+ "doc": "<p>The position of the axis to bind the values to. Possible values are 'left', 'bottom', 'top' and 'right'.\nYou must explicitly set this value to bind the values of the line series to the ones in the axis, otherwise a\nrelative scale will be used.</p>\n",
+ "linenr": 107,
+ "html_filename": "Line.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Cartesian.js",
- "linenr": 1,
- "html_filename": "Cartesian.html",
- "href": "Cartesian.html#Ext-chart-series-Cartesian-method-constructor",
- "shortDoc": "\n"
- },
- {
- "tagname": "method",
- "name": "addEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
- "params": [
- {
- "type": "Object/String",
- "name": "o",
- "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
- "optional": false
- },
- {
- "type": "String",
- "name": "",
- "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Label2.html#Ext-chart-Label-cfg-color",
+ "shortDoc": "The color of the label text. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js",
+ "private": false,
+ "name": "color",
+ "owner": "Ext.chart.Label",
+ "doc": "<p>The color of the label text.\nDefault value: '#000' (black).</p>\n",
+ "linenr": 42,
+ "html_filename": "Label2.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 452,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addEvents",
- "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
- },
- {
- "tagname": "method",
- "name": "addListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Appends an event handler to this object.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
- "optional": false
- },
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The method the event invokes.</p>\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
- "optional": true
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Label2.html#Ext-chart-Label-cfg-display",
+ "shortDoc": "Specifies the presence and position of labels for each pie slice. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js",
+ "private": false,
+ "name": "display",
+ "owner": "Ext.chart.Label",
+ "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",
+ "linenr": 35,
+ "html_filename": "Label2.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Label2.html#Ext-chart-Label-cfg-field",
+ "shortDoc": "The name of the field to be displayed in the label. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js",
+ "private": false,
+ "name": "field",
+ "owner": "Ext.chart.Label",
+ "doc": "<p>The name of the field to be displayed in the label.\nDefault value: 'name'.</p>\n",
+ "linenr": 48,
+ "html_filename": "Label2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Line.html#Ext-chart-series-Line-cfg-fill",
+ "shortDoc": "If true, the area below the line will be filled in using the style.eefill and\nstyle.opacity config properties. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "name": "fill",
+ "owner": "Ext.chart.series.Line",
+ "doc": "<p>If true, the area below the line will be filled in using the style.eefill and\nstyle.opacity config properties. Defaults to false.</p>\n",
+ "linenr": 169,
+ "html_filename": "Line.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Label2.html#Ext-chart-Label-cfg-font",
+ "shortDoc": "The font used for the labels. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js",
+ "private": false,
+ "name": "font",
+ "owner": "Ext.chart.Label",
+ "doc": "<p>The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".</p>\n",
+ "linenr": 61,
+ "html_filename": "Label2.html"
+ },
+ {
+ "type": "Boolean|Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Series.html#Ext-chart-series-Series-cfg-highlight",
+ "shortDoc": "If set to true it will highlight the markers or the series when hovering\nwith the mouse. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "name": "highlight",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>If set to <code>true</code> it will highlight the markers or the series when hovering\nwith the mouse. This parameter can also be an object with the same style\nproperties you would apply to a <a href=\"#/api/Ext.draw.Sprite\" rel=\"Ext.draw.Sprite\" class=\"docClass\">Ext.draw.Sprite</a> to apply custom\nstyles to markers and series.</p>\n",
+ "linenr": 46,
+ "html_filename": "Series.html"
+ },
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Series.html#Ext-chart-series-Series-cfg-listeners",
+ "shortDoc": "An (optional) object with event callbacks. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "name": "listeners",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>An (optional) object with event callbacks. All event callbacks get the target <em>item</em> as first parameter. The callback functions are:</p>\n\n<p> <ul></p>\n\n<pre><code> <li>itemmouseover</li>\n <li>itemmouseout</li>\n <li>itemmousedown</li>\n <li>itemmouseup</li>\n</code></pre>\n\n<p> </ul></p>\n",
+ "linenr": 105,
+ "html_filename": "Series.html"
+ },
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Line.html#Ext-chart-series-Line-cfg-markerConfig",
+ "shortDoc": "The display style for the markers. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "name": "markerConfig",
+ "owner": "Ext.chart.series.Line",
+ "doc": "<p>The display style for the markers. Only used if <a href=\"#/api/Ext.chart.series.Line-cfg-showMarkers\" rel=\"Ext.chart.series.Line-cfg-showMarkers\" class=\"docClass\">showMarkers</a> is true.\nThe markerConfig is a configuration object containing the same set of properties defined in\nthe Sprite class. For example, if we were to set red circles as markers to the line series we could\npass the object:</p>\n\n<pre><code> markerConfig: {\n type: 'circle',\n radius: 4,\n 'fill': '#f00'\n }\n </code></pre>\n\n",
+ "linenr": 127,
+ "html_filename": "Line.html"
+ },
+ {
+ "type": "Number",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Label2.html#Ext-chart-Label-cfg-minMargin",
+ "shortDoc": "Specifies the minimum distance from a label to the origin of the visualization. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js",
+ "private": false,
+ "name": "minMargin",
+ "owner": "Ext.chart.Label",
+ "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",
+ "linenr": 54,
+ "html_filename": "Label2.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Label2.html#Ext-chart-Label-cfg-orientation",
+ "shortDoc": "Either \"horizontal\" or \"vertical\". ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Label.js",
+ "private": false,
+ "name": "orientation",
+ "owner": "Ext.chart.Label",
+ "doc": "<p>Either \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".</p>\n",
+ "linenr": 67,
+ "html_filename": "Label2.html"
+ },
+ {
+ "type": "Function",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Series.html#Ext-chart-series-Series-cfg-renderer",
+ "shortDoc": "A function that can be overridden to set custom styling properties to each rendered element. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "name": "renderer",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>A function that can be overridden to set custom styling properties to each rendered element.\nPasses in (sprite, record, attributes, index, store) to the function.</p>\n",
+ "linenr": 87,
+ "html_filename": "Series.html"
+ },
+ {
+ "type": "Number",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Line.html#Ext-chart-series-Line-cfg-selectionTolerance",
+ "shortDoc": "The offset distance from the cursor position to the line series to trigger events (then used for highlighting series,...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "name": "selectionTolerance",
+ "owner": "Ext.chart.series.Line",
+ "doc": "<p>The offset distance from the cursor position to the line series to trigger events (then used for highlighting series, etc).</p>\n",
+ "linenr": 114,
+ "html_filename": "Line.html"
+ },
+ {
+ "type": "Array",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Series.html#Ext-chart-series-Series-cfg-shadowAttributes",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "name": "shadowAttributes",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>An array with shadow attributes</p>\n",
+ "linenr": 96,
+ "html_filename": "Series.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Series.html#Ext-chart-series-Series-cfg-showInLegend",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "name": "showInLegend",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>Whether to show this series in the legend.</p>\n",
+ "linenr": 81,
+ "html_filename": "Series.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Line.html#Ext-chart-series-Line-cfg-showMarkers",
+ "shortDoc": "Whether markers should be displayed at the data points along the line. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "name": "showMarkers",
+ "owner": "Ext.chart.series.Line",
+ "doc": "<p>Whether markers should be displayed at the data points along the line. If true,\nthen the <a href=\"#/api/Ext.chart.series.Line-cfg-markerConfig\" rel=\"Ext.chart.series.Line-cfg-markerConfig\" class=\"docClass\">markerConfig</a> config item will determine the markers' styling.</p>\n",
+ "linenr": 120,
+ "html_filename": "Line.html"
+ },
+ {
+ "type": "Boolean/Number",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Line.html#Ext-chart-series-Line-cfg-smooth",
+ "shortDoc": "If set to true or a non-zero number, the line will be smoothed/rounded around its points; otherwise\nstraight line seg...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "name": "smooth",
+ "owner": "Ext.chart.series.Line",
+ "doc": "<p>If set to <code>true</code> or a non-zero number, the line will be smoothed/rounded around its points; otherwise\nstraight line segments will be drawn.</p>\n\n<p>A numeric value is interpreted as a divisor of the horizontal distance between consecutive points in\nthe line; larger numbers result in sharper curves while smaller numbers result in smoother curves.</p>\n\n<p>If set to <code>true</code> then a default numeric value of 3 will be used. Defaults to <code>false</code>.</p>\n",
+ "linenr": 152,
+ "html_filename": "Line.html"
+ },
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Line.html#Ext-chart-series-Line-cfg-style",
+ "shortDoc": "An object containing styles for the visualization lines. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "name": "style",
+ "owner": "Ext.chart.series.Line",
+ "doc": "<p>An object containing styles for the visualization lines. These styles will override the theme styles.\nSome options contained within the style object will are described next.</p>\n",
+ "linenr": 145,
+ "html_filename": "Line.html"
+ },
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Series.html#Ext-chart-series-Series-cfg-tips",
+ "shortDoc": "Add tooltips to the visualization's markers. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "name": "tips",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with <a href=\"#/api/Ext.tip.ToolTip\" rel=\"Ext.tip.ToolTip\" class=\"docClass\">Ext.tip.ToolTip</a>. For example:</p>\n\n<pre><code>tips: {\n trackMouse: true,\n width: 140,\n height: 28,\n renderer: function(storeItem, item) {\n this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');\n }\n},\n</code></pre>\n",
+ "linenr": 54,
+ "html_filename": "Series.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Series.html#Ext-chart-series-Series-cfg-title",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "name": "title",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>The human-readable name of the series.</p>\n",
+ "linenr": 75,
+ "html_filename": "Series.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Series.html#Ext-chart-series-Series-cfg-type",
+ "shortDoc": "The type of series. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "name": "type",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>The type of series. Set in subclasses.</p>\n",
+ "linenr": 69,
+ "html_filename": "Series.html"
+ }
+ ],
+ "method": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-addEvents",
+ "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>Either an object with event names as properties with a value of <code>true</code> or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:</p>\n\n<pre><code>this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n</code></pre>\n",
+ "name": "o"
+ },
+ {
+ "type": "String...",
+ "optional": false,
+ "doc": "<p>Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n",
+ "name": "more"
+ }
+ ],
+ "name": "addEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
+ "linenr": 494,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 271,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addListener",
- "shortDoc": "<p>Appends an event handler to this object.</p>\n"
- },
- {
- "tagname": "method",
- "name": "addManagedListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
- "params": [
- {
- "type": "Observable/Element",
- "name": "item",
- "doc": "<p>The item to which to add a listener/listeners.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-addListener",
+ "shortDoc": "Appends an event handler to this object. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The method the event invokes. Will be called with arguments given to\n<a href=\"#/api/Ext.chart.series.Line-method-fireEvent\" rel=\"Ext.chart.series.Line-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>\n\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
+ "name": "options"
+ }
+ ],
+ "name": "addListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Appends an event handler to this object.</p>\n",
+ "linenr": 278,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object/String",
- "name": "ename",
- "doc": "<p>The event name, or an object containing event name properties.</p>\n",
- "optional": false
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
+ "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable/Element",
+ "optional": false,
+ "doc": "<p>The item to which to add a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
+ "name": "opt"
+ }
+ ],
+ "name": "addManagedListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
+ "linenr": 156,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
- "optional": false
+ "html_filename": "Observable.html"
+ },
+ {
+ "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": "<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",
+ "linenr": 388,
+ "return": {
+ "type": "Ext.Base",
+ "doc": "<p>this</p>\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
- "optional": false
+ "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": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "callOverridden",
+ "owner": "Ext.Base",
+ "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",
+ "linenr": 269,
+ "return": {
+ "type": "Mixed",
+ "doc": "<p>Returns the result after calling the overridden method</p>\n"
},
- {
- "type": "Object",
- "name": "opt",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 155,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
- "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
- },
- {
- "tagname": "method",
- "name": "capture",
- "member": "Ext.util.Observable",
- "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
- "params": [
- {
- "type": "Observable",
- "name": "o",
- "doc": "<p>The Observable to capture events from.</p>\n",
- "optional": false
+ {
+ "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": "<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",
+ "name": "args"
+ }
+ ],
+ "name": "callParent",
+ "owner": "Ext.Base",
+ "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",
+ "linenr": 124,
+ "return": {
+ "type": "Mixed",
+ "doc": "<p>Returns the result from the superclass' method</p>\n"
},
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to call when an event is fired.</p>\n",
- "optional": false
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-capture",
+ "shortDoc": "Starts capture on the specified Observable. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable",
+ "optional": false,
+ "doc": "<p>The Observable to capture events from.</p>\n",
+ "name": "o"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to call when an event is fired.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to\nthe Observable firing the event.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "capture",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event <strong>before</strong> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
+ "linenr": 54,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": true,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 55,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-capture",
- "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
- },
- {
- "tagname": "method",
- "name": "clearListeners",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-clearListeners",
+ "shortDoc": "Removes all listeners for this object including the managed listeners ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "clearListeners",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
+ "linenr": 425,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 383,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-clearListeners",
- "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
- },
- {
- "tagname": "method",
- "name": "clearManagedListeners",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes all managed listeners for this object.</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
+ "shortDoc": "Removes all managed listeners for this object. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "clearManagedListeners",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes all managed listeners for this object.</p>\n",
+ "linenr": 454,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 412,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
- "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
- },
- {
- "tagname": "method",
- "name": "drawSeries",
- "member": "Ext.chart.series.Line",
- "doc": "<p>Draws the series for the current chart.</p>\n",
- "params": [
+ {
+ "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": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "create",
+ "owner": "Ext.Base",
+ "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",
+ "linenr": 329,
+ "return": {
+ "type": "Object",
+ "doc": "<p>the created instance.</p>\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 240,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line-method-drawSeries",
- "shortDoc": "<p>Draws the series for the current chart.</p>\n"
- },
- {
- "tagname": "method",
- "name": "enableBubble",
- "member": "Ext.util.Observable",
- "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n}),\n\n// We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\n</code></pre>\n\n",
- "params": [
- {
- "type": "String/Array",
- "name": "events",
- "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "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": "<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",
+ "name": "alias"
+ },
+ {
+ "type": "String/Object",
+ "optional": false,
+ "doc": "<p>The original method name</p>\n",
+ "name": "origin"
+ }
+ ],
+ "name": "createAlias",
+ "owner": "Ext.Base",
+ "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() -> test.method1()\n</code></pre>\n",
+ "linenr": 648,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 554,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-enableBubble",
- "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
- },
- {
- "tagname": "method",
- "name": "fireEvent",
- "member": "Ext.util.Observable",
- "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.chart.series.Line-method-enableBubble\" rel=\"Ext.chart.series.Line-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The name of the event to fire.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Line.html#Ext-chart-series-Line-method-drawSeries",
+ "shortDoc": "Draws the series for the current chart. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "drawSeries",
+ "owner": "Ext.chart.series.Line",
+ "doc": "<p>Draws the series for the current chart.</p>\n",
+ "linenr": 250,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object...",
- "name": "args",
- "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
+ "html_filename": "Line.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 232,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-fireEvent",
- "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
- },
- {
- "tagname": "method",
- "name": "getItemForPoint",
- "member": "Ext.chart.series.Series",
- "doc": "<p>For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.</p>\n",
- "params": [
- {
- "type": "Number",
- "name": "x",
- "doc": "\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-enableBubble",
+ "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String/[String]",
+ "optional": false,
+ "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
+ "name": "events"
+ }
+ ],
+ "name": "enableBubble",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling <code>this.getBubbleTarget()</code> if\npresent. There is no implementation in the Observable base class.</p>\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers.\nSee <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default implementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.</p>\n\n<p>Example:</p>\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n</code></pre>\n",
+ "linenr": 609,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Number",
- "name": "y",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Object",
- "doc": "<p>An object describing the item, or null if there is no matching item. The exact contents of</p>\n\n<pre><code> this object will vary by series type, but should always contain at least the following:\n <ul>\n <li>{Ext.chart.series.Series} series - the Series object to which the item belongs</li>\n <li>{Object} value - the value(s) of the item's data point</li>\n <li>{Array} point - the x/y coordinates relative to the chart box of a single point\n for this data item, which can be used as e.g. a tooltip anchor point.</li>\n <li>{Ext.draw.Sprite} sprite - the item's rendering Sprite.\n </ul>\n</code></pre>\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 241,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-method-getItemForPoint",
- "shortDoc": "<p>For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.</p>\n"
- },
- {
- "tagname": "method",
- "name": "getLegendColor",
- "member": "Ext.chart.series.Series",
- "doc": "<p>Returns a string with the color to be used for the series legend item.</p>\n",
- "params": [
- {
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-fireEvent",
+ "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to fire.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Object...",
+ "optional": false,
+ "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "fireEvent",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Fires the specified event with the passed parameters (minus the event name, plus the <code>options</code> object passed\nto <a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a>).</p>\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>) by\ncalling <a href=\"#/api/Ext.chart.series.Line-method-enableBubble\" rel=\"Ext.chart.series.Line-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n",
+ "linenr": 233,
+ "return": {
+ "type": "Boolean",
+ "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
+ },
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Series.html#Ext-chart-series-Series-method-getItemForPoint",
+ "shortDoc": "For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "\n",
+ "name": "x"
+ },
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "\n",
+ "name": "y"
+ }
+ ],
+ "name": "getItemForPoint",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.</p>\n",
+ "linenr": 241,
+ "return": {
"type": "Object",
- "name": "index",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "doc": "<p>An object describing the item, or null if there is no matching item. The exact contents of</p>\n\n<pre><code> this object will vary by series type, but should always contain at least the following:\n <ul>\n <li>{Ext.chart.series.Series} series - the Series object to which the item belongs</li>\n <li>{Object} value - the value(s) of the item's data point</li>\n <li>{Array} point - the x/y coordinates relative to the chart box of a single point\n for this data item, which can be used as e.g. a tooltip anchor point.</li>\n <li>{Ext.draw.Sprite} sprite - the item's rendering Sprite.\n </ul>\n</code></pre>\n"
+ },
+ "html_filename": "Series.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 321,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-method-getLegendColor",
- "shortDoc": "<p>Returns a string with the color to be used for the series legend item.</p>\n"
- },
- {
- "tagname": "method",
- "name": "hasListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The name of the event to check for</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>True if the event is being listened for, else false</p>\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Series.html#Ext-chart-series-Series-method-getLegendColor",
+ "shortDoc": "Returns a string with the color to be used for the series legend item. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "index"
+ }
+ ],
+ "name": "getLegendColor",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>Returns a string with the color to be used for the series legend item.</p>\n",
+ "linenr": 321,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Series.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 480,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-hasListener",
- "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
- },
- {
- "tagname": "method",
- "name": "hideAll",
- "member": "Ext.chart.series.Series",
- "doc": "<p>Hides all the elements in the series.</p>\n",
- "params": [
+ {
+ "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": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "getName",
+ "owner": "Ext.Base",
+ "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",
+ "linenr": 631,
+ "return": {
+ "type": "String",
+ "doc": "<p>className</p>\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 282,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-method-hideAll",
- "shortDoc": "<p>Hides all the elements in the series.</p>\n"
- },
- {
- "tagname": "method",
- "name": "highlightItem",
- "member": "Ext.chart.Highlight",
- "doc": "<p>Highlight the given series item.</p>\n",
- "params": [
- {
- "type": "Object",
- "name": "item",
- "doc": "<p>Info about the item; same format as returned by #getItemForPoint.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-hasListener",
+ "shortDoc": "Checks to see if this object has any listeners for a specified event ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to check for</p>\n",
+ "name": "eventName"
+ }
+ ],
+ "name": "hasListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
+ "linenr": 530,
+ "return": {
+ "type": "Boolean",
+ "doc": "<p>True if the event is being listened for, else false</p>\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js",
- "linenr": 38,
- "html_filename": "Highlight.html",
- "href": "Highlight.html#Ext-chart-Highlight-method-highlightItem",
- "shortDoc": "<p>Highlight the given series item.</p>\n"
- },
- {
- "tagname": "method",
- "name": "observe",
- "member": "Ext.util.Observable",
- "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
- "params": [
- {
- "type": "Function",
- "name": "c",
- "doc": "<p>The class constructor to make observable.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Series.html#Ext-chart-series-Series-method-hideAll",
+ "shortDoc": "Hides all the elements in the series. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "hideAll",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>Hides all the elements in the series.</p>\n",
+ "linenr": 282,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "listeners",
- "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Series.html"
},
- "private": false,
- "static": true,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 69,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-observe",
- "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
- },
- {
- "tagname": "method",
- "name": "on",
- "member": "Ext.util.Observable",
- "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event to listen for</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Highlight.html#Ext-chart-Highlight-method-highlightItem",
+ "shortDoc": "Highlight the given series item. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Info about the item; same format as returned by #getItemForPoint.</p>\n",
+ "name": "item"
+ }
+ ],
+ "name": "highlightItem",
+ "owner": "Ext.chart.Highlight",
+ "doc": "<p>Highlight the given series item.</p>\n",
+ "linenr": 38,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The method the event invokes</p>\n",
- "optional": false
+ "html_filename": "Highlight.html"
+ },
+ {
+ "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": "<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",
+ "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": "<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",
+ "linenr": 63,
+ "return": {
"type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
- "optional": true
+ "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
},
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>(optional) An object containing handler configuration.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 616,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-on",
- "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
- },
- {
- "tagname": "method",
- "name": "relayEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
- "params": [
- {
- "type": "Object",
- "name": "origin",
- "doc": "<p>The Observable whose events this object is to relay.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "addManagedListener"
},
- {
- "type": "Array",
- "name": "events",
- "doc": "<p>Array of event names to relay.</p>\n",
- "optional": false
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-mon",
+ "shortDoc": "Shorthand for addManagedListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable/Element",
+ "optional": false,
+ "doc": "<p>The item to which to add a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
+ "name": "opt"
+ }
+ ],
+ "name": "mon",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.chart.series.Line-method-addManagedListener\" rel=\"Ext.chart.series.Line-method-addManagedListener\" class=\"docClass\">addManagedListener</a>.</p>\n\n<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
+ "linenr": 681,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "prefix",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 520,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-relayEvents",
- "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
- },
- {
- "tagname": "method",
- "name": "releaseCapture",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
- "params": [
- {
- "type": "Observable",
- "name": "o",
- "doc": "<p>The Observable to release</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "removeManagedListener"
+ },
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-mun",
+ "shortDoc": "Shorthand for removeManagedListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable|Element",
+ "optional": false,
+ "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object|String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "mun",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.chart.series.Line-method-removeManagedListener\" rel=\"Ext.chart.series.Line-method-removeManagedListener\" class=\"docClass\">removeManagedListener</a>.</p>\n\n<p>Removes listeners that were added by the <a href=\"#/api/Ext.chart.series.Line-method-mon\" rel=\"Ext.chart.series.Line-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
+ "linenr": 687,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": true,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 46,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
- "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
- },
- {
- "tagname": "method",
- "name": "removeListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes an event handler.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event the handler was associated with.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-observe",
+ "shortDoc": "Sets observability on the passed class constructor. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The class constructor to make observable.</p>\n",
+ "name": "c"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
+ "name": "listeners"
+ }
+ ],
+ "name": "observe",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
+ "linenr": 69,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
- "optional": false
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "addListener"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-on",
+ "shortDoc": "Shorthand for addListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The method the event invokes. Will be called with arguments given to\n<a href=\"#/api/Ext.chart.series.Line-method-fireEvent\" rel=\"Ext.chart.series.Line-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>\n\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
+ "name": "options"
+ }
+ ],
+ "name": "on",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a>.</p>\n\n<p>Appends an event handler to this object.</p>\n",
+ "linenr": 669,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.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": "<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",
+ "linenr": 518,
+ "return": {
+ "type": "Ext.Base",
+ "doc": "<p>this</p>\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 352,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-removeListener",
- "shortDoc": "<p>Removes an event handler.</p>\n"
- },
- {
- "tagname": "method",
- "name": "removeManagedListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.chart.series.Line--mon\" rel=\"Ext.chart.series.Line--mon\" class=\"docClass\">mon</a> method.</p>\n",
- "params": [
- {
- "type": "Observable|Element",
- "name": "item",
- "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-relayEvents",
+ "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The Observable whose events this object is to relay.</p>\n",
+ "name": "origin"
+ },
+ {
+ "type": "[String]",
+ "optional": false,
+ "doc": "<p>Array of event names to relay.</p>\n",
+ "name": "events"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "prefix"
+ }
+ ],
+ "name": "relayEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code>this</code>.</p>\n",
+ "linenr": 573,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object|String",
- "name": "ename",
- "doc": "<p>The event name, or an object containing event name properties.</p>\n",
- "optional": false
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
+ "shortDoc": "Removes all added captures from the Observable. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable",
+ "optional": false,
+ "doc": "<p>The Observable to release</p>\n",
+ "name": "o"
+ }
+ ],
+ "name": "releaseCapture",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes <strong>all</strong> added captures from the Observable.</p>\n",
+ "linenr": 44,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
- "optional": false
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-removeListener",
+ "shortDoc": "Removes an event handler. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The type of event the handler was associated with.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "removeListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes an event handler.</p>\n",
+ "linenr": 392,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
+ "shortDoc": "Removes listeners that were added by the mon method. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable|Element",
+ "optional": false,
+ "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object|String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "removeManagedListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.chart.series.Line-method-mon\" rel=\"Ext.chart.series.Line-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
+ "linenr": 197,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 196,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
- "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.chart.series.Line--mon\" rel=\"Ext.chart.series.Line--mon\" class=\"docClass\">mon</a> method.</p>\n"
- },
- {
- "tagname": "method",
- "name": "resumeEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.chart.series.Line-method-suspendEvents\" rel=\"Ext.chart.series.Line-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
+ "shortDoc": "Resumes firing events (see suspendEvents). ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "resumeEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Resumes firing events (see <a href=\"#/api/Ext.chart.series.Line-method-suspendEvents\" rel=\"Ext.chart.series.Line-method-suspendEvents\" class=\"docClass\">suspendEvents</a>).</p>\n\n<p>If events were suspended using the <code>**queueSuspended**</code> parameter, then all events fired\nduring event suspension will be sent to any listeners now.</p>\n",
+ "linenr": 554,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 502,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
- "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
- },
- {
- "tagname": "method",
- "name": "setTitle",
- "member": "Ext.chart.series.Series",
- "doc": "<p>Changes the value of the <a href=\"#/api/Ext.chart.series.Line-cfg-title\" rel=\"Ext.chart.series.Line-cfg-title\" class=\"docClass\">title</a> for the series.\nArguments can take two forms:</p>\n\n<ul>\n<li>A single String value: this will be used as the new single title for the series (applies\nto series with only one yField)</li>\n<li>A numeric index and a String value: this will set the title for a single indexed yField.</li>\n</ul>\n\n",
- "params": [
- {
- "type": "Number",
- "name": "index",
- "doc": "\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Series.html#Ext-chart-series-Series-method-setTitle",
+ "shortDoc": "Changes the value of the title for the series. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "\n",
+ "name": "index"
+ },
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "\n",
+ "name": "title"
+ }
+ ],
+ "name": "setTitle",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>Changes the value of the <a href=\"#/api/Ext.chart.series.Line-cfg-title\" rel=\"Ext.chart.series.Line-cfg-title\" class=\"docClass\">title</a> for the series.\nArguments can take two forms:</p>\n\n<ul>\n<li>A single String value: this will be used as the new single title for the series (applies\nto series with only one yField)</li>\n<li>A numeric index and a String value: this will set the title for a single indexed yField.</li>\n</ul>\n\n",
+ "linenr": 350,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "String",
- "name": "title",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Series.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 350,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-method-setTitle",
- "shortDoc": "Changes the value of the title for the series.\nArguments can take two forms:\n\n\nA single String value: this will be us..."
- },
- {
- "tagname": "method",
- "name": "showAll",
- "member": "Ext.chart.series.Series",
- "doc": "<p>Shows all the elements in the series.</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Series.html#Ext-chart-series-Series-method-showAll",
+ "shortDoc": "Shows all the elements in the series. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "showAll",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>Shows all the elements in the series.</p>\n",
+ "linenr": 308,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Series.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 308,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-method-showAll",
- "shortDoc": "<p>Shows all the elements in the series.</p>\n"
- },
- {
- "tagname": "method",
- "name": "suspendEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.chart.series.Line-method-resumeEvents\" rel=\"Ext.chart.series.Line-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
- "params": [
- {
- "type": "Boolean",
- "name": "queueSuspended",
- "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.chart.series.Line-method-resumeEvents\" rel=\"Ext.chart.series.Line-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "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": [
+
+ ],
+ "name": "statics",
+ "owner": "Ext.Base",
+ "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",
+ "linenr": 199,
+ "return": {
+ "type": "Class",
+ "doc": "\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 490,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
- "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.chart.series.Line-method-resumeEvents\" rel=\"Ext.chart.series.Line-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
- },
- {
- "tagname": "method",
- "name": "un",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.chart.series.Line-method-removeListener\" rel=\"Ext.chart.series.Line-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event the handler was associated with.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
+ "shortDoc": "Suspends the firing of all events. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.chart.series.Line-method-resumeEvents\" rel=\"Ext.chart.series.Line-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events.</p>\n",
+ "name": "queueSuspended"
+ }
+ ],
+ "name": "suspendEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Suspends the firing of all events. (see <a href=\"#/api/Ext.chart.series.Line-method-resumeEvents\" rel=\"Ext.chart.series.Line-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
+ "linenr": 541,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
- "optional": false
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "removeListener"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-un",
+ "shortDoc": "Shorthand for removeListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The type of event the handler was associated with.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.chart.series.Line-method-addListener\" rel=\"Ext.chart.series.Line-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "un",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.chart.series.Line-method-removeListener\" rel=\"Ext.chart.series.Line-method-removeListener\" class=\"docClass\">removeListener</a>.</p>\n\n<p>Removes an event handler.</p>\n",
+ "linenr": 675,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 608,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-un",
- "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.chart.series.Line-method-removeListener\" rel=\"Ext.chart.series.Line-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
- },
- {
- "tagname": "method",
- "name": "unHighlightItem",
- "member": "Ext.chart.Highlight",
- "doc": "<p>Un-highlight any existing highlights</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Highlight.html#Ext-chart-Highlight-method-unHighlightItem",
+ "shortDoc": "Un-highlight any existing highlights ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js",
- "linenr": 109,
- "html_filename": "Highlight.html",
- "href": "Highlight.html#Ext-chart-Highlight-method-unHighlightItem",
- "shortDoc": "<p>Un-highlight any existing highlights</p>\n"
- }
- ],
- "property": [
- {
- "tagname": "property",
- "name": "axis",
- "member": "Ext.chart.series.Cartesian",
- "type": "String",
- "doc": "<p>Indicates which axis the series will bind to</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Cartesian.js",
- "linenr": 37,
- "html_filename": "Cartesian.html",
- "href": "Cartesian.html#Ext-chart-series-Cartesian-property-axis"
- },
- {
- "tagname": "property",
- "name": "highlight",
- "member": "Ext.chart.Highlight",
- "type": "Boolean",
- "doc": "<p>Highlight the given series item.</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Highlight.js",
- "linenr": 13,
- "html_filename": "Highlight.html",
- "href": "Highlight.html#Ext-chart-Highlight-property-highlight"
- },
- {
- "tagname": "property",
- "name": "xField",
- "member": "Ext.chart.series.Cartesian",
- "type": "String",
- "doc": "<p>The field used to access the x axis value from the items from the data\nsource.</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Cartesian.js",
- "linenr": 19,
- "html_filename": "Cartesian.html",
- "href": "Cartesian.html#Ext-chart-series-Cartesian-property-xField"
- },
- {
- "tagname": "property",
- "name": "yField",
- "member": "Ext.chart.series.Cartesian",
- "type": "String",
- "doc": "<p>The field used to access the y-axis value from the items from the data\nsource.</p>\n",
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Cartesian.js",
- "linenr": 28,
- "html_filename": "Cartesian.html",
- "href": "Cartesian.html#Ext-chart-series-Cartesian-property-yField"
- }
- ],
- "event": [
- {
- "tagname": "event",
- "name": "titlechange",
- "member": "Ext.chart.series.Series",
- "doc": "<p>Fires when the series title is changed via <a href=\"#/api/Ext.chart.series.Line-method-setTitle\" rel=\"Ext.chart.series.Line-method-setTitle\" class=\"docClass\">setTitle</a>.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "title",
- "doc": "<p>The new title value</p>\n",
- "optional": false
+ ],
+ "name": "unHighlightItem",
+ "owner": "Ext.chart.Highlight",
+ "doc": "<p>Un-highlight any existing highlights</p>\n",
+ "linenr": 106,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Number",
- "name": "index",
- "doc": "<p>The index in the collection of titles</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Series.js",
- "linenr": 139,
- "html_filename": "Series.html",
- "href": "Series.html#Ext-chart-series-Series-event-titlechange",
- "shortDoc": "<p>Fires when the series title is changed via <a href=\"#/api/Ext.chart.series.Line-method-setTitle\" rel=\"Ext.chart.series.Line-method-setTitle\" class=\"docClass\">setTitle</a>.</p>\n"
- }
- ],
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Line.js",
- "linenr": 1,
- "html_filename": "Line.html",
- "href": "Line.html#Ext-chart-series-Line",
- "cssVar": [
+ "html_filename": "Highlight.html"
+ }
+ ],
+ "property": [
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Cartesian.html#Ext-chart-series-Cartesian-property-axis",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Cartesian.js",
+ "private": false,
+ "name": "axis",
+ "owner": "Ext.chart.series.Cartesian",
+ "doc": "<p>Indicates which axis the series will bind to</p>\n",
+ "linenr": 36,
+ "html_filename": "Cartesian.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Highlight.html#Ext-chart-Highlight-property-highlight",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/Highlight.js",
+ "private": false,
+ "name": "highlight",
+ "owner": "Ext.chart.Highlight",
+ "doc": "<p>Highlight the given series item.</p>\n",
+ "linenr": 13,
+ "html_filename": "Highlight.html"
+ },
+ {
+ "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": "<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",
+ "linenr": 18,
+ "html_filename": "Base3.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Cartesian.html#Ext-chart-series-Cartesian-property-xField",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Cartesian.js",
+ "private": false,
+ "name": "xField",
+ "owner": "Ext.chart.series.Cartesian",
+ "doc": "<p>The field used to access the x axis value from the items from the data\nsource.</p>\n",
+ "linenr": 18,
+ "html_filename": "Cartesian.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "property",
+ "href": "Cartesian.html#Ext-chart-series-Cartesian-property-yField",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Cartesian.js",
+ "private": false,
+ "name": "yField",
+ "owner": "Ext.chart.series.Cartesian",
+ "doc": "<p>The field used to access the y-axis value from the items from the data\nsource.</p>\n",
+ "linenr": 27,
+ "html_filename": "Cartesian.html"
+ }
+ ],
+ "cssVar": [
- ],
- "cssMixin": [
+ ],
+ "cssMixin": [
- ],
- "component": false,
+ ],
+ "event": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "Series.html#Ext-chart-series-Series-event-titlechange",
+ "shortDoc": "Fires when the series title is changed via setTitle. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Series.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The new title value</p>\n",
+ "name": "title"
+ },
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The index in the collection of titles</p>\n",
+ "name": "index"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "titlechange",
+ "owner": "Ext.chart.series.Series",
+ "doc": "<p>Fires when the series title is changed via <a href=\"#/api/Ext.chart.series.Line-method-setTitle\" rel=\"Ext.chart.series.Line-method-setTitle\" class=\"docClass\">setTitle</a>.</p>\n",
+ "linenr": 139,
+ "html_filename": "Series.html"
+ }
+ ]
+ },
+ "singleton": false,
+ "alias": null,
"superclasses": [
+ "Ext.Base",
"Ext.chart.series.Series",
"Ext.chart.series.Cartesian"
],
+ "protected": false,
+ "tagname": "class",
+ "mixins": [
+
+ ],
+ "href": "Line.html#Ext-chart-series-Line",
"subclasses": [
],
+ "static": false,
+ "author": null,
+ "component": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/chart/series/Line.js",
+ "private": false,
+ "alternateClassNames": [
+ "Ext.chart.LineSeries",
+ "Ext.chart.LineChart"
+ ],
+ "name": "Ext.chart.series.Line",
+ "doc": "<p>Creates a Line Chart. A Line Chart is a useful visualization technique to display quantitative information for different\ncategories or other real values (as opposed to the bar chart), that can show some progression (or regression) in the dataset.\nAs with all other series, the Line Series must be appended in the <em>series</em> Chart array configuration. See the Chart\ndocumentation for more information. A typical configuration object for the line series could be:</p>\n\n<p><p><img src=\"doc-resources/Ext.chart.series.Line/Ext.chart.series.Line.png\" alt=\"Ext.chart.series.Line chart series\"></p></p>\n\n<pre><code>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\nExt.create('Ext.chart.Chart', {\n renderTo: Ext.getBody(),\n width: 500,\n height: 300,\n animate: true,\n store: store,\n axes: [{\n type: 'Numeric',\n position: 'bottom',\n fields: ['data1'],\n label: {\n renderer: Ext.util.Format.numberRenderer('0,0')\n },\n title: 'Sample Values',\n grid: true,\n minimum: 0\n }, {\n type: 'Category',\n position: 'left',\n fields: ['name'],\n title: 'Sample Metrics'\n }],\n series: [{\n type: 'line',\n highlight: {\n size: 7,\n radius: 7\n },\n axis: 'left',\n xField: 'name',\n yField: 'data1',\n markerCfg: {\n type: 'cross',\n size: 4,\n radius: 4,\n 'stroke-width': 0\n }\n }, {\n type: 'line',\n highlight: {\n size: 7,\n radius: 7\n },\n axis: 'left',\n fill: true,\n xField: 'name',\n yField: 'data3',\n markerCfg: {\n type: 'circle',\n size: 4,\n radius: 4,\n 'stroke-width': 0\n }\n }]\n});\n</code></pre>\n\n<p>In this configuration we're adding two series (or lines), one bound to the <code>data1</code>\nproperty of the store and the other to <code>data3</code>. The type for both configurations is\n<code>line</code>. The <code>xField</code> for both series is the same, the name propert of the store.\nBoth line series share the same axis, the left axis. You can set particular marker\nconfiguration by adding properties onto the markerConfig object. Both series have\nan object as highlight so that markers animate smoothly to the properties in highlight\nwhen hovered. The second series has <code>fill=true</code> which means that the line will also\nhave an area below it of the same color.</p>\n\n<p><strong>Note:</strong> In the series definition remember to explicitly set the axis to bind the\nvalues of the line series to. This can be done by using the <code>axis</code> configuration property.</p>\n",
"mixedInto": [
],
- "allMixins": [
- "Ext.util.Observable",
- "Ext.chart.Label",
- "Ext.chart.Highlight",
- "Ext.chart.Tip",
- "Ext.chart.Callout"
- ]
+ "linenr": 1,
+ "xtypes": [
+
+ ],
+ "html_filename": "Line.html",
+ "extends": "Ext.chart.series.Cartesian"
});
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff