X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..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 @@ +Ext.chart.series.Series | Ext JS 4.0 Documentation +
For up to date documentation and features, visit +http://docs.sencha.com/ext-js/4-0

Sencha Documentation

+ + + + + +

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.

+ +

Listeners

+ +

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'
+}]
+
+
Defined By

Config Options

Other Configs

 

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", +"insideEn...

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

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

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

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, recor...

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.

+
 

An array with shadow attributes

+

An array with shadow attributes

+
 

Whether to show this series in the legend.

+

Whether to show this series in the legend.

+
 
Add tooltips to the visualization's markers. The options for the tips are the +same configuration used with Ext.tip.To...

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');
+  }
+},
+
+
 

The human-readable name of the series.

+

The human-readable name of the series.

+
 

The type of series. Set in subclasses.

+

The type of series. Set in subclasses.

+
Defined By

Properties

 

Highlight the given series item.

+

Highlight the given series item.

+
Defined By

Methods

 
addEvents( +Object/String o, String ) + : void

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.

+

Parameters

  • o : Object/String

    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.

    +
  • : String

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

    + +
    this.addEvents('storeloaded', 'storecleared');
    +
    + +

Returns

  • void    +
 
addListener( +String eventName, Function handler, [Object scope], [Object options]) + : void

Appends an event handler to this object.

+

Appends an event handler to this object.

+

Parameters

  • eventName : String

    The name of the event to listen for. May also be an object who's property names are event names. See

    +
  • handler : Function

    The method the event invokes.

    +
  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.

    +
  • options : Object

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

      +
    • scope : Object
      The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.
    • +
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
    • +
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
    • +
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed +by the specified number of milliseconds. If the event fires again within that time, the original +handler is not invoked, but the new handler is scheduled in its place.
    • +
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not +if the event was bubbled up from a child Observable.
    • +
    • element : String
      This option is only valid for listeners bound to Components. +The name of a Component property which references an element to add a listener to.

      + +

      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
    +});
    +
    . +

    + +

Returns

  • void    +
 
addManagedListener( +Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) + : void

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

Parameters

  • item : Observable/Element

    The item to which to add a listener/listeners.

    +
  • ename : Object/String

    The event name, or an object containing event name properties.

    +
  • fn : Function

    Optional. If the ename parameter was an event name, this +is the handler function.

    +
  • scope : Object

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

    +
  • opt : Object

    Optional. If the ename parameter was an event name, this +is the addListener options.

    +

Returns

  • void    +
 
capture( +Observable o, Function fn, [Object scope]) + : void
Starts capture on the specified Observable. All events will be passed +to the supplied function with the event name + ...

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.

+

Parameters

  • o : Observable

    The Observable to capture events from.

    +
  • fn : Function

    The function to call when an event is fired.

    +
  • scope : Object

    (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

    +

Returns

  • void    +
 

Removes all listeners for this object including the managed listeners

+

Removes all listeners for this object including the managed listeners

+

Returns

  • void    +
 

Removes all managed listeners for this object.

+

Removes all managed listeners for this object.

+

Returns

  • void    +
 
enableBubble( +String/Array events) + : void
Enables events fired by this Observable to bubble up an owner hierarchy by calling +this.getBubbleTarget() if present....

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');
+    }
+}
+});
+
+ +

Parameters

  • events : String/Array

    The event name to bubble, or an Array of event names.

    +

Returns

  • void    +
 
fireEvent( +String eventName, Object... args) + : Boolean
Fires the specified event with the passed parameters (minus the event name). + + +An event may be set to bubble up an Ob...

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.

+ +

Parameters

  • eventName : String

    The name of the event to fire.

    +
  • args : Object...

    Variable number of parameters are passed to handlers.

    +

Returns

  • Boolean   

    returns false if any of the handlers return false otherwise it returns true.

    +
 
getItemForPoint( +Number x, Number y) + : Object

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.

+

Parameters

  • x : Number
    +
  • y : Number
    +

Returns

  • Object   

    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.

+

Parameters

  • index : Object
    +

Returns

  • void    +
 
hasListener( +String eventName) + : Boolean

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

+

Parameters

  • eventName : String

    The name of the event to check for

    +

