Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext JS 6.0.2 - Modern Toolkit


top

Summary

The Ext.chart package provides the capability to visualize data. Each chart binds directly to a Ext.data.Store enabling automatic updates of the chart. A chart configuration object has some overall styling options as well as an array of axes and series. A chart instance example could look like this:

Ext.create('Ext.chart.CartesianChart', {
    width: 800,
    height: 600,
    animation: {
        easing: 'backOut',
        duration: 500
    },
    store: store1,
    legend: {
        position: 'right'
    },
    axes: [
        // ...some axes options...
    ],
    series: [
        // ...some series options...
    ]
});

In this example we set the width and height of a chart; We decide whether our series are animated or not and we select a store to be bound to the chart; We also set the legend to the right part of the chart.

You can register certain interactions such as Ext.chart.interactions.PanZoom on the chart by specify an array of names or more specific config objects. All the events will be wired automatically.

You can also listen to series itemXXX events on both chart and series level.

For example:

Ext.create('Ext.chart.CartesianChart', {
    plugins: {
        ptype: 'chartitemevents',
        moveEvents: true
    },
    store: {
        fields: ['pet', 'households', 'total'],
        data: [
            {pet: 'Cats', households: 38, total: 93},
            {pet: 'Dogs', households: 45, total: 79},
            {pet: 'Fish', households: 13, total: 171}
        ]
    },
    axes: [{
        type: 'numeric',
        position: 'left'
    }, {
        type: 'category',
        position: 'bottom'
    }],
    series: [{
        type: 'bar',
        xField: 'pet',
        yField: 'households',
        listeners: {
            itemmousemove: function (series, item, event) {
                console.log('itemmousemove', item.category, item.field);
            }
        }
    }, {
        type: 'line',
        xField: 'pet',
        yField: 'total',
        marker: true
    }],
    listeners: { // Listen to itemclick events on all series.
        itemclick: function (chart, item, event) {
            console.log('itemclick', item.category, item.field);
        }
    }
});

For more information about the axes and series configurations please check the documentation of each series (Line, Bar, Pie, etc).

No members found using the current filters

configs

Optional Configs

animation : Boolean / Object

true for the default animation (easing: 'ease' and duration: 500) or a standard animation config object to be used for default chart animations.

Defaults to:

!Ext.isIE8

getAnimation : Boolean / Object

Returns the value of animation

Returns

Boolean / Object

setAnimation (animation)

Sets the value of animation

Parameters

animation :  Boolean / Object

axes : Ext.chart.axis.Axis / Array / Object

Array of Ext.chart.axis.Axis instances or config objects. For example:

axes: [{
    type: 'numeric',
    position: 'left',
    title: 'Number of Hits',
    minimum: 0
}, {
    type: 'category',
    position: 'bottom',
    title: 'Month of the Year'
}]

Defaults to:

[]

getAxes : Ext.chart.axis.Axis / Array / Object

Returns the value of axes

Returns

Ext.chart.axis.Axis / Array / Object

setAxes (axes)

Sets the value of axes

Parameters

axes :  Ext.chart.axis.Axis / Array / Object

background : Object

Set the chart background. This can be a gradient object, image, or color.

For example, if background were to be a color we could set the object as

background: '#ccc'

You can specify an image by using:

background: {
    type: 'image',
    src: 'http://path.to.image/'
}

Also you can specify a gradient by using the gradient object syntax:

background: {
    type: 'linear',
    degrees: 0,
    stops: [
        {
            offset: 0,
            color: 'white'
        },
        {
            offset: 1,
            color: 'blue'
        }
    ]
}

Defaults to:

null

getBackground : Object

Returns the value of background

Returns

Object

setBackground (background)

Sets the value of background

Parameters

background :  Object

colors : Array

Array of colors/gradients to override the color of items and legends.

Defaults to:

null

getColors : Array

Returns the value of colors

Returns

Array

setColors (colors)

Sets the value of colors

Parameters

colors :  Array

engine : String

Defines the engine (type of surface) used to render draw container contents.

The render engine is selected automatically depending on the platform used. Priority is given to the Ext.draw.engine.Canvas engine due to its performance advantage.

You may also set the engine config to be Ext.draw.engine.Svg if so desired.

