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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
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).
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
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:
[]
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
Array of colors/gradients to override the color of items and legends.
Defaults to:
null
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"
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:
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:
[]
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
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
}
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:
[]
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:
[]
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
The data source to which the chart is bound. Acceptable values for this property are:
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'
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:
Defaults to:
"default"
Toggle for chart interactions that require animation to be suspended.
Defaults to:
0
The default URL used by download.
Defaults to:
"http://svg.sencha.io"
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
The number of records in the chart's store last time the data was changed.
Defaults to:
0
A list of export types supported by the server.
Defaults to:
["png", "pdf", "jpeg", "gif"]
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
}
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.
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.
Changes the data store bound to this chart and refreshes it.
store : Ext.data.Store
The store to bind to this chart.
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.
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.
True if request was successfully sent to the server.
Returns an axis instance based on the type of data passed.
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.
The axis requested.
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%.
isRecompute : Object
Produces an image of the chart / drawing.
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.
Get an interaction by type.
type : String
The type of the interaction.
The interaction. null
if not found.
Given an x/y point relative to the chart, find and return the first series item that matches that point.
x : Number
y : Number
An object with series and item properties, or false if no item found.
Given an x/y point relative to the chart, find and return all series items that match that point.
x : Number
y : Number
An array of objects with series and item properties.
Return the legend store that contains all the legend information. This information is collected from all the series.
Get a surface by the given id or create one if it doesn't exist.
id : String (optional)
Defaults to: "main"
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:
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.
series : Ext.chart.series.Series/String
The Series or the id of the Series to remove. May be an array.
Decrements chart's layout suspend count. When the suspend count is decremented to zero, a layout is scheduled.
Decrements axis thickness suspend count. When axis thickness suspend count is decremented to zero, chart layout is performed.
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.
Fires before a refresh to the chart data is called. If the beforerefresh handler returns
false the refresh action will be canceled.
this : Ext.chart.AbstractChart
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the size of the draw container body changes.
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.
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.
chart : Ext.chart.AbstractChart
item : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
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.
chart : Ext.chart.AbstractChart
item : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
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.
chart : Ext.chart.AbstractChart
item : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
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.
chart : Ext.chart.AbstractChart
item : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the mouse exits a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.
chart : Ext.chart.AbstractChart
item : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the mouse enters a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.
chart : Ext.chart.AbstractChart
item : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
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.
chart : Ext.chart.AbstractChart
item : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
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.
chart : Ext.chart.AbstractChart
item : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires after the chart is redrawn.
this : Ext.chart.AbstractChart
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires after the chart data has been refreshed.
this : Ext.chart.AbstractChart
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a click event occurs on a sprite.
sprite : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a double click event occurs on a sprite.
sprite : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a mousedown event occurs on a sprite.
sprite : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the mouse is moved on a sprite.
sprite : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the mouse exits a sprite.
sprite : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the mouse enters a sprite.
sprite : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a mouseup event occurs on a sprite.
sprite : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a tap event occurs on a sprite.
sprite : Object
event : Event
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the store of the chart changes.
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 | Terms of Use