Returns

  • Boolean   

    True if the event is being listened for, else false

    +
 

Hides all the elements in the series.

+

Hides all the elements in the series.

+

Returns

  • void    +
 

Highlight the given series item.

+

Highlight the given series item.

+

Parameters

  • item : Object

    Info about the item; same format as returned by #getItemForPoint.

    +

Returns

  • void    +
 
observe( +Function c, Object listeners) + : void
Sets observability on the passed class constructor. + +This makes any event fired on any instance of the passed class a...

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);
+});
+
+

Parameters

  • c : Function

    The class constructor to make observable.

    +
  • listeners : Object

    An object containing a series of listeners to add. See addListener.

    +

Returns

  • void    +
 
on( +String eventName, Function handler, [Object scope], [Object options]) + : void

Appends an event handler to this object (shorthand for addListener.)

+

Appends an event handler to this object (shorthand for addListener.)

+

Parameters

  • eventName : String

    The type of event to listen for

    +
  • handler : Function

    The method the event invokes

    +
  • scope : Object

    (optional) The scope (this reference) in which the handler function is executed. +If omitted, defaults to the object which fired the event.

    +
  • options : Object

    (optional) An object containing handler configuration.

    +

Returns

  • void    +
 
relayEvents( +Object origin, Array events, Object prefix) + : void

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.

+

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

    +
  • events : Array

    Array of event names to relay.

    +
  • prefix : Object
    +

Returns

  • void    +
 

Removes all added captures from the Observable.

+

Removes all added captures from the Observable.

+

Parameters

  • o : Observable

    The Observable to release

    +

Returns

  • void    +
 
removeListener( +String eventName, Function handler, [Object scope]) + : void

Removes an event handler.

+

Removes an event handler.

+

Parameters

  • eventName : String

    The type of event the handler was associated with.

    +
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    +
  • scope : Object

    (optional) The scope originally specified for the handler.

    +

Returns

  • void    +
 
removeManagedListener( +Observable|Element item, Object|String ename, Function fn, Object scope) + : void

Removes listeners that were added by the mon method.

+

Removes listeners that were added by the mon method.

+

Parameters

  • item : Observable|Element

    The item from which to remove a listener/listeners.

    +
  • ename : Object|String

    The event name, or an object containing event name properties.

    +
  • fn : Function

    Optional. If the ename parameter was an event name, this +is the handler function.

    +
  • scope : Object

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

    +

Returns

  • void    +
 
Resume firing events. (see suspendEvents) +If events were suspended using the queueSuspended parameter, then all +event...

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.

+

Returns

  • void    +
 
setTitle( +Number index, String title) + : void
Changes the value of the title for the series. +Arguments can take two forms: + + +A single String value: this will be us...

Changes the value of the title for the series. +Arguments can take two forms:

+ +
    +
  • A single String value: this will be used as the new single title for the series (applies +to series with only one yField)
  • +
  • A numeric index and a String value: this will set the title for a single indexed yField.
  • +
+ +

Parameters

  • index : Number
    +
  • title : String
    +

Returns

  • void    +
 

Shows all the elements in the series.

+

Shows all the elements in the series.

+

Returns

  • void    +
 
suspendEvents( +Boolean queueSuspended) + : void

Suspend the firing of all events. (see resumeEvents)

+

Suspend the firing of all events. (see resumeEvents)

+

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired +after the resumeEvents call instead of discarding all suspended events;

    +

Returns

  • void    +
 
un( +String eventName, Function handler, [Object scope]) + : void

Removes an event handler (shorthand for removeListener.)

+

Removes an event handler (shorthand for removeListener.)

+

Parameters

  • eventName : String

    The type of event the handler was associated with.

    +
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    +
  • scope : Object

    (optional) The scope originally specified for the handler.

    +

Returns

  • void    +
 

Un-highlight any existing highlights

+

Un-highlight any existing highlights

+

Returns

  • void    +
Defined By

Events

 
titlechange( +String title, Number index) +

Fires when the series title is changed via setTitle.

+

Fires when the series title is changed via setTitle.

+

Parameters

  • title : String

    The new title value

    +
  • index : Number

    The index in the collection of titles

    +
\ No newline at end of file