Defaults to:

"Ext.draw.engine.Canvas"

gradients : Object[]

Defines a set of gradients that can be used as color properties (fillStyle and strokeStyle, but not shadowColor) in sprites. The gradients array is an array of objects with the following properties:

  • id - string - The unique name of the gradient.
  • type - string, optional - The type of the gradient. Available types are: 'linear', 'radial'. Defaults to 'linear'.
  • angle - number, optional - The angle of the gradient in degrees.
  • stops - array - An array of objects with 'color' and 'offset' properties, where 'offset' is a real number from 0 to 1.

For example:

gradients: [{
    id: 'gradientId1',
    type: 'linear',
    angle: 45,
    stops: [{
        offset: 0,
        color: 'red'
    }, {
       offset: 1,
       color: 'yellow'
    }]
}, {
   id: 'gradientId2',
   type: 'radial',
   stops: [{
       offset: 0,
       color: '#555',
   }, {
       offset: 1,
       color: '#ddd',
   }]
}]

Then the sprites can use 'gradientId1' and 'gradientId2' by setting the color attributes to those ids, for example:

sprite.setAttributes({
    fillStyle: 'url(#gradientId1)',
    strokeStyle: 'url(#gradientId2)'
});

Defaults to:

[]

getGradients : Object[]

Returns the value of gradients

Returns

Object[]

setGradients (gradients)

Sets the value of gradients

Parameters

gradients :  Object[]

highlightItem : Object

The current highlight item in the chart. The object must be the one that you get from item events.

Note that series can also own highlight items. This notion is separate from this one and should not be used at the same time.

Defaults to:

null

getHighlightItem : Object

Returns the value of highlightItem

Returns

Object

setHighlightItem (highlightItem)

Sets the value of highlightItem

Parameters

highlightItem :  Object

insetPadding : Object / Number / String

The amount of inset padding in pixels for the chart. Inset padding is the padding from the boundary of the chart to any of its contents.

Defaults to:

{
    top: 10,
    left: 10,
    right: 10,
    bottom: 10
}

getInsetPadding : Object / Number / String

Returns the value of insetPadding

Returns

Object / Number / String

setInsetPadding (insetPadding)

Sets the value of insetPadding

Parameters

insetPadding :  Object / Number / String

interactions : Array

Interactions are optional modules that can be plugged in to a chart to allow the user to interact with the chart and its data in special ways. The interactions config takes an Array of Object configurations, each one corresponding to a particular interaction class identified by a type property:

new Ext.chart.AbstractChart({
    renderTo: Ext.getBody(),
    width: 800,
    height: 600,
    store: store1,
    axes: [
        // ...some axes options...
    ],
    series: [
        // ...some series options...
    ],
    interactions: [{
        type: 'interactiontype'
        // ...additional configs for the interaction...
    }]
});

When adding an interaction which uses only its default configuration (no extra properties other than type), you can alternately specify only the type as a String rather than the full Object:

interactions: ['reset', 'rotate']

The current supported interaction types include:

See the documentation for each of those interaction classes to see how they can be configured.

Additional custom interactions can be registered using 'interactions.' alias prefix.

Defaults to:

[]

getInteractions : Array

Returns the value of interactions

Returns

Array

setInteractions (interactions)

Sets the value of interactions

Parameters

interactions :  Array

legend : Ext.chart.Legend / Object

Defaults to:

null

getLegend : Ext.chart.Legend / Object

Returns the value of legend

Returns

Ext.chart.Legend / Object

setLegend (legend)

Sets the value of legend

Parameters

legend :  Ext.chart.Legend / Object

mainRect
private pri

The main area of the chart where grid and series are drawn.

Defaults to:

null

getMainRect

Returns the value of mainRect

Returns

setMainRect (mainRect)

Sets the value of mainRect

Parameters

mainRect :  Object

resizeHandler
private pri

Override value.

Defaults to:

null

getResizeHandler

Returns the value of resizeHandler

Returns

setResizeHandler (resizeHandler)

Sets the value of resizeHandler

Parameters

resizeHandler :  Object

series : Ext.chart.series.Series / Array

Array of Ext.chart.series.Series instances or config objects. For example:

