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.

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.

Member Types

Config - The configuration options for a class.

Property - Set once a class is instantiated. *See Read Only below.

Method - Actions that can be performed by a class. Methods should be read as
instance methods and can only be called from a instance of a given class. Static methods
that can be called directly from the class itself will have a static label next to the
method name. *See Static below.

Event - Events are specific to the framework event system allowing for classes to
programmatically raise an event to be handled by one or more event handler methods. DOM
events, while handled by the framework event system, are not specifically described
within the API documentation. *For DOM events refer to the
event reference page from MDN.

Theme Variable - Variables used by the visual theme engine employed by the
framework.

Theme Mixin - Functions used by the visual theme engine employed by the framework
and may use values set in various Theme Variables.

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

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:

Expand/Collapse - On the left-hand size of the member row is a control used to
expand and collapse each member row to show / hide member details.

Member Name - The name of the class member (lookupComponent in this example)

Method Param - Any required or optional params used by a method (or passed to an
event handler method) will be listed next to the method name within parenthesis
(( item ) in this example)

Return type - The class instance or javascript object returned by the method or
property (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).

Flags - Any flags applicable to the member will be displayed next (PROTECTED in
this example - see the Flags section below)

Member Origin - On the right-hand side of the member row is the class where the
member was initially described (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.

Member Source - On the right-hand side below the member origin class is a link to
view the member's source (view source in the example)

Params List - Each param for a class method will be listed using the same name
found above in parenthesis, the type of class or object expected, and a description of
the param (item : Object in the example).

Returns - If a class returns a value other than undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)

Since (not shown in the example) - Some members will show which version of the
product the member was first introduced (i.e. Available since 3.4.0 - not pictured in
the example) just after the member description

Default (not shown in the example) - Configs often show the default config value
to be applied to a class instance if not overridden (i.e. Defaults to: false)

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.

Required - Required config when instantiating a class

Bindable - The config has a setter which allows this config to be set via ViewModel
binding

Read Only - The property may be read, but cannot be used to configure /
re-configure a class instance at runtime

Singleton - Singleton classes are instantiated immediately once defined and may not
be instantiated manually

Static - A static method or property is a method or property belonging to the class
itself, not an instance of the class

Deprecated - A class or member that is scheduled for removal in a future
framework version and is provided in the current version for backwards compatibility.Deprecated classes and members will have a message directing you to the preferred class /
method going forward.

Removed - A removed class or member that exists in documentation only as a
reference for users upgrading between framework versions

Template - A method defined within a base class designed to be overridden by
subclasses

Abstract - A class or member may be be defined as abstract. Abstract classes and
members establish a class structure and provide limited, if any, code. Class-specific
code will be furnished via overrides in subclasses.

Preventable - Events marked preventable will not fire if false is returned from
an event handler

Class Icons

- Indicates a framework class

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

- 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

Navigation and Features

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:

