X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.chart.series.Gauge.js?ds=sidebyside diff --git a/docs/output/Ext.chart.series.Gauge.js b/docs/output/Ext.chart.series.Gauge.js new file mode 100644 index 00000000..5e3b1b6a --- /dev/null +++ b/docs/output/Ext.chart.series.Gauge.js @@ -0,0 +1,1122 @@ +Ext.data.JsonP.Ext_chart_series_Gauge({ + "tagname": "class", + "name": "Ext.chart.series.Gauge", + "doc": "

Creates a Gauge Chart. Gauge Charts are used to show progress in a certain variable. There are two ways of using the Gauge chart.\nOne is setting a store element into the Gauge and selecting the field to be used from that store. Another one is instanciating the\nvisualization and using the setValue method to adjust the value you want.

\n\n

A chart/series configuration for the Gauge visualization could look like this:

\n\n
{\n    xtype: 'chart',\n    store: store,\n    axes: [{\n        type: 'gauge',\n        position: 'gauge',\n        minimum: 0,\n        maximum: 100,\n        steps: 10,\n        margin: -10\n    }],\n    series: [{\n        type: 'gauge',\n        field: 'data1',\n        donut: false,\n        colorSet: ['#F49D10', '#ddd']\n    }]\n}\n
\n\n

In this configuration we create a special Gauge axis to be used with the gauge visualization (describing half-circle markers), and also we're\nsetting a maximum, minimum and steps configuration options into the axis. The Gauge series configuration contains the store field to be bound to\nthe visual display and the color set to be used with the visualization.

\n", + "extends": "Ext.chart.series.Series", + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": "gauge", + "author": null, + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + { + "tagname": "cfg", + "name": "angleField", + "member": "Ext.chart.series.Gauge", + "type": "String", + "doc": "

The store record field name to be used for the pie angles.\nThe values bound to this field name must be positive real numbers.\nThis parameter is required.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Gauge.js", + "linenr": 55, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-cfg-angleField", + "shortDoc": "The store record field name to be used for the pie angles.\nThe values bound to this field name must be positive real ..." + }, + { + "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": "donut", + "member": "Ext.chart.series.Gauge", + "type": "Boolean|Number", + "doc": "

Use the entire disk or just a fraction of it for the gauge. Default's false.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Gauge.js", + "linenr": 69, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-cfg-donut" + }, + { + "tagname": "cfg", + "name": "field", + "member": "Ext.chart.Label", + "type": "String", + "doc": "

The name of the field to be displayed in the label.\nDefault value: 'name'.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", + "linenr": 48, + "html_filename": "Label2.html", + "href": "Label2.html#Ext-chart-Label-cfg-field" + }, + { + "tagname": "cfg", + "name": "font", + "member": "Ext.chart.Label", + "type": "String", + "doc": "

The font used for the labels.\nDefautl value: \"11px Helvetica, sans-serif\".

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/Label.js", + "linenr": 61, + "html_filename": "Label2.html", + "href": "Label2.html#Ext-chart-Label-cfg-font" + }, + { + "tagname": "cfg", + "name": "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.

\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": "highlightDuration", + "member": "Ext.chart.series.Gauge", + "type": "Number", + "doc": "

The duration for the pie slice highlight effect.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Gauge.js", + "linenr": 49, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-cfg-highlightDuration" + }, + { + "tagname": "cfg", + "name": "listeners", + "member": "Ext.chart.series.Series", + "type": "Object", + "doc": "

An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback functions are:

\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": "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": "needle", + "member": "Ext.chart.series.Gauge", + "type": "Boolean", + "doc": "

Use the Gauge Series as an area series or add a needle to it. Default's false.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Gauge.js", + "linenr": 63, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-cfg-needle" + }, + { + "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": "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.Gauge", + "type": "Boolean", + "doc": "

Whether to add the pie chart elements as legend items. Default's false.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Gauge.js", + "linenr": 75, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-cfg-showInLegend" + }, + { + "tagname": "cfg", + "name": "style", + "member": "Ext.chart.series.Gauge", + "type": "Object", + "doc": "

An object containing styles for overriding series styles from Theming.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Gauge.js", + "linenr": 81, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-cfg-style" + }, + { + "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\n
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
\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": "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.

\n", + "optional": false + }, + { + "type": "String", + "name": "", + "doc": "

[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:

\n\n
this.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.

\n", + "optional": true + }, + { + "type": "Object", + "name": "options", + "doc": "

(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:


\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.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", + "optional": false + }, + { + "type": "Object", + "name": "opt", + "doc": "

Optional. If the ename parameter was an event name, this\nis the addListener options.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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": "

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.

\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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": "

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.Gauge", + "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/Gauge.js", + "linenr": 232, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-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.

\n\n\n

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\n

Example:

\n\n\n
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
\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\n

An 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.Gauge", + "doc": "

Returns the color of the series (to be displayed as color for the series legend item).

\n", + "params": [ + { + "type": "Object", + "name": "item", + "doc": "

{Object} 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/series/Gauge.js", + "linenr": 445, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-method-getLegendColor", + "shortDoc": "

Returns the color of the series (to be displayed as color 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\n

This 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\n

Usage:

\n\n
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
\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.

\n", + "optional": true + }, + { + "type": "Object", + "name": "options", + "doc": "

(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.

\n", + "params": [ + { + "type": "Object", + "name": "origin", + "doc": "

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.

\n" + }, + { + "tagname": "method", + "name": "releaseCapture", + "member": "Ext.util.Observable", + "doc": "

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.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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": "

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.

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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": "

Changes the value of the title for the series.\nArguments can take two forms:

\n\n\n\n", + "params": [ + { + "type": "Number", + "name": "index", + "doc": "\n", + "optional": false + }, + { + "type": "String", + "name": "title", + "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": 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": "setValue", + "member": "Ext.chart.series.Gauge", + "doc": "

Sets the Gauge chart to the current specified value.

\n", + "params": [ + { + "type": "Object", + "name": "value", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/chart/series/Gauge.js", + "linenr": 410, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge-method-setValue", + "shortDoc": "

Sets the Gauge chart to the current specified value.

\n" + }, + { + "tagname": "method", + "name": "showAll", + "member": "Ext.chart.series.Series", + "doc": "

Shows 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": "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" + } + ], + "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/Gauge.js", + "linenr": 1, + "html_filename": "Gauge2.html", + "href": "Gauge2.html#Ext-chart-series-Gauge", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + "Ext.chart.series.Series" + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + "Ext.util.Observable", + "Ext.chart.Label", + "Ext.chart.Highlight", + "Ext.chart.Tip", + "Ext.chart.Callout" + ] +}); \ No newline at end of file