series: [{
    type: 'column',
    axis: 'left',
    listeners: {
        'afterrender': function() {
            console.log('afterrender');
        }
    },
    xField: 'category',
    yField: 'data1'
}]

Defaults to:

[]

getSeries : Ext.chart.series.Series / Array

Returns the value of series

Returns

Ext.chart.series.Series / Array

setSeries (series)

Sets the value of series

Parameters

series :  Ext.chart.series.Series / Array

sprites : Object[]

Defines a set of sprites to be added to the drawContainer surface.

For example:

 sprites: [{
      type: 'circle',
      fillStyle: '#79BB3F',
      r: 100,
      x: 100,
      y: 100
 }]

Defaults to:

null

getSprites : Object[]

Returns the value of sprites

Returns

Object[]

setSprites (sprites)

Sets the value of sprites

Parameters

sprites :  Object[]

store : Ext.data.Store / String / Object

The data source to which the chart is bound. Acceptable values for this property are:

  • any Ext.data.Store class / subclass
  • an ID of a store
  • a Ext.data.Store config object. When passing a config you can specify the store type by alias. Passing a config object with a store type will dynamically create a new store of that type when the chart is instantiated.

For example:

Ext.define('MyApp.store.Customer', {
    extend: 'Ext.data.Store',
    alias: 'store.customerstore',

    fields: ['name', 'value']
});


Ext.create({
    xtype: 'cartesian',
    renderTo: document.body,
    height: 400,
    width: 400,
    store: {
        type: 'customerstore',
        data: [{
            name: 'metric one',
            value: 10
        }]
    },
    axes: [{
        type: 'numeric',
        position: 'left',
        title: {
            text: 'Sample Values',
            fontSize: 15
        },
        fields: 'value'
    }, {
        type: 'category',
        position: 'bottom',
        title: {
            text: 'Sample Values',
            fontSize: 15
        },
        fields: 'name'
    }],
    series: {
        type: 'bar',
        xField: 'name',
        yField: 'value'
    }
});

Defaults to:

'ext-empty-store'

getStore : Ext.data.Store / String / Object

Returns the value of store

Returns

Ext.data.Store / String / Object

setStore (store)

Sets the value of store

Parameters

store :  Ext.data.Store / String / Object

style : Object

The style for the chart component.

Defaults to:

null

getStyle : Object

Returns the value of style

Returns

Object

setStyle (style)

Sets the value of style

Parameters

style :  Object

theme : String

The name of the theme to be used. A theme defines the colors and styles used by the series, axes, markers and other chart components. Please see the documentation for the Ext.chart.theme.Base class for more information. Possible theme values are:

  • 'green', 'sky', 'red', 'purple', 'blue', 'yellow'
  • 'category1' to 'category6'
  • and the above theme names with the '-gradients' suffix, e.g. 'green-gradients'

Defaults to:

"default"

getTheme : String

Returns the value of theme

Returns

String

setTheme (theme)

Sets the value of theme

Parameters

theme :  String

properties

Instance Properties

animationSuspendCount
private pri

Toggle for chart interactions that require animation to be suspended.

Defaults to:

0

defaultDownloadServerUrl : String

The default URL used by download.

Defaults to:

"http://svg.sencha.io"

isThicknessChanged
private pri

Indicates that thickness of one or more axes has changed, at the time of performLayout call. I.e. 'performLayout' should be called again when current layout is done.

Defaults to:

false

recordCount
private pri

The number of records in the chart's store last time the data was changed.

Defaults to:

0

supportedFormats : Array
private pri

A list of export types supported by the server.

Defaults to:

["png", "pdf", "jpeg", "gif"]

surfaceZIndexes
private pri

The z-indexes to use for the various surfaces

Defaults to:

{
    background: 0,
    main: 1,
    grid: 2,
    series: 3,
    axis: 4,
    chart: 5,
    overlay: 6,
    events: 7
}

methods

Instance Methods

addSeries ( newSeries )

Adds a Ext.chart.series.Series to this chart.

The Series (or array) passed will be added to the existing series. If an id is specified in a new Series, any existing Series of that id will be updated.

The chart will be redrawn in response to the change.

Parameters

newSeries :  Object/Object[]/Ext.chart.series.Series/Ext.chart.series.Series[]