Alternate Name - One or more additional class name synonymns (in Ext JS 6.0.0 the
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.

Hierarchy - The hierararchy view lists the inheritance chain of the current class
up through its ancestor classes up to the root base class.

Mixins - A list of classes that are mixed into the current class

Inherited Mixins - A list of classes that are mixed into an ancestor of the current
class

Requires - All classes required to be defined for the class to be instantiated

Uses - A list of classes potentially used by the class at some point in its
lifecycle, but not necessarily requried for the class to initially be instantiated

Subclasses - Classes that extend the current class

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:

Global navigation will be located in a menu on the left-hand side accessible via the
hamburger menu icon. The menu houses the following (on most pages):

The name of the current product (as a link to the product landing page)

The Sencha icon used to navigate back to the documentation home page

The product menu drop-down button

Tabs of navigation trees for the API docs and guides

Current context navigation and tools is located on the right-hand side accessible via
the gear icon. The context menu houses teh following:

The global search input field

(API doc) A "Filters" tab with the member filter, expand / collapse all examples
button, expand / collapse all member rows button, the access level filter checkboxes,
and the counts of each member

(API doc) A "Related Classes" tab containing the menu of metadata related to the
current class

(Guides) The table of contents for the guide

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.

configs

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.

While some Ext JS Component classes export selected DOM events (e.g. "click",
"mouseover" etc), this is usually only done when extra value can be added. For example
the DataView's itemclick
event passing the node clicked on. To access DOM events directly from a child element
of a Component, we need to specify the element option to identify the Component
property to add a DOM listener to:

An alias for addListener. In
versions prior to 5.1, listeners had a generated setter which could
be called to add listeners. In 5.1 the listeners config is not processed
using the config system and has no generated setter, so this method is
provided for backward compatibility. The preferred way of adding listeners
is to use the on method.

Parameters

listeners :
Object

The listeners

properties

privatepri

privatepri

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

privatepri

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.

privatepri

A prototype-chained object storing transform method names and priorities stored
on the class prototype. On first instantiation, this object is converted into
an array that is sorted by priority and stored on the constructor.

privatepri

We don't want the base destructor to clear the prototype because
our destroyObservable handler must be called the very last. It will take care
of the prototype after completing Observable destruction sequence.

privatepri

Setting this property to true will result in setting the object's
prototype to null after the destruction sequence is fully completed.
After that, most attempts at calling methods on the object instance
will result in "method not defined" exception. This can be very helpful
with tracking down otherwise hard to find bugs like runaway Ajax requests,
timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support Object.setPrototypeOf
method, and is only available in debugging mode.

privatepri

readonlyro

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 (via observe) 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:

protectedpro

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

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed
by the specified number of milliseconds. If the event fires again within that time,
the original handler is not invoked, but the new handler is scheduled in its place.

Causes the handler to be scheduled to run at the next
animation frame event. If the
event fires again before that time, the handler is not rescheduled - the handler
will only be called once when the next animation frame is fired, with the last set
of arguments passed.

Optional set of arguments to pass to the handler function before the actual
fired event arguments. For example, if args is set to ['foo', 42],
the event handler function will be called with an arguments list like this:

When specified as true, the function returns a destroyable object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.

An optional numeric priority that determines the order in which event handlers
are run. Event handlers with no priority will be run as if they had a priority
of 0. Handlers with a higher priority will be prioritized to run sooner than
those with a lower priority. Negative numbers can be used to set a priority
lower than the default. Internally, the framework uses a range of 1000 or
greater, and -1000 or lesser for handlers that are intended to run before or
after all others, so it is recommended to stay within the range of -999 to 999
when setting the priority of event handlers in application-level code.
A priority must be an integer to be valid. Fractional values are reserved for
internal framework use.

The addManagedListener method is used when some object (call it "A") is listening
to an event on another observable object ("B") and you want to remove that listener
from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because
all of its listeners will be removed at that time.

As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.

Parameters

item :
Ext.util.Observable/Ext.dom.Element

The item to which to add
a listener/listeners.

ename :
Object/String

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

fn :
Function/String(optional)

If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.

scope :
Object(optional)

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

options :
Object(optional)

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

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:

Returns

protectedpro

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.

The patch method cannot use method-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".

Parameters

args :
Array/Arguments

The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)

privatepri

Parameters

Enables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present. There is no implementation in the Observable
base class.

This is commonly used by Ext.Components to bubble events to owner Containers.
See Ext.Component#getBubbleTarget. The default implementation in Ext.Component
returns the Component's immediate owner. But if a known target is required, this can be
overridden to access the required target more quickly.

Parameters

deprecateddep

Fires the specified event with the passed parameters and executes a function (action).
By default, the action function will be executed after any "before" event handlers
(as specified using the order option of
addListener), but before any other
handlers are fired. This gives the "before" handlers an opportunity to
cancel the event by returning false, and prevent the action function from
being called.

The action can also be configured to run after normal handlers, but before any "after"
handlers (as specified using the order event option) by passing 'after'
as the order parameter. This configuration gives any event handlers except
for "after" handlers the opportunity to cancel the event and prevent the action
function from being called.

Parameters

eventName :
String

The name of the event to fire.

args :
Array

Arguments to pass to handlers and to the action function.

fn :
Function

The action function.

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)

Event options for the action function. Accepts any
of the options of addListener

order :
String(optional)

The order to call the action function relative
too the event handlers ('before' or 'after'). Note that this option is
simply used to sort the action function relative to the event handlers by "priority".
An order of 'before' is equivalent to a priority of 99.5, while an order of
'after' is equivalent to a priority of -99.5. See the priority option
of addListener for more details.

