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.
Creates a Bar Chart.
The event name to bubble, or an Array of event names.
Defaults to:
null
An array of color values which is used, in order of appearance, by the series. Each series can request one or more colors from the array. Radar, Scatter or Line charts require just one color each. Candlestick and OHLC require two (1 for drops + 1 for rises). Pie charts and Stacked charts (like Column or Pie charts) require one color for each data category they represent, so one color for each slice of a Pie chart or each segment of a Column chart. It overrides the colors that are provided by the current theme.
Defaults to:
null
The sprite attributes that will be applied to the highlighted items in the series. If set to 'true', the default highlight style from highlightCfg will be used. If the value of this config is an object, it will be merged with the highlightCfg. In case merging of 'highlight' and 'highlightCfg' configs in not the desired behavior, provide the 'highlightCfg' instead.
Defaults to:
false
The default style for the highlighted item. Used when highlight config was simply set to 'true' instead of specifying a style.
Defaults to:
{
fillStyle: 'yellow',
strokeStyle: 'red'
}
Sprite template used for series.
Defaults to:
{
type: 'rect',
fx: {
customDurations: {
x: 0,
y: 0,
width: 0,
height: 0,
radius: 0
}
}
}
Sets the value of itemInstancing
itemInstancing : Object
Object with the following properties:
Defaults to:
{}
display : String
Specifies the presence and position of the labels. The possible values depend on the chart type. For Line charts: 'under' | 'over' | 'rotate'. For Bar charts: 'insideStart' | 'insideEnd' | 'outside'. For Pie charts: 'outside' | 'rotate'. For all charts: 'none' hides the labels.
Default value: 'none'.
color : String
The color of the label text.
Default value: '#000' (black).
field : String/String[]
The name(s) of the field(s) to be displayed in the labels. If your chart has 3 series
that correspond to the fields 'a', 'b', and 'c' of your model and you only want to
display labels for the series 'c', you must still provide an array [null, null, 'c'].
Default value: null.
font : String
The font used for the labels.
Default value: '14px Helvetica'.
orientation : String
Either 'horizontal' or 'vertical'. If not set (default), the orientation is inferred from the value of the flipXY property of the series.
Default value: ''.
renderer : Function
Optional function for formatting the label into a displayable value.
The arguments to the method are:
text, sprite, config, rendererData, index
Label's renderer is passed the same arguments as renderer plus one extra 'text' argument which comes first.
The attributes that have been changed or added, or the text for the label. Example to enclose every other label in parentheses:
renderer: function (text) {
if (index % 2 == 0) {
return '(' + text + ')'
}
}
Default value: null.
Defaults to:
null
Deprecated
Use 'field' property of Ext.chart.series.Series#label instead.
The store record field name to be used for the series labels.
Extra distance value for which the labelOverflow listener is triggered.
Defaults to:
null
Sets the value of labelOverflowPadding
labelOverflowPadding : Number
A config object containing one or more event handlers to be added to this object during initialization. This
should be a valid listeners config object as specified in the addListener example for attaching
multiple handlers at once.
See the Event guide for more
Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define().
Instead, only specify listeners when you are instantiating your class with Ext.create().
Defaults to:
null
This is cyclic used if series have multiple marker sprites.
Defaults to:
null
Sets the value of markerSubStyle
markerSubStyle : Object
The surface that series markers are attached.
Defaults to:
null
Sets the value of overlaySurface
overlaySurface : Object
A function that can be provided to set custom styling properties to each rendered element.
It receives (sprite, config, rendererData, index) as parameters.
Defaults to:
null
sprite : Object
The sprite affected by the renderer. The visual attributes are in sprite.attr.
The data field is available in sprite.getField().
config : Object
The sprite configuration. It varies with the series and the type of sprite:
for instance, a Line chart sprite might have just the x and y properties while a Bar
chart sprite also has width and height. A type might be present too. For instance to
draw each marker and each segment of a Line chart, the renderer is called with the
config.type set to either marker or line.
rendererData : Object
A record with different properties depending on the type of chart.
The only guaranteed property is rendererData.store, the store used by the series.
In some cases, a store may not exist: for instance a Gauge chart may read its value directly
from its configuration; in this case rendererData.store is null and the value is
available in rendererData.value.
index : Number
The index of the sprite. It is usually the index of the store record associated
with the sprite, in which case the record can be obtained with store.getData().items[index].
If the chart is not associated with a store, the index represents the index of the sprite within
the series. For instance a Gauge chart may have as many sprites as there are sectors in the
background of the gauge, plus one for the needle.
The attributes that have been changed or added. Note: it is usually possible to
add or modify the attributes directly into the config parameter and not return anything,
but returning an object with only those attributes that have been changed may allow for
optimizations in the rendering of some series. Example to draw every other marker in red:
renderer: function (sprite, config, rendererData, index) {
if (config.type === 'marker') {
return { strokeStyle: (index % 2 === 0 ? 'red' : 'black') };
}
}
Whether markers should be displayed at the data points along the line. If true, then the marker config item will determine the markers' styling.
Defaults to:
true
Custom style configuration for the sprite used in the series. It overrides the style that is provided by the current theme.
Defaults to:
{}
Style configuration that is provided by the current theme. It is composed of five objects:
Defaults to:
{}
style : Object
Properties common to all the series, for instance the 'lineWidth'.
subStyle : Object
Cyclic used if the series has multiple sprites.
label : Object
Sprite config for the labels, for instance the font and color.
marker : Object
Sprite config for the markers, for instance the size and stroke color.
markerSubStyle : Object
Cyclic used if series have multiple marker sprites.
The human-readable name of the series (displayed in the legend).
Defaults to:
null
Add tooltips to the visualization's markers. The options for the tooltip are the same configuration used with Ext.tip.ToolTip. For example:
tooltip: {
trackMouse: true,
width: 140,
height: 28,
renderer: function (storeItem, item) {
this.setHtml(storeItem.get('name') + ': ' + storeItem.get('data1') + ' views');
}
}
Defaults to:
null
Colors for the series can be set directly through the 'colors' config, or indirectly with the current theme or the 'colors' config that is set onto the chart. These colors are used as "fill color". Set this config to true, if you want a darker color for the strokes. Set it to false if you want to use the same color as the fill color. Alternatively, you can set it to a number between 0 and 1 to control how much darker the strokes should be.
Defaults to:
true
xAxis The chart axis the series is bound to in the 'X' direction. Normally, this would be set automatically by the series. For charts with multiple x-axes, this defines which x-axis is used by the series. It refers to either axis' ID or the (zero-based) index of the axis in the chart's axes config.
Defaults to:
null
The field used to access the x axis value from the items from the data source.
Defaults to:
null
yAxis The chart axis the series is bound to in the 'Y' direction. Normally, this would be set automatically by the series. For charts with multiple y-axes, this defines which y-axis is used by the series. It refers to either axis' ID or the (zero-based) index of the axis in the chart's axes config.
Defaults to:
null
The value true causes config values to be stored on instances using a
property name prefixed with an underscore ("_") character. A value of false
stores config values as properties using their exact name (no prefix).
Defaults to:
false
Available since: 5.0.0
The value true instructs the initConfig method to only honor values for
properties declared in the config block of a class. When false, properties
that are not declared in a config block will be placed on the instance.
Defaults to:
true
Available since: 5.0.0
Tells which store record fields should be used for a specific axis direction. E.g. for
fieldCategory<direction>: ['<fieldConfig1>', '<fieldConfig2>', ...]
the field names from the following configs will be used:
series.<fieldConfig1>Field, series.<fieldConfig2>Field, ...
Defaults to:
[
'X'
]
For a given x/y point relative to the main rect, find a corresponding item from this series, if any.
Defaults to:
Ext.emptyFn
x : Number
y : Number
target : Object (optional)
optional target to receive the result
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:
record : Ext.data.Model
the record of the item.
point : Array
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.
sprite : Ext.draw.sprite.Sprite
the item's rendering Sprite.
subSprite : Number
the index if sprite is an instancing sprite.
This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class or on the Ext.app.EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.
The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:
if (this.hasListeners.foo) {
this.fireEvent('foo', this, arg1);
}
This property is set to true during the call to initConfig.
Defaults to:
false
Available since: 5.0.0
This property is set to true if this instance is the first of its class.
Defaults to:
false
Available since: 5.0.0
This value is true and is used to identify plain objects from instances of
a defined class.
Defaults to:
true
Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics,
this.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#statics
for a detailed comparison
Ext.define('My.Cat', {
statics: {
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
alert(this.self.speciesName); // dependent on 'this'
},
clone: function() {
return new this.self();
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
}
});
var cat = new My.Cat(); // alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
Defaults to:
Base
Appends an after-event handler.
Same as addListener with order set to 'after'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
Appends a before-event handler. Returning false from the handler will stop the event.
Same as addListener with order set to 'before'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
Adds the specified events to the list of events which this Observable may fire.
eventNames : 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.
Deprecated since version 2.0
It's no longer needed to add events before firing.
Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener:
container.addListener('tap', this.handleTap, this, {
single: true,
delay: 100
});
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
container.addListener({
tap : this.onTap,
swipe: this.onSwipe,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
container.addListener({
tap : { fn: this.onTap, scope: this, single: true },
swipe: { fn: button.onSwipe, scope: button }
});
See the Events Guide for more.
eventName : String/String[]/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String
The method the event invokes. Will be called with arguments given to
fireEvent plus the options parameter described below.
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.
This object may contain any of the following properties:
scope : Object (optional)
The scope (this reference) in which the handler function is executed. If omitted, defaults to the object
which fired the event.
delay : Number (optional)
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean (optional)
true to add a handler to handle just the next firing of the event, and then remove itself.
order : String (optional)
The order of when the listener should be added into the listener queue.
If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.
Available options are before, current and after.
Defaults to:
current
buffer : Number (optional)
Causes the handler to be 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.
element : String (optional)
If this observable is a Component, allows you to add a listener onto a element of the component using the element's reference.
Ext.create('Ext.Component', {
listeners: {
element: 'element',
tap: function() {
alert('element tap!');
}
}
});
In Sencha Touch, All components have the element reference, which is the outer
most element of the component. Ext.Container also has the innerElement
element which contains all children. In most cases element is adequate.
delegate : String (optional)
For Ext.dom.Element, a simple DOM selector to filter the target or look for a descendant of the target.
Sencha Touch Components can use Ext.ComponentQuery selectors to filter child Components.
// Create a container with a two children; a button and a toolbar
var container = Ext.create('Ext.Container', {
items: [
{
xtype: 'toolbar',
docked: 'top',
title: 'My Toolbar'
},
{
xtype: 'button',
text: 'My Button'
}
]
});
container.addListener({
// Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
delegate: 'button',
tap: function() {
alert('Button tapped!');
}
});
capture : Boolean
true to initiate capture which will fire the
listeners on the target Element before any descendant Elements. Normal events
start with the target element and propagate upward to ancestor elements, whereas
captured events propagate from the top of the DOM downward to descendant elements.
This option achieves the same result as the useCapture parameter in the standard
JavaScript addEventListener method.
order : String (optional)
The order of when the listener should be added into the listener queue.
Possible values are before, current and after.
Defaults to: 'current'
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
eventName : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the eventName parameter was an event name, this is the handler function.
scope : Object (optional)
If the eventName parameter was an event name, this is the scope in which
the handler function is executed.
options : Object (optional)
If the eventName parameter was an event name, this is the
addListener options.
Deprecated since version 2.0
All listeners are now automatically managed where necessary. Simply use addListener.
Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).
Ext.define('My.Base', {
constructor: function (x) {
this.x = x;
},
statics: {
method: function (x) {
return x;
}
}
});
Ext.define('My.Derived', {
extend: 'My.Base',
constructor: function () {
this.callParent([21]);
}
});
var obj = new My.Derived();
alert(obj.x); // alerts 21
This can be used with an override as follows:
Ext.define('My.DerivedOverride', {
override: 'My.Derived',
constructor: function (x) {
this.callParent([x*2]); // calls original My.Derived constructor
}
});
var obj = new My.Derived();
alert(obj.x); // now alerts 42
This also works with static methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Base.method
}
}
});
alert(My.Base.method(10)); // alerts 10
alert(My.Derived2.method(10)); // alerts 20
Lastly, it also works with overridden static methods.
Ext.define('My.Derived2Override', {
override: 'My.Derived2',
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10); // now alerts 40
To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callParent(arguments)
Returns the result of calling the parent method
This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function () {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
extend: 'Ext.some.Class',
method: function () {
console.log('Bad');
// ... logic but with a bug ...
this.callParent();
}
});
To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an
override:
Ext.define('App.patches.DerivedClass', {
override: 'Ext.some.DerivedClass',
method: function () {
console.log('Fixed');
// ... logic but with bug fixed ...
this.callSuper();
}
});
The patch method cannot use callParent to call the superclass method since
that would call the overridden method containing the bug. In other words, the
above patch would only produce "Fixed" then "Good" in the console log, whereas,
using callParent would produce "Fixed" then "Bad" then "Good".
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)
Returns the result of calling the superclass method
actionFn : Object
eventName : Object
fn : Object
scope : Object
options : Object
order : Object
This method will return an array containing data coordinated by a specific axis.
items : Array
field : String
axis : Ext.chart.axis.Axis
Creates an event handling function which re-fires the event from this object as the passed event name.
newName : String
This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further.
name : Object
fn : Object
scope : Object
options : Object
order : 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.
events : String/String[]
The event name to bubble, or an Array of event names.
Given the list of axes in a certain direction and a list of series fields in that direction returns the first matching axis for the series in that direction, or undefined if a match wasn't found.
directionAxes : Object
directionFields : Object
Fires the specified event with the passed parameters and execute a function (action)
at the end if there are no listeners that return false.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handers.
fn : Function
Action.
scope : Object
Scope of fn.
Fires the specified event with the passed parameters (minus the event name, plus the options object passed
to addListener).
The first argument is the name of the event. Every other argument passed will be available when you listen for the event.
Firstly, we set up a listener for our new event.
this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
console.log(arg1); // true
console.log(arg2); // 2
console.log(arg3); // { test: 'foo' }
console.log(arg4); // 14
console.log(options); // the options added when adding the listener
console.log(e); // the event object with information about the event
});
And then we can fire off the event.
this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);
An event may be set to bubble up an Observable parent hierarchy by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object...
Variable number of parameters are passed to handlers.
Returns false if any of the handlers return false.
Fires the specified event with the passed parameter list.
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object[]
An array of parameters which are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.
name : String (optional)
The name of the config property to get.
peek : Boolean (optional)
true to peek at the raw value without calling the getter.
Defaults to: false
The config property value.
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
id
Returns the initial configuration passed to constructor when instantiating this class.
name : String (optional)
Name of the config option to return.
The full config object or a single config value
when name parameter specified.
Checks to see if this object has any listeners for a specified event
eventName : String
The name of the event to check for
True if the event is being listened for, else false
Initialize configuration for this class. a typical example:
Ext.define('My.awesome.Class', {
// The default config
config: {
name: 'Awesome',
isAwesome: true
},
constructor: function(config) {
this.initConfig(config);
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
instanceConfig : Object
this
Checks if all events, or a specific event, is suspended.
eventName : String (optional)
The name of the specific event to check
true if events are suspended
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy).
name : String
value : Object
The value passed.
Alias for addManagedListener. Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
eventName : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the eventName parameter was an event name, this is the handler function.
scope : Object (optional)
If the eventName parameter was an event name, this is the scope in which
the handler function is executed.
options : Object (optional)
If the eventName parameter was an event name, this is the
addListener options.
Deprecated since version 2.0.0
This is now done automatically
Alias for removeManagedListener. Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
eventName : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the eventName parameter was an event name, this is the handler function.
scope : Object (optional)
If the eventName parameter was an event name, this is the scope in which
the handler function is executed.
Deprecated since version 2.0.0
This is now done automatically
Alias for addListener. Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener:
container.addListener('tap', this.handleTap, this, {
single: true,
delay: 100
});
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
container.addListener({
tap : this.onTap,
swipe: this.onSwipe,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
container.addListener({
tap : { fn: this.onTap, scope: this, single: true },
swipe: { fn: button.onSwipe, scope: button }
});
See the Events Guide for more.
eventName : String/String[]/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String
The method the event invokes. Will be called with arguments given to
fireEvent plus the options parameter described below.
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.
This object may contain any of the following properties:
scope : Object (optional)
The scope (this reference) in which the handler function is executed. If omitted, defaults to the object
which fired the event.
delay : Number (optional)
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean (optional)
true to add a handler to handle just the next firing of the event, and then remove itself.
order : String (optional)
The order of when the listener should be added into the listener queue.
If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.
Available options are before, current and after.
Defaults to:
current
buffer : Number (optional)
Causes the handler to be 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.
element : String (optional)
If this observable is a Component, allows you to add a listener onto a element of the component using the element's reference.
Ext.create('Ext.Component', {
listeners: {
element: 'element',
tap: function() {
alert('element tap!');
}
}
});
In Sencha Touch, All components have the element reference, which is the outer
most element of the component. Ext.Container also has the innerElement
element which contains all children. In most cases element is adequate.
delegate : String (optional)
For Ext.dom.Element, a simple DOM selector to filter the target or look for a descendant of the target.
Sencha Touch Components can use Ext.ComponentQuery selectors to filter child Components.
// Create a container with a two children; a button and a toolbar
var container = Ext.create('Ext.Container', {
items: [
{
xtype: 'toolbar',
docked: 'top',
title: 'My Toolbar'
},
{
xtype: 'button',
text: 'My Button'
}
]
});
container.addListener({
// Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
delegate: 'button',
tap: function() {
alert('Button tapped!');
}
});
capture : Boolean
true to initiate capture which will fire the
listeners on the target Element before any descendant Elements. Normal events
start with the target element and propagate upward to ancestor elements, whereas
captured events propagate from the top of the DOM downward to descendant elements.
This option achieves the same result as the useCapture parameter in the standard
JavaScript addEventListener method.
order : String (optional)
The order of when the listener should be added into the listener queue.
Possible values are before, current and after.
Defaults to: 'current'
Alias for addAfterListener. Appends an after-event handler.
Same as addListener with order set to 'after'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
Alias for addBeforeListener.
Appends a before-event handler. Returning false from the handler will stop the event.
Same as addListener with order set to 'before'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
args : Object
fn : Object
scope : Object
options : Object
order : Object
Relays selected events from the specified Observable as if the events were fired by this.
object : Object
The Observable whose events this object is to relay.
events : String/Array/Object
Array of event names to relay.
Removes a before-event handler.
Same as removeListener with order set to 'after'.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
Removes a before-event handler.
Same as removeListener with order set to 'before'.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
Removes an event handler.
eventName : String/String[]/Object
The type of event the handler was associated with.
fn : Function/String
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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.
options : Object (optional)
Extra options object. See addListener for details.
order : String (optional)
The order of the listener to remove.
Possible values are before, current and after.
Defaults to: 'current'
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
eventName : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the eventName parameter was an event name, this is the handler function.
scope : Object (optional)
If the eventName parameter was an event name, this is the scope in which
the handler function is executed.
Deprecated since version 2.0
All listeners are now automatically managed where necessary. Simply use removeListener.
This method determines the scope (the this pointer) of named listeners that have
not be given a specific scope. For example:
component.on({
click: 'onClick'
});
The default implementation of this method returns this object. Components and other observable objects that have natural hierarchies can override this method to pick the desired scope using other means.
Available since: 5.0.0
defaultScope : Object (optional)
The default scope to return if none is found.
Defaults to: this
The object on which non-scoped, named listeners should be fired.
Resumes firing of the named event(s).
After calling this method to resume events, the events will fire when requested to fire.
Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to resume.
Resumes firing events (see suspendEvents).
discardQueuedEvents : Boolean
Pass as true to discard any queued events.
Sets a single/multiple configuration options.
name : String/Object
The name of the property to set, or a set of key value pairs to set.
value : Object (optional)
The value to set for the name parameter.
this
Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self,
this.statics() is scope-independent and it always returns the class from which it was called, regardless of what
this points to during run-time
Ext.define('My.Cat', {
statics: {
totalCreated: 0,
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
var statics = this.statics();
alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to
// equivalent to: My.Cat.speciesName
alert(this.self.speciesName); // dependent on 'this'
statics.totalCreated++;
},
clone: function() {
var cloned = new this.self(); // dependent on 'this'
cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName
return cloned;
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
},
constructor: function() {
this.callParent();
}
});
var cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
alert(clone.groupName); // alerts 'Cat'
alert(My.Cat.totalCreated); // alerts 3
Suspends firing of the named event(s).
After calling this method to suspend events, the events will no longer fire when requested to fire.
Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to suspend.
Suspends the firing of all events. (see resumeEvents)
queueSuspended : Boolean
true to queue up suspended events to be fired
after the resumeEvents call instead of discarding all suspended events.
Returns the number of colors this series needs. A Pie chart needs one color per slice while a Stacked Bar chart needs one per segment. An OHLC chart needs 2 colors (one for drops, one for rises), and most other charts need just 1 color.
Returns the number of markers this series needs. Currently, only the Line, Scatter and Radar series use markers - and they need just one each.
Alias for removeListener. Removes an event handler.
eventName : String/String[]/Object
The type of event the handler was associated with.
fn : Function/String
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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.
options : Object (optional)
Extra options object. See addListener for details.
order : String (optional)
The order of the listener to remove.
Possible values are before, current and after.
Defaults to: 'current'
Alias for removeAfterListener. Removes a before-event handler.
Same as removeListener with order set to 'after'.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
Alias for removeBeforeListener. Removes a before-event handler.
Same as removeListener with order set to 'before'.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
Destroys a given set of linked objects. This is only needed if
the linked object is being destroyed before this instance.
names : String[]
The names of the linked objects to destroy.
this
When the chart's "colors" config changes, these colors are passed onto the series where they are used with the same priority as theme colors, i.e. they do not override the series' "colors" config, nor the series' "style" config, but they do override the colors from the theme's "seriesThemes" config.
colors : Object
Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.
config : Object
mixinClass : Class (optional)
The mixin class if the configs are from a mixin.
Add methods / properties to the prototype of this class.
Ext.define('My.awesome.Cat', {
constructor: function() {
...
}
});
My.awesome.Cat.addMembers({
meow: function() {
alert('Meowww...');
}
});
var kitty = new My.awesome.Cat();
kitty.meow();
members : Object
The members to add to this class.
isStatic : Boolean (optional)
Pass true if the members are static.
Defaults to: false
privacy : Boolean (optional)
Pass true if the members are private. This
only has meaning in debug mode and only for methods.
Defaults to: false
Add / override static properties of this class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.addStatics({
someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'
method1: function() { ... }, // My.cool.Class.method1 = function() { ... };
method2: function() { ... } // My.cool.Class.method2 = function() { ... };
});
members : Object
this
Borrow another class' members to the prototype of this class.
Ext.define('Bank', {
money: '$$$',
printMoney: function() {
alert('$$$$$$$');
}
});
Ext.define('Thief', {
...
});
Thief.borrow(Bank, ['money', 'printMoney']);
var steve = new Thief();
alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'
fromClass : Ext.Base
The class to borrow members from
members : Array/String
The names of the members to borrow
this
Create a new instance of this Class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.create({
someConfig: true
});
All parameters are passed to the constructor of the class.
the created instance.
Create aliases for existing prototype methods. Example:
Ext.define('My.cool.Class', {
method1: function() { ... },
method2: function() { ... }
});
var test = new My.cool.Class();
My.cool.Class.createAlias({
method3: 'method1',
method4: 'method2'
});
test.method3(); // test.method1()
My.cool.Class.createAlias('method5', 'method3');
test.method5(); // test.method3() -> test.method1()
alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
origin : String/Object
The original method name
Returns the Ext.Configurator for this class.
Get the current class' name in string format.
Ext.define('My.cool.Class', {
constructor: function() {
alert(this.self.getName()); // alerts 'My.cool.Class'
}
});
My.cool.Class.getName(); // 'My.cool.Class'
className
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
Override members of this class. Overridden methods can be invoked via callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
Fires when the Ext.chart.AbstractChart has been attached to this series.
chart : Ext.chart.AbstractChart
series : Ext.chart.series.Series
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the Ext.chart.AbstractChart has been detached from this series.
chart : Ext.chart.AbstractChart
series : Ext.chart.series.Series
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Ext JS | Terms of Use