A config object describing the Series to add, or an instantiated Series object. Or an array of these.

bindStore ( store )

Changes the data store bound to this chart and refreshes it.

Parameters

store :  Ext.data.Store

The store to bind to this chart.

download ( [config] ) : Boolean

Downloads an image or PDF of the chart / drawing or opens it in a separate browser tab/window if the download can't be triggered. The exact behavior is platform and browser specific. For more consistent results on mobile devices use the preview method instead. This method doesn't work in IE8.

Parameters

config :  Object (optional)

The following config options are supported:

url :  String

The url to post the data to. Defaults to the defaultDownloadServerUrl configuration on the class.

format :  String

The format of image to export. See the supportedFormats. Defaults to 'png' on the Sencha IO server. Note that you can't export to 'svg' format if the Ext.draw.engine.Canvas engine is used.

width :  Number

A width to send to the server for configuring the image width. Defaults to natural image width on the Sencha IO server.

height :  Number

A height to send to the server for configuring the image height. Defaults to natural image height on the Sencha IO server.

filename :  String

The filename of the downloaded image. Defaults to 'chart' on the Sencha IO server. The config.format is used as a filename extension.

scale :  Number

The scaling of the downloaded image. Defaults to 1 on the Sencha IO server. The server will try to determine the natural size of the image unless the width/height configs have been set. If the Ext.draw.engine.Canvas engine is used the natural image size will depend on the value of the window.devicePixelRatio. For example, for devices with devicePixelRatio of 2 the produced image will be two times larger than for devices with devicePixelRatio of 1 for the same drawing. This is done so that the users with devices with HiDPI screens get a downloaded image that looks as crisp on their device as the original drawing. If you want image size to be consistent across devices with different device pixel ratios, you can set the value of this config to 1/devicePixelRatio. This parameter is ignored by the Sencha IO server if config.format is set to 'svg'.

pdf :  Object

PDF specific options. This config is only used if config.format is set to 'pdf'. The given object should be in either this format:

{
  width: '200px',
  height: '300px',
  border: '0px'
}

or this format:

{
  format: 'A4',
  orientation: 'portrait',
  border: '1cm'
}

Supported dimension units are: 'mm', 'cm', 'in', 'px'. No unit means 'px'. Supported formats are: 'A3', 'A4', 'A5', 'Legal', 'Letter', 'Tabloid'. Orientation ('portrait', 'landscape') is optional and defaults to 'portrait'.

jpeg :  Object

JPEG specific options. This config is only used if config.format is set to 'jpeg'. The given object should be in this format:

{
  quality: 80
}

Where quality is an integer between 0 and 100.

Returns

:Boolean

True if request was successfully sent to the server.

getAxis ( axis ) : Ext.chart.axis.Axis

Returns an axis instance based on the type of data passed.

Parameters

axis :  String/Number/Ext.chart.axis.Axis

You may request an axis by passing an id, the number of the array key returned by getAxes, or an axis instance.

Returns

:Ext.chart.axis.Axis

The axis requested.

getChartSize ( isRecompute )
private pri

Cache chart size as element.getSize results in a relatively expensive call to getComputedStyle, which may slow the rendering of a frame by as much as 2%.

Parameters

isRecompute :  Object

getImage ( [format] ) : Object

Produces an image of the chart / drawing.

Parameters

format :  String (optional)

Possible options are 'image' (the method will return an Image object) and 'stream' (the method will return the image as a byte stream). If missing, the data URI of the drawing's (or chart's) image will be returned. Note: for an SVG based drawing/chart in IE/Edge browsers the method will always return SVG markup instead of a data URI, as 'img' elements won't accept a data URI anyway in those browsers.

Returns

:Object

data :  String

Image element, byte stream or DataURL.

type :  String

The type of the data (e.g. 'png' or 'svg').

getInteraction ( type ) : Ext.chart.interactions.Abstract

Get an interaction by type.

Parameters

type :  String

The type of the interaction.

Returns

:Ext.chart.interactions.Abstract

The interaction. null if not found.

getItemForPoint ( x, y ) : Object

Given an x/y point relative to the chart, find and return the first series item that matches that point.

Parameters

x :  Number