Returns

Fires the specified event with the passed parameters and executes a function (action).
Evented Actions will automatically dispatch a 'before' event passing. This event will
be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing,
however, will not stop the processing of any other before events.

Parameters

eventName :
String

The name of the event to fire.

args :
Array

Arguments to pass to handlers and to the action function.

fn :
Function/String

The action function.

scope :
Object(optional)

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

fnArgs :
Array/Boolean(optional)

Optional arguments for the action fn. If not
given, the normal args will be used to call fn. If false is passed, the
args are used but if the first argument is this instance it will be removed
from the args passed to the action function.

Parameters

Returns

Shorthand for addManagedListener.
The addManagedListener method is used when some object (call it "A") is listening
to an event on another observable object ("B") and you want to remove that listener
from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because
all of its listeners will be removed at that time.

As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.

Parameters

item :
Ext.util.Observable/Ext.dom.Element

The item to which to add
a listener/listeners.

ename :
Object/String

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

fn :
Function/String(optional)

If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.

scope :
Object(optional)

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

options :
Object(optional)

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

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed
by the specified number of milliseconds. If the event fires again within that time,
the original handler is not invoked, but the new handler is scheduled in its place.

Causes the handler to be scheduled to run at the next
animation frame event. If the
event fires again before that time, the handler is not rescheduled - the handler
will only be called once when the next animation frame is fired, with the last set
of arguments passed.

Optional set of arguments to pass to the handler function before the actual
fired event arguments. For example, if args is set to ['foo', 42],
the event handler function will be called with an arguments list like this:

When specified as true, the function returns a destroyable object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.

An optional numeric priority that determines the order in which event handlers
are run. Event handlers with no priority will be run as if they had a priority
of 0. Handlers with a higher priority will be prioritized to run sooner than
those with a lower priority. Negative numbers can be used to set a priority
lower than the default. Internally, the framework uses a range of 1000 or
greater, and -1000 or lesser for handlers that are intended to run before or
after all others, so it is recommended to stay within the range of -999 to 999
when setting the priority of event handlers in application-level code.
A priority must be an integer to be valid. Fractional values are reserved for
internal framework use.

Parameters

Relays selected events from the specified Observable as if the events were fired
by this.

For example if you are extending Grid, you might decide to forward some events from
store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed
the parameters of the store's load event and any function fired with the grid's
load event would have access to the grid using the this keyword (unless the event
is handled by a controller's control/listen event listener in which case 'this'
will be the controller rather than the grid).

Parameters

origin :
Object

The Observable whose events this object is to relay.

events :
String[]/Object

Array of event names to relay or an Object with key/value
pairs translating to ActualEventName/NewEventName respectively. For example:
this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event
as a pop event.

prefix :
String(optional)

A common prefix to prepend to the event names. For example:

this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Now the grid will forward 'load' and 'clear' events of store as 'storeload' and
'storeclear'.

Returns

:Object

A Destroyable object. An object which implements the destroy method
which, when destroyed, removes all relayers. For example:

Returns

protectedpro

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

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

Parameters

members :
Object

The properties to add to this class. This should be
specified as an object literal containing one or more properties.

Returns

staticstaprivatepri

events

Event which is fired when your Sencha Native packaged application is opened from another application using a custom URL scheme.

This event will only fire if the application was already open (in other words; onReady was already fired). This means you should check
if Ext.device.Device#scheme is set in your Application launch/onReady method, and perform any needed changes for that URL (if defined).
Then listen to this event for future changed.

Example

Ext.application({
name: 'Sencha',
requires: ['Ext.device.Device'],
launch: function() {
if (Ext.device.Device.scheme) {
// the application was opened via another application. Do something:
console.log('Applicaton opened via another application: ' + Ext.device.Device.scheme.url);
}
// Listen for future changes
Ext.device.Device.on('schemeupdate', function(device, scheme) {
// the application was launched, closed, and then launched another from another application
// this means onReady wont be called again ('cause the application is already running in the
// background) - but this event will be fired
console.log('Applicated reopened via another application: ' + scheme.url);
}, this);
}
});

Note: This currently only works with the Sencha Native Packager. If you attempt to listen to this event when packaged with
PhoneGap or simply in the browser, it will never fire.**