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.
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).
Called when a raw config object is added to this container either during initialization of the
items
config,
or when new items are
added), or {@link #insert inserted
.
This may be overridden in subclasses when special processing needs to be applied to child creation.
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
Chainable
- Refers to methods that return the class instance back when called.
This enables chained method calls like:
classInstance.method1().method2().etc();
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
- A component-type framework class (any
class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide
is new in the currently viewed version
Member Icons
- Indicates a class member of type
config
- Indicates a class member of type
property
- Indicates a class member of type
method
- Indicates a class member of type
event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide
is new in the currently viewed version
Navigation and Features
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.
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.
Summary
This plugin allows grid data export using various exporters. Each exporter should extend
the
Ext.exporter.Base
class.
Two new methods are created on the grid panel by this plugin:
-
saveDocumentAs(config): saves the document
-
getDocumentData(config): returns the document content
The grid data is exported for all grid columns that have the flag
ignoreExport
as false.
A grid column may have an
exportStyle
defined which is used during
data export. If no
exportStyle
is defined for a column then column formatter is used if
defined.
Example usage:
xtype: 'grid',
plugins: [{
type: 'gridexporter'
columns: [{
dataIndex: 'value',
text: 'Total',
exportStyle: {
format: 'Currency',
alignment: {
horizontal: 'Right'
grid.saveDocumentAs({
type: 'xlsx',
title: 'My export',
fileName: 'myExport.xlsx'
No members found using the current filters
configs
Optional Configs
An identifier for the plugin that can be set at creation time to later retrieve the
plugin using the
getPlugin
method. For example:
var panel = Ext.create({
xtype: 'panel',
plugins: [{
id: 'foo',
// later on:
var plugin = panel.getPlugin('foo');
Available since: 6.2.0
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:
true
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
Setting this property to false will prevent nulling object references
on a Class instance after destruction. Setting this to "async" will delay
the clearing for approx 50ms.
Defaults to:
true
Available since: 6.2.0
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.
Defaults to:
false
Available since: 6.2.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
This method creates the data object that will be consumed by the exporter.
Defaults to:
Ext.emptyFn
config :
Object
The config object passed to the getDocumentData and saveDocumentAs methods
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
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations :
Object
Call the original method that was previously overridden with Ext.Base#override
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.callOverridden();
alert("Meeeeoooowwww");
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
args :
Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callOverridden(arguments)
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 and private methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
// privates: {
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',
// privates: {
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
method-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)
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 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".
args :
Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)
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.
Fetch the export data. This method is added to the grid panel as "getDocumentData".
Pass in exporter specific configs to the config parameter.
config :
Ext.exporter.Base
Config object used to initialize the proper exporter
Returns the initial configuration passed to the constructor when
instantiating this class.
Given this example Ext.button.Button definition and instance:
Ext.define('MyApp.view.Button', {
extend: 'Ext.button.Button',
xtype: 'mybutton',
scale: 'large',
enableToggle: true
var btn = Ext.create({
xtype: 'mybutton',
renderTo: Ext.getBody(),
text: 'Test Button'
Calling btn.getInitialConfig() would return an object including the config
options passed to the create method:
xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'
Calling btn.getInitialConfig('text')returns 'Test Button'.
name :
String
(optional)
Name of the config option to return.
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
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy).
name :
String
Save the export file. This method is added to the grid panel as "saveDocumentAs".
Pass in exporter specific configs to the config parameter.
config :
Ext.exporter.Base
Config object used to initialize the proper exporter
Sets the host component to which this plugin is attached. For a plugin to be
removable without being destroyed, this method should be provided and be prepared
to receive null for the component.
host :
Ext.Component
The owning host component.
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
:Ext.Class
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.
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
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.
Pass true if the members are private. This
only has meaning in debug mode and only for methods.
Defaults to: false
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
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
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
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'
:String
className
Override members of this class. Overridden methods can be invoked via
Ext.Base#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.
Fires on the grid panel when the {Ext.exporter.data.Table data object} is ready.
You could adjust styles or data before the document is generated and saved.
grid :
Ext.grid.Panel
Reference to the grid panel