y :  Number

Returns

:Object

An object with series and item properties, or false if no item found.

getItemsForPoint ( x, y ) : Array

Given an x/y point relative to the chart, find and return all series items that match that point.

Parameters

x :  Number

y :  Number

Returns

:Array

An array of objects with series and item properties.

getLegendStore Ext.data.Store

Return the legend store that contains all the legend information. This information is collected from all the series.

Returns

:Ext.data.Store

getRefItems ( deep ) : Array
private pri

Parameters

deep :  Boolean

Returns

:Array

getSurface ( [id] ) : Ext.draw.Surface

Get a surface by the given id or create one if it doesn't exist.

Parameters

id :  String (optional)

Defaults to: "main"

Returns

:Ext.draw.Surface

preview

Displays an image of a Ext.draw.Container on screen. On mobile devices this lets users tap-and-hold to bring up the menu with image saving options. Notes:

  • some browsers won't save the preview image if it's SVG based (i.e. generated from a draw container that uses 'Ext.draw.engine.Svg' engine);
  • some platforms may not have the means of viewing successfully saved SVG images;
  • this method does not work on IE8.

redraw

Redraw the chart. If animations are set this will animate the chart too.

removeSeries ( series )

Remove a Ext.chart.series.Series from this chart. The Series (or array) passed will be removed from the existing series.

The chart will be redrawn in response to the change.

Parameters

series :  Ext.chart.series.Series/String

The Series or the id of the Series to remove. May be an array.

renderFrame

Render all the surfaces in the container.

resumeChartLayout

Decrements chart's layout suspend count. When the suspend count is decremented to zero, a layout is scheduled.

resumeThicknessChanged

Decrements axis thickness suspend count. When axis thickness suspend count is decremented to zero, chart layout is performed.

scheduleLayout

Schedule a layout at next frame.

suspendThicknessChanged

Prevent axes from triggering chart layout when their thickness changes. E.g. during an interaction that makes changes to the axes, or when chart layout was triggered by something else, for example a chart resize event.

events

beforerefresh ( this, eOpts )

Fires before a refresh to the chart data is called. If the beforerefresh handler returns false the refresh action will be canceled.

Parameters

this :  Ext.chart.AbstractChart

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

bodyresize ( size, eOpts )

Fires when the size of the draw container body changes.

Parameters

size :  Object

The object containing 'width' and 'height' of the draw container's body.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

itemclick ( chart, item, event, eOpts )

Fires when a click event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

itemdblclick ( chart, item, event, eOpts )

Fires when a double click event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

itemmousedown ( chart, item, event, eOpts )

Fires when a mousedown event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

itemmousemove ( chart, item, event, eOpts )

Fires when the mouse is moved on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

itemmouseout ( chart, item, event, eOpts )

Fires when the mouse exits a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

itemmouseover ( chart, item, event, eOpts )

Fires when the mouse enters a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

itemmouseup ( chart, item, event, eOpts )

Fires when a mouseup event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

itemtap ( chart, item, event, eOpts )

Fires when a tap event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

redraw ( this, eOpts )

Fires after the chart is redrawn.

Parameters

this :  Ext.chart.AbstractChart

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

refresh ( this, eOpts )

Fires after the chart data has been refreshed.

Parameters

this :  Ext.chart.AbstractChart

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

spriteclick ( sprite, event, eOpts )

Fires when a click event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

spritedblclick ( sprite, event, eOpts )

Fires when a double click event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

spritemousedown ( sprite, event, eOpts )

Fires when a mousedown event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

spritemousemove ( sprite, event, eOpts )

Fires when the mouse is moved on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

spritemouseout ( sprite, event, eOpts )

Fires when the mouse exits a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

spritemouseover ( sprite, event, eOpts )

Fires when the mouse enters a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

spritemouseup ( sprite, event, eOpts )

Fires when a mouseup event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

spritetap ( sprite, event, eOpts )

Fires when a tap event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

storechange ( chart, newStore, oldStore, eOpts )

Fires when the store of the chart changes.

Parameters

chart :  Ext.chart.AbstractChart

newStore :  Ext.data.Store

oldStore :  Ext.data.Store

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext JS 6.0.2 - Modern Toolkit