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.
This class defines a single style in the current workbook. This element is optional, but is required to perform any custom formatting.
A style can be either standalone or based on one other style (this is called the parent style), in which case, all base properties are first inherited from the parent, then the properties in the style are treated as overrides. Parent styles must be specified before they are first referenced.
Following keys are allowed on this object and are all optional:
Horizontal (String): specifies the left-to-right alignment of text within a cell. The Spreadsheet component
does not support CenterAcrossSelection, Fill, Justify, Distributed, and JustifyDistributed.
Possible values: Automatic, Left, Center, Right, Fill, Justify, CenterAcrossSelection, Distributed,
and JustifyDistributed. Default is Automatic.
Indent (Integer): specifies the number of indents. This attribute is not supported by the Spreadsheet component.
Defaults to 0.
ReadingOrder (String): specifies the default right-to-left text entry mode for a cell. The Spreadsheet component
does not support Context. Possible values: RightToLeft, LeftToRight, and Context. Defaults to Context.
Rotate (Double): Specifies the rotation of the text within the cell. 90 is straight up, 0 is horizontal,
and -90 is straight down. The Spreadsheet component does not support this attribute. Defaults to 0.
ShrinkToFit (Boolean): true means that the text size should be shrunk so that all of the text fits within the cell.
false means that the font within the cell should behave normally. The Spreadsheet component does not support this attribute.
Defaults to false.
Vertical (String): specifies the top-to-bottom alignment of text within a cell. Distributed and
JustifyDistributed are only legitimate values when VerticalText is 1. The Spreadsheet component does
not support Justify, Distributed, or JustifyDistributed. Possible values: Automatic, Top, Bottom,
Center, Justify, Distributed, and JustifyDistributed. Defaults to Automatic.
VerticalText (Boolean): true specifies whether the text is drawn "downwards", whereby each letter is drawn horizontally,
one above the other. The Spreadsheet component does not support this attribute. Defaults to false.
WrapText (Boolean): specifies whether the text in this cell should wrap at the cell boundary. false means that
text either spills or gets truncated at the cell boundary (depending on whether the adjacent cell(s) have content).
The Spreadsheet component does not support this attribute. Defaults to false.
Defaults to:
null
Array of border objects. Following keys are allowed for border objects:
Position (String): Specifies which of the six possible borders this element represents. Duplicate
borders are not permitted and are considered invalid. The Spreadsheet component does not support
DiagonalLeft or DiagonalRight. Possible values: Left, Top, Right, Bottom, DiagonalLeft, and
DiagonalRight
Color (String): Specifies the color of this border. This value can be either a 6-hexadecimal digit
number in "#rrggbb" format or it can be any of the Microsoft® Internet Explorer named colors
(including the named Microsoft Windows® colors). This string can also be the special value of Automatic.
This string is case insensitive.
LineStyle (String): Specifies the appearance of this border. The Spreadsheet component does
not support SlantDashDot and Double. Possible values: None, Continuous, Dash, Dot, DashDot,
DashDotDot, SlantDashDot, and Double.
Weight (Number): Specifies the weight (or thickness) of this border. This measurement is specified in points,
and the following values map to Excel: 0—Hairline, 1—Thin, 2—Medium, 3—Thick.
Defaults to:
null
Defines the font attributes to use in this style. Each attribute that is specified is considered an override from the default.
Following keys are allowed on this object:
Bold (Boolean): Specifies the bold state of the font. If the parent style has Bold: true and the child style wants
to override the setting, it must explicitly set the value to Bold: false. If this attribute is not specified
within an element, the default is assumed. Defaults to false.
Color (String): Specifies the color of the font. This value can be either a 6-hexadecimal digit number
in "#rrggbb" format or it can be any of the Internet Explorer named colors (including the named Windows colors).
This string can also be special value of Automatic. This string is case insensitive. If this attribute is not
specified within an element, the default is assumed. Defaults to Automatic.
FontName (String): Specifies the name of the font. This string is case insensitive. If this attribute is
not specified within an element, the default is assumed. Defaults to Arial.
Italic (Boolean): Similar to Bold in behavior, this attribute specifies the italic state of the font.
If this attribute is not specified within an element, the default is assumed. Defaults to false.
Outline (Boolean): Similar to Bold in behavior, this attribute specifies whether the font is rendered as an
outline. This property originates in Macintosh Office, and is not used on Windows. If this attribute is not
specified within an element, the default is assumed. The Spreadsheet component does not support this attribute.
Defaults to false.
Shadow (Boolean): Similar to Bold in behavior, this attribute specifies whether the font is shadowed.
This property originates in Macintosh Office, and is not used on Windows. If this attribute is not
specified within an element, the default is assumed. The Spreadsheet component does not support this attribute.
Defaults to false.
Size (Number): Specifies the size of the font in points. This value must be strictly greater than 0.
If this attribute is not specified within an element, the default is assumed. Defaults to 10.
StrikeThrough (Boolean): Similar to Bold in behavior, this attribute specifies the strike-through state
of the font. If this attribute is not specified within an element, the default is assumed. The Spreadsheet
component does not support this attribute. Defaults to false.
Underline (String): Specifies the underline state of the font. If the parent style is something other than
None and a child style wants to override the value, it must explicitly reset the value. If this attribute is
not specified within an element, the default is assumed. Possible values: None, Single, Double,
SingleAccounting, and DoubleAccounting. Defaults to None.
VerticalAlign (String): This attribute specifies the subscript or superscript state of the font. If this
attribute is not specified within an element, the default is assumed. The Spreadsheet component does not
support this attribute. Possible values: None, Subscript, and Superscript. Defaults to None.
CharSet (Number): Win32-dependent character set value. Defaults to 0.
Family (String): Win32-dependent font family. Possible values: Automatic, Decorative, Modern,
Roman, Script, and Swiss. Defaults to Automatic.
Defaults to:
null
A number format code in the Excel number format syntax. This can also be one of the following values:
General, General Number, General Date, Long Date, Medium Date, Short Date, Long Time, Medium Time,
Short Time, Currency, Euro Currency, Fixed, Standard, Percent, Scientific, Yes/No,
True/False, or On/Off. All special values are the same as the HTML number formats, with the exception
of Currency and Euro Currency.
Currency is the currency format with two decimal places and red text with parenthesis for negative values.
Euro Currency is the same as Currency using the Euro currency symbol instead.
Defaults to:
null
A unique name within this XML document that identifies this style. This string can be any valid identifier and there is no notion of order. The special value of "Default" indicates that this style represents the default formatting for this workbook.
Defines the fill properties to use in this style. Each attribute that is specified is considered an override from the default.
Following keys are allowed on this object:
Color (String): Specifies the fill color of the cell. This value can be either a 6-hexadecimal digit
number in "#rrggbb" format or it can be any of the Internet Explorer named colors (including the named
Windows colors). This string can also be special value of Automatic. This string is case insensitive.
If Pattern: "Solid", this value is the fill color of the cell. Otherwise, the cell is filled with a blend of
Color and PatternColor, with the Pattern attribute choosing the appearance.
Pattern (String): Specifies the fill pattern in the cell. The fill pattern determines how to blend the
Color and PatternColor attributes to produce the cell's appearance. The Spreadsheet component does not
support this attribute. Possible values: None, Solid, Gray75, Gray50, Gray25, Gray125, Gray0625,
HorzStripe, VertStripe, ReverseDiagStripe, DiagStripe, DiagCross, ThickDiagCross,
ThinHorzStripe, ThinVertStripe, ThinReverseDiagStripe, ThinDiagStripe, ThinHorzCross, and
ThinDiagCross. Defaults to None.
PatternColor (String): Specifies the secondary fill color of the cell when Pattern does not equal Solid.
The Spreadsheet component does not support this attribute. Defaults to Automatic.
Defaults to:
null
This property identifies this style as a named style that was created in Excel using the Style command (Format menu). Duplicate names are illegal.
Defaults to:
null
Presence of this element indicates that this style should first inherit it's default formatting settings from the specified parent style. Then, after the parent settings are inherited, we apply the settings in this style as overrides. This attribute refers to a predefined style ID.
Defaults to:
null
Defines the protection properties that should be used in cells referencing this style. This element exists as a short-hand way to apply protection to an entire table, row, or column, by simply adding it to a style.
Following keys are allowed on this object and are all optional:
Protected (Boolean): This attribute indicates whether or not this cell is protected. When the worksheet is
unprotected, cell-level protection has no effect. When a cell is protected, it will not allow the user to
enter information into it. Defaults to true.
HideFormula (Boolean): This attribute indicates whether or not this cell's formula should be hidden when
worksheet protection is enabled. Defaults to false.
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:
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
This property is set to true after the destroy method is called.
Defaults to:
false
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
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
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)
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 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 the result of calling the superclass method
This method could be used in config appliers that need to initialize a Collection that has items of type className.
data : Object
dataCollection : Object
className : Object
Create a new Collection with a decoder for the specified className.
className : Object
This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further.
Builds a Collection decoder for the specified className.
className : Object
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.
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.
The full config object or a single config value
when name parameter specified.
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'
config : Object
this
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.
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
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 : Ext.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 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.
this class
Ext JS | Terms of Use