X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6a7e4474cba9d8be4b2ec445e10f1691f7277c50..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/api/Ext.chart.series.Series.html diff --git a/docs/api/Ext.chart.series.Series.html b/docs/api/Ext.chart.series.Series.html new file mode 100644 index 00000000..2ac8fa8e --- /dev/null +++ b/docs/api/Ext.chart.series.Series.html @@ -0,0 +1,456 @@ +
Mixins
Series is the abstract class containing the common logic to all chart series. Series includes +methods from Labels, Highlights, Tips and Callouts mixins. This class implements the logic of handling +mouse events, animating, hiding, showing all elements and returning the color of the series to be used as a legend item.
+ +The series class supports listeners via the Observable syntax. Some of these listeners are:
+ +itemmouseup
When the user interacts with a marker.itemmousedown
When the user interacts with a marker.itemmousemove
When the user iteracts with a marker.afterrender
Will be triggered when the animation ends or when the series has been rendered completely.For example:
+ +series: [{
+ type: 'column',
+ axis: 'left',
+ listeners: {
+ 'afterrender': function() {
+ console('afterrender');
+ }
+ },
+ xField: 'category',
+ yField: 'data1'
+}]
+
+The color of the label text. +Default value: '#000' (black).
+The color of the label text. +Default value: '#000' (black).
+Specifies the presence and position of labels for each pie slice. Either "rotate", "middle", "insideStart", +"insideEnd", "outside", "over", "under", or "none" to prevent label rendering. +Default value: 'none'.
+The name of the field to be displayed in the label. +Default value: 'name'.
+The name of the field to be displayed in the label. +Default value: 'name'.
+The font used for the labels. +Defautl value: "11px Helvetica, sans-serif".
+The font used for the labels. +Defautl value: "11px Helvetica, sans-serif".
+If set to true
it will highlight the markers or the series when hovering
+with the mouse. This parameter can also be an object with the same style
+properties you would apply to a Ext.draw.Sprite to apply custom
+styles to markers and series.
An (optional) object with event callbacks. All event callbacks get the target item as first parameter. The callback functions are:
+ +
<li>itemmouseover</li>
+ <li>itemmouseout</li>
+ <li>itemmousedown</li>
+ <li>itemmouseup</li>
+
+
++
Specifies the minimum distance from a label to the origin of the visualization. +This parameter is useful when using PieSeries width variable pie slice lengths. +Default value: 50.
+Either "horizontal" or "vertical". +Dafault value: "horizontal".
+Either "horizontal" or "vertical". +Dafault value: "horizontal".
+A function that can be overridden to set custom styling properties to each rendered element. +Passes in (sprite, record, attributes, index, store) to the function.
+Add tooltips to the visualization's markers. The options for the tips are the +same configuration used with Ext.tip.ToolTip. For example:
+ +tips: {
+ trackMouse: true,
+ width: 140,
+ height: 28,
+ renderer: function(storeItem, item) {
+ this.setTitle(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');
+ }
+},
+
+Adds the specified events to the list of events which this Observable may fire.
+Adds the specified events to the list of events which this Observable may fire.
+Either an object with event names as properties with a value of true
+or 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. +Usage:
+ +this.addEvents('storeloaded', 'storecleared');
+
+
+Appends an event handler to this object.
+Appends an event handler to this object.
+The name of the event to listen for. May also be an object who's property names are event names. See
+The method the event invokes.
+(optional) The scope (this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration. +properties. This may contain any of the following properties:
this
reference) in which the handler function is executed.
+If 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 +will exist only after the Component is rendered. For example, to add a click listener to a Panel's body: +
new Ext.panel.Panel({
+ title: 'The title',
+ listeners: {
+ click: this.handlePanelClick,
+ element: 'body'
+ }
+});
+
+
+
+When added in this way, the options available are the options applicable to Ext.core.Element.addListener
+ + +
+Combining Options
+Using the options argument, it is possible to combine different types of listeners:
+
+A delayed, one-time listener.
+
myPanel.on('hide', this.handleClick, this, {
+single: true,
+delay: 100
+});
+
+Attaching multiple handlers in 1 call
+The method also allows for a single argument to be passed which is a config object containing properties
+which specify multiple events. For example:
+
myGridPanel.on({
+ cellClick: this.onCellClick,
+ mouseover: this.onMouseOver,
+ mouseout: this.onMouseOut,
+ scope: this // Important. Ensure "this" is correct during handler execution
+});
+
.
++ +
Adds listeners to any Observable object (or Element) which are automatically removed when this Component +is destroyed. + +
Adds listeners to any Observable object (or Element) which are automatically removed when this Component +is destroyed. + +
The item to which to add a listener/listeners.
+The event name, or an object containing event name properties.
+Optional. If the ename
parameter was an event name, this
+is the handler function.
Optional. If the ename
parameter was an event name, this
+is the scope (this
reference) in which the handler function is executed.
Optional. If the ename
parameter was an event name, this
+is the addListener options.
Starts capture on the specified Observable. All events will be passed +to the supplied function with the event name + standard signature of the event +before the event is fired. If the supplied function returns false, +the event will not fire.
+The Observable to capture events from.
+The function to call when an event is fired.
+(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
+Removes all listeners for this object including the managed listeners
+Removes all managed listeners for this object.
+Removes all managed listeners for this object.
+Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.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 +implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to +access the required target more quickly.
+ + +Example:
+ + +Ext.override(Ext.form.field.Base, {
+// Add functionality to Field's initComponent to enable the change event to bubble
+initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
+ this.enableBubble('change');
+}),
+
+// We know that we want Field's events to bubble directly to the FormPanel.
+getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+}
+});
+
+var myForm = new Ext.formPanel({
+title: 'User Details',
+items: [{
+ ...
+}],
+listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+}
+});
+
+
+The event name to bubble, or an Array of event names.
+Fires the specified event with the passed parameters (minus the event name).
+ + +An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) +by calling enableBubble.
+ +The name of the event to fire.
+Variable number of parameters are passed to handlers.
+returns false if any of the handlers return false otherwise it returns true.
+For a given x/y point relative to the Surface, find a corresponding item from this +series, if any.
+For a given x/y point relative to the Surface, find a corresponding item from this +series, if any.
+An object describing the item, or null if there is no matching item. The exact contents of
+ + this object will vary by series type, but should always contain at least the following:
+ <ul>
+ <li>{Ext.chart.series.Series} series - the Series object to which the item belongs</li>
+ <li>{Object} value - the value(s) of the item's data point</li>
+ <li>{Array} point - the x/y coordinates relative to the chart box of a single point
+ for this data item, which can be used as e.g. a tooltip anchor point.</li>
+ <li>{Ext.draw.Sprite} sprite - the item's rendering Sprite.
+ </ul>
+
+Returns a string with the color to be used for the series legend item.
+Returns a string with the color to be used for the series legend item.
+Checks to see if this object has any listeners for a specified event
+Checks to see if this object has any listeners for a specified event
+The name of the event to check for
+True if the event is being listened for, else false
+Highlight the given series item.
+Highlight the given series item.
+Info about the item; same format as returned by #getItemForPoint.
+Sets observability on the passed class constructor.
+ +This makes any event fired on any instance of the passed class also fire a single event through +the class allowing for central handling of events on many instances at once.
+ +Usage:
+ +Ext.util.Observable.observe(Ext.data.Connection);
+Ext.data.Connection.on('beforerequest', function(con, options) {
+ console.log('Ajax request made to ' + options.url);
+});
+
+The class constructor to make observable.
+An object containing a series of listeners to add. See addListener.
+Appends an event handler to this object (shorthand for addListener.)
+Appends an event handler to this object (shorthand for addListener.)
+The type of event to listen for
+The method the event invokes
+(optional) The scope (this
reference) in which the handler function is executed.
+If omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
+Relays selected events from the specified Observable as if the events were fired by this
.
Relays selected events from the specified Observable as if the events were fired by this
.
The Observable whose events this object is to relay.
+Array of event names to relay.
+Removes all added captures from the Observable.
+Removes all added captures from the Observable.
+The Observable to release
+Removes an event handler.
+Removes an event handler.
+The type of event the handler was associated with.
+The handler to remove. This must be a reference to the function passed into the addListener call.
+(optional) The scope originally specified for the handler.
+Removes listeners that were added by the mon method.
+Removes listeners that were added by the mon method.
+The item from which to remove a listener/listeners.
+The event name, or an object containing event name properties.
+Optional. If the ename
parameter was an event name, this
+is the handler function.
Optional. If the ename
parameter was an event name, this
+is the scope (this
reference) in which the handler function is executed.
Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended
parameter, then all
+events fired during event suspension will be sent to any listeners now.
Changes the value of the title for the series. +Arguments can take two forms:
+ +Suspend the firing of all events. (see resumeEvents)
+Suspend the firing of all events. (see resumeEvents)
+Pass as true to queue up suspended events to be fired +after the resumeEvents call instead of discarding all suspended events;
+Removes an event handler (shorthand for removeListener.)
+Removes an event handler (shorthand for removeListener.)
+The type of event the handler was associated with.
+The handler to remove. This must be a reference to the function passed into the addListener call.
+(optional) The scope originally specified for the handler.
+