X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..refs/heads/master:/docs/output/Ext.chart.series.Line.js?ds=inline diff --git a/docs/output/Ext.chart.series.Line.js b/docs/output/Ext.chart.series.Line.js index c0e20954..bf24f002 100644 --- a/docs/output/Ext.chart.series.Line.js +++ b/docs/output/Ext.chart.series.Line.js @@ -1,1188 +1 @@ -Ext.data.JsonP.Ext_chart_series_Line({ - "tagname": "class", - "name": "Ext.chart.series.Line", - "doc": "
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 series Chart array configuration. See the Chart\ndocumentation for more information. A typical configuration object for the line series could be:
\n\n\n\nvar store = Ext.create('Ext.data.JsonStore', {\n fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'],\n data: [\n {'name':'metric one', 'data1':10, 'data2':12, 'data3':14, 'data4':8, 'data5':13},\n {'name':'metric two', 'data1':7, 'data2':8, 'data3':16, 'data4':10, 'data5':3},\n {'name':'metric three', 'data1':5, 'data2':2, 'data3':14, 'data4':12, 'data5':7},\n {'name':'metric four', 'data1':2, 'data2':14, 'data3':6, 'data4':1, 'data5':23},\n {'name':'metric five', 'data1':27, 'data2':38, 'data3':36, 'data4':13, 'data5':33} \n ]\n});\n\nExt.create('Ext.chart.Chart', {\n renderTo: Ext.getBody(),\n width: 500,\n height: 300,\n animate: true,\n store: store,\n 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
\n\nIn this configuration we're adding two series (or lines), one bound to the data1
\nproperty of the store and the other to data3
. The type for both configurations is\nline
. The xField
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 fill=true
which means that the line will also\nhave an area below it of the same color.
Note: 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 axis
configuration property.
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.
\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": "The color of the label text.\nDefault value: '#000' (black).
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 42, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-color" - }, - { - "tagname": "cfg", - "name": "display", - "member": "Ext.chart.Label", - "type": "String", - "doc": "Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEnd\", \"outside\", \"over\", \"under\", or \"none\" to prevent label rendering.\nDefault value: 'none'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 35, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-display", - "shortDoc": "Specifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEn..." - }, - { - "tagname": "cfg", - "name": "field", - "member": "Ext.chart.Label", - "type": "String", - "doc": "The name of the field to be displayed in the label.\nDefault value: 'name'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 48, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-field" - }, - { - "tagname": "cfg", - "name": "fill", - "member": "Ext.chart.series.Line", - "type": "Boolean", - "doc": "If true, the area below the line will be filled in using the style.eefill and\nstyle.opacity config properties. Defaults to false.
\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": "The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 61, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-font" - }, - { - "tagname": "cfg", - "name": "highlight", - "member": "Ext.chart.series.Series", - "type": "Boolean|Object", - "doc": "If set to true
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 Ext.draw.Sprite to apply custom\nstyles to markers and series.
An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback functions are:
\n\n
<li>itemmouseover</li>\n <li>itemmouseout</li>\n <li>itemmousedown</li>\n <li>itemmouseup</li>\n
\n\n\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": "
The display style for the markers. Only used if showMarkers 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:
\n\n markerConfig: {\n type: 'circle',\n radius: 4,\n 'fill': '#f00'\n }\n
\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": "Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using PieSeries width variable pie slice lengths.\nDefault value: 50.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 54, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-minMargin", - "shortDoc": "Specifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using P..." - }, - { - "tagname": "cfg", - "name": "orientation", - "member": "Ext.chart.Label", - "type": "String", - "doc": "Either \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", - "linenr": 67, - "html_filename": "Label2.html", - "href": "Label2.html#Ext-chart-Label-cfg-orientation" - }, - { - "tagname": "cfg", - "name": "renderer", - "member": "Ext.chart.series.Series", - "type": "Function", - "doc": "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.
\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": "The offset distance from the cursor position to the line series to trigger events (then used for highlighting series, etc).
\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": "An array with shadow attributes
\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": "Whether to show this series in the legend.
\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": "Whether markers should be displayed at the data points along the line. If true,\nthen the markerConfig config item will determine the markers' styling.
\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": "If true, the line will be smoothed/rounded around its points, otherwise straight line\nsegments will be drawn. Defaults to false.
\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": "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.
\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": "Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with Ext.tip.ToolTip. For example:
\n\ntips: {\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
\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": "The human-readable name of the series.
\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": "The type of series. Set in subclasses.
\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" - }, - "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": "Adds the specified events to the list of events which this Observable may fire.
\n", - "params": [ - { - "type": "Object/String", - "name": "o", - "doc": "Either an object with event names as properties with a value of true
\nor the first event name string if multiple event names are being passed as separate parameters.
[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\n\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "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": "Adds the specified events to the list of events which this Observable may fire.
\n" - }, - { - "tagname": "method", - "name": "addListener", - "member": "Ext.util.Observable", - "doc": "Appends an event handler to this object.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to listen for. May also be an object who's property names are event names. See
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:
this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.This option is useful during Component construction to add DOM event listeners to elements of Components which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n
new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
\n\n\nWhen added in this way, the options available are the options applicable to Ext.core.Element.addListener
\n\n\n\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});
\n\nAttaching multiple handlers in 1 call
\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
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
.\n\n\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "
Appends an event handler to this object.
\n" - }, - { - "tagname": "method", - "name": "addManagedListener", - "member": "Ext.util.Observable", - "doc": "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": "
The item to which to add a listener/listeners.
\n", - "optional": false - }, - { - "type": "Object/String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename
parameter was an event name, this\nis the handler function.
Optional. If the ename
parameter was an event name, this\nis the scope (this
reference) in which the handler function is executed.
Optional. If the ename
parameter was an event name, this\nis the addListener options.
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": "
Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to capture events from.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "The function to call when an event is fired.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this
reference) in which the function is executed. Defaults to the Observable firing the event.
Removes all listeners for this object including the managed listeners
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Removes all listeners for this object including the managed listeners
\n" - }, - { - "tagname": "method", - "name": "clearManagedListeners", - "member": "Ext.util.Observable", - "doc": "Removes all managed listeners for this object.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Removes all managed listeners for this object.
\n" - }, - { - "tagname": "method", - "name": "drawSeries", - "member": "Ext.chart.series.Line", - "doc": "Draws the series for the current chart.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Draws the series for the current chart.
\n" - }, - { - "tagname": "method", - "name": "enableBubble", - "member": "Ext.util.Observable", - "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget()
if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.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
\n\n",
- "params": [
- {
- "type": "String/Array",
- "name": "events",
- "doc": "The event name to bubble, or an Array of event names.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Fires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to fire.
\n", - "optional": false - }, - { - "type": "Object...", - "name": "args", - "doc": "Variable number of parameters are passed to handlers.
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" - }, - "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": "For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.
\n", - "params": [ - { - "type": "Number", - "name": "x", - "doc": "\n", - "optional": false - }, - { - "type": "Number", - "name": "y", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "An object describing the item, or null if there is no matching item. The exact contents of
\n\n 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
\n"
- },
- "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": "For a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.
\n" - }, - { - "tagname": "method", - "name": "getLegendColor", - "member": "Ext.chart.series.Series", - "doc": "Returns a string with the color to be used for the series legend item.
\n", - "params": [ - { - "type": "Object", - "name": "index", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Returns a string with the color to be used for the series legend item.
\n" - }, - { - "tagname": "method", - "name": "hasListener", - "member": "Ext.util.Observable", - "doc": "Checks to see if this object has any listeners for a specified event
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to check for
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "True if the event is being listened for, else false
\n" - }, - "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": "Checks to see if this object has any listeners for a specified event
\n" - }, - { - "tagname": "method", - "name": "hideAll", - "member": "Ext.chart.series.Series", - "doc": "Hides all the elements in the series.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Hides all the elements in the series.
\n" - }, - { - "tagname": "method", - "name": "highlightItem", - "member": "Ext.chart.Highlight", - "doc": "Highlight the given series item.
\n", - "params": [ - { - "type": "Object", - "name": "item", - "doc": "Info about the item; same format as returned by #getItemForPoint.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Highlight the given series item.
\n" - }, - { - "tagname": "method", - "name": "observe", - "member": "Ext.util.Observable", - "doc": "Sets observability on the passed class constructor.
\n\nThis makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.
\n\nUsage:
\n\nExt.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
\n",
- "params": [
- {
- "type": "Function",
- "name": "c",
- "doc": "The class constructor to make observable.
\n", - "optional": false - }, - { - "type": "Object", - "name": "listeners", - "doc": "An object containing a series of listeners to add. See addListener.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Appends an event handler to this object (shorthand for addListener.)
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event to listen for
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Appends an event handler to this object (shorthand for addListener.)
\n" - }, - { - "tagname": "method", - "name": "relayEvents", - "member": "Ext.util.Observable", - "doc": "Relays selected events from the specified Observable as if the events were fired by this
.
The Observable whose events this object is to relay.
\n", - "optional": false - }, - { - "type": "Array", - "name": "events", - "doc": "Array of event names to relay.
\n", - "optional": false - }, - { - "type": "Object", - "name": "prefix", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Relays selected events from the specified Observable as if the events were fired by this
.
Removes all added captures from the Observable.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to release
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Removes all added captures from the Observable.
\n" - }, - { - "tagname": "method", - "name": "removeListener", - "member": "Ext.util.Observable", - "doc": "Removes an event handler.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event the handler was associated with.
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Removes an event handler.
\n" - }, - { - "tagname": "method", - "name": "removeManagedListener", - "member": "Ext.util.Observable", - "doc": "Removes listeners that were added by the mon method.
\n", - "params": [ - { - "type": "Observable|Element", - "name": "item", - "doc": "The item from which to remove a listener/listeners.
\n", - "optional": false - }, - { - "type": "Object|String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename
parameter was an event name, this\nis the handler function.
Optional. If the ename
parameter was an event name, this\nis the scope (this
reference) in which the handler function is executed.
Removes listeners that were added by the mon method.
\n" - }, - { - "tagname": "method", - "name": "resumeEvents", - "member": "Ext.util.Observable", - "doc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended
parameter, then all\nevents fired during event suspension will be sent to any listeners now.
Changes the value of the title for the series.\nArguments can take two forms:
\n\nShows all the elements in the series.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Shows all the elements in the series.
\n" - }, - { - "tagname": "method", - "name": "suspendEvents", - "member": "Ext.util.Observable", - "doc": "Suspend the firing of all events. (see resumeEvents)
\n", - "params": [ - { - "type": "Boolean", - "name": "queueSuspended", - "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Suspend the firing of all events. (see resumeEvents)
\n" - }, - { - "tagname": "method", - "name": "un", - "member": "Ext.util.Observable", - "doc": "Removes an event handler (shorthand for removeListener.)
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event the handler was associated with.
\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Removes an event handler (shorthand for removeListener.)
\n" - }, - { - "tagname": "method", - "name": "unHighlightItem", - "member": "Ext.chart.Highlight", - "doc": "Un-highlight any existing highlights
\n", - "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": "Un-highlight any existing highlights
\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "axis", - "member": "Ext.chart.series.Cartesian", - "type": "String", - "doc": "Indicates which axis the series will bind to
\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": "Highlight the given series item.
\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": "The field used to access the x axis value from the items from the data\nsource.
\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": "The field used to access the y-axis value from the items from the data\nsource.
\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": "Fires when the series title is changed via setTitle.
\n", - "params": [ - { - "type": "String", - "name": "title", - "doc": "The new title value
\n", - "optional": false - }, - { - "type": "Number", - "name": "index", - "doc": "The index in the collection of titles
\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": "Fires when the series title is changed via setTitle.
\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": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.chart.series.Series", - "Ext.chart.series.Cartesian" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - "Ext.util.Observable", - "Ext.chart.Label", - "Ext.chart.Highlight", - "Ext.chart.Tip", - "Ext.chart.Callout" - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_chart_series_Line({"tagname":"class","html":"Alternate names
Ext.chart.LineSeriesExt.chart.LineChartHierarchy
Ext.BaseExt.chart.series.SeriesExt.chart.series.CartesianExt.chart.series.LineMixins
Requires
Files
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 series Chart array configuration. See the Chart\ndocumentation for more information. A typical configuration object for the line series could be:
\n\nvar store = Ext.create('Ext.data.JsonStore', {\n fields: ['name', 'data1', 'data2', 'data3', 'data4', 'data5'],\n data: [\n { 'name': 'metric one', 'data1': 10, 'data2': 12, 'data3': 14, 'data4': 8, 'data5': 13 },\n { 'name': 'metric two', 'data1': 7, 'data2': 8, 'data3': 16, 'data4': 10, 'data5': 3 },\n { 'name': 'metric three', 'data1': 5, 'data2': 2, 'data3': 14, 'data4': 12, 'data5': 7 },\n { 'name': 'metric four', 'data1': 2, 'data2': 14, 'data3': 6, 'data4': 1, 'data5': 23 },\n { 'name': 'metric five', 'data1': 4, 'data2': 4, '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 {\n type: 'Numeric',\n position: 'left',\n fields: ['data1', 'data2'],\n label: {\n renderer: Ext.util.Format.numberRenderer('0,0')\n },\n title: 'Sample Values',\n grid: true,\n minimum: 0\n },\n {\n type: 'Category',\n position: 'bottom',\n fields: ['name'],\n title: 'Sample Metrics'\n }\n ],\n series: [\n {\n type: 'line',\n highlight: {\n size: 7,\n radius: 7\n },\n axis: 'left',\n xField: 'name',\n yField: 'data1',\n markerConfig: {\n type: 'cross',\n size: 4,\n radius: 4,\n 'stroke-width': 0\n }\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: 'data2',\n markerConfig: {\n type: 'circle',\n size: 4,\n radius: 4,\n 'stroke-width': 0\n }\n }\n ]\n});\n
\n\nIn this configuration we're adding two series (or lines), one bound to the data1
\nproperty of the store and the other to data3
. The type for both configurations is\nline
. The xField
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 fill=true
which means that the line will also\nhave an area below it of the same color.
Note: 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 axis
configuration property.
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.
\nIf set to true
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 Ext.draw.Sprite to apply custom\nstyles to markers and series.
Object with the following properties:
\n\ndisplay : String
\n\nSpecifies the presence and position of labels for each pie slice. Either \"rotate\", \"middle\", \"insideStart\",\n\"insideEnd\", \"outside\", \"over\", \"under\", or \"none\" to prevent label rendering.\nDefault value: 'none'.
color : String
\n\nThe color of the label text.\nDefault value: '#000' (black).
contrast : Boolean
\n\nTrue to render the label in contrasting color with the backround.\nDefault value: false.
field : String
\n\nThe name of the field to be displayed in the label.\nDefault value: 'name'.
minMargin : Number
\n\nSpecifies the minimum distance from a label to the origin of the visualization.\nThis parameter is useful when using PieSeries width variable pie slice lengths.\nDefault value: 50.
font : String
\n\nThe font used for the labels.\nDefault value: \"11px Helvetica, sans-serif\".
orientation : String
\n\nEither \"horizontal\" or \"vertical\".\nDafault value: \"horizontal\".
renderer : Function
\n\nOptional function for formatting the label into a displayable value.\nDefault value: function(v) { return v; }
An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback functions are:
\n\nThe display style for the markers. Only used if showMarkers 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:
\n\n markerConfig: {\n type: 'circle',\n radius: 4,\n 'fill': '#f00'\n }\n
\n\nDefaults to: {}
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.
\nThe offset distance from the cursor position to the line series to trigger events (then used for highlighting series, etc).
\nDefaults to: 20
Whether to show this series in the legend.
\nDefaults to: true
Whether markers should be displayed at the data points along the line. If true,\nthen the markerConfig config item will determine the markers' styling.
\nDefaults to: true
If set to true
or a non-zero number, the line will be smoothed/rounded around its points; otherwise\nstraight line segments will be drawn.
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.
\n\nIf set to true
then a default numeric value of 3 will be used. Defaults to false
.
Defaults to: false
An object containing style properties for the visualization lines and fill.\nThese styles will override the theme styles. The following are valid style properties:
\n\nstroke
- an rgb or hex color string for the background color of the linestroke-width
- the width of the stroke (integer)fill
- the background fill color string (hex or rgb), only works if fill is true
opacity
- the opacity of the line and the fill color (decimal)Example usage:
\n\nstyle: {\n stroke: '#00ff00',\n 'stroke-width': 10,\n fill: '#80A080',\n opacity: 0.2\n}\n
\nDefaults to: {}
Add tooltips to the visualization's markers. The options for the tips are the\nsame configuration used with Ext.tip.ToolTip. For example:
\n\ntips: {\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
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nAdds the specified events to the list of events which this Observable may fire.
\nEither an object with event names as properties with a value of true
or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.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
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Call the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRemoves all listeners for this object including the managed listeners
\nIterate over each of the records for this series. The default implementation simply iterates\nthrough the entire data store, but individual series implementations can override this to\nprovide custom handling, e.g. adding/removing records.
\nIterates over a given record's values for each of this series's yFields,\nexecuting a given function for each value. Any yFields that have been combined\nvia legend drag-drop will be treated as a single value.
\nEnables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.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
\nFires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nFor a given x/y point relative to the Surface, find a corresponding item from this\nseries, if any.
\nAn object describing the item, or null if there is no matching item.\nThe exact contents of this object will vary by series type, but should always contain the following:
\nthe Series object to which the item belongs
\nthe value(s) of the item's data point
\nthe x/y coordinates relative to the chart box of a single point\nfor this data item, which can be used as e.g. a tooltip anchor point.
\nthe item's rendering Sprite.
\nCalculate the min and max values for this series's yField(s). Takes into account yField\ncombinations, exclusions, and stacking.
\n[min, max]
\nReturn the number of records being displayed in this series. Defaults to the number of\nrecords in the store; individual series implementations can override to provide custom handling.
\nReturns an array of functions, each of which returns the value of the yField\ncorresponding to function's index in the array, for a given record (each function takes the\nrecord as its only argument.) If yFields have been combined by the user via legend drag-drop,\nthis list of accessors will be kept in sync with those combinations.
\narray of accessor functions
\nReturns the number of yField values, taking into account fields combined\nvia legend drag-drop.
\nHighlight the given series item.
\nInfo about the item; same format as returned by #getItemForPoint.
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nDetermines whether the series item at the given index has been excluded, i.e. toggled off in the legend.
\nShorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.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
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the queueSuspended
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Changes the value of the title for the series.\nArguments can take two forms:
\n\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nSuspends the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\nShorthand for removeListener.
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\nFires when the series title is changed via setTitle.
\nThe new title value
\nThe index in the collection of titles
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\n