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.
Represents a single field in the PivotTable. This element contains information about the field, including the collection of items in the field.
(CT_PivotField)
Specifies a boolean value that indicates whether all items in the field are expanded. Applies only to OLAP PivotTables.
A value of 1 or true indicates all items in the field are expanded.
A value of 0 or false indicates all items are not expanded. However some items might be expanded.
Defaults to:
null
Set to true to auto generate an id if none is defined.
Defaults to:
true
Sets the value of autoGenerateId
autoGenerateId : Boolean
Set an array of config names available on this class that will be used to generate a key. This key is useful when instances of this class are used in a Ext.util.Collection.
The key is generated by combining the values of those configs. If a config value is an instance of a class then it will look for a getKey function on that class and use it.
Set to false if you don't want to generate they key
Defaults to:
false
Sets the value of autoGenerateKey
autoGenerateKey : String[]
Specifies a boolean value that indicates whether an "AutoShow" filter is applied to this field. This attribute depends on the implementation of filtering in the application.
A value of 1 or true indicates an "AutoShow" filter is applied to the field.
A value of 0 or false indicates an "AutoShow" filter is not applied.
Defaults to:
null
Represents the sorting scope for the PivotTable.
Defaults to:
null
Returns the value of autoSortScope
Sets the value of autoSortScope
autoSortScope : Ext.exporter.file.ooxml.excel.AutoSortScope
Specifies a boolean value that indicates whether to apply the 'Average' aggregation function in the subtotal of this field.
A value of 1 or true indicates the subtotal for this field is 'Average.'
A value of 0 or false indicates a different aggregation function is applied to the subtotal for this field.
Defaults to:
null
Specifies the region of the PivotTable that this field is displayed.
Possible values:
axisCol: Column axisaxisPage: Page axisaxisRow: Row axisaxisValues: Values axisDefaults to:
null
Specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this PivotTable resides.
A value of 1 or true indicates the next field should be displayed in the same column of the sheet.
A value of 0 or false indicates each pivot field will display in its own column in the sheet.
Defaults to:
null
Specifies a boolean value that indicates whether to apply the 'countA' aggregation function in the subtotal of this field.
A value of 1 or true indicates the subtotal for this field is 'countA.'
A value of 0 or false indicates a different aggregation function is applied to the subtotal for this field.
Defaults to:
null
Sets the value of countASubtotal
countASubtotal : Boolean
Specifies a boolean value that indicates whether to apply the 'count' aggregation function in the subtotal of this field.
A value of 1 or true indicates the subtotal for this field is 'count.'
A value of 0 or false indicates a different aggregation vfunction is applied to the subtotal for this field.
Defaults to:
null
Specifies a boolean value that indicates whether this field appears in the data region of the PivotTable.
A value of 1 or true indicates this field appears in the data region of the PivotTable.
A value of 0 or false indicates this field appears in another region of the PivotTable.
Defaults to:
null
Specifies a boolean value that indicates whether sort is applied to this field in the data source.
A value of 1 or true indicates this field is sorted in the data source.
A value of 0 or false indicates this field is not sorted in the data source.
Defaults to:
null
Sets the value of dataSourceSort
dataSourceSort : Boolean
Specifies a boolean value that indicates the drill state of the attribute hierarchy in an OLAP-based PivotTable.
A value of 1 or true indicates the attribute hierarchy is expanded.
A value of 0 or false indicates the attribute hierarchy is collapsed.
This attribute is designed to allow the application to issue more optimized queries when all items of each field have the same drill state.
Defaults to:
null
Sets the value of defaultAttributeDrillState
defaultAttributeDrillState : Boolean
Specifies a boolean value that indicates whether the default subtotal aggregation function is displayed for this field.
A value of 1 or true indicates the default subtotal aggregation function is displayed for this field.
A value of 0 or false indicates the default aggregation function is not displayed.
Defaults to:
null
Sets the value of defaultSubtotal
defaultSubtotal : Boolean
Specifies a boolean value that indicates whether the field can be removed from the PivotTable.
A value of 1 or true indicates the field can be removed from the PivotTable.
A value of 0 or false indicates the field cannot be removed from the PivotTable.
Defaults to:
null
Specifies a boolean value that indicates whether the field can be dragged to the column axis.
A value of 1 or true indicates the field can be dragged to the column axis.
A value of 0 or false indicates the field cannot be dragged to the column axis.
Defaults to:
null
Specifies a boolean value that indicates whether the field can be dragged to the data region.
A value of 1 or true indicates the field can be dragged to the data region.
A value of 0 or false indicates the field cannot be dragged to the data region.
Defaults to:
null
Specifies a boolean value that indicates whether the field can be dragged to the page region.
A value of 1 or true indicates the field can be dragged to the page region.
A value of 0 or false indicates the field cannot be dragged to the page region.
Defaults to:
null
Specifies a boolean value that indicates whether the field can be dragged to the row axis.
A value of 1 or true indicates the field can be dragged to the row axis.
A value of 0 or false indicates the field cannot be dragged to the row axis.
Defaults to:
null
Set to true if you want to generate an attributes key on the template render data.
The value of this key is a concatenated string of pairs config_name=config_value.
This means that each config that will participate in the attributes has the same name
as the expected XML attribute. Changing the config name will have an impact on the XML
attribute.
In tplNonAttributes there is a list of configs that should not be part of attributes.
In tplAttributes define the configs that should be part of attributes.
If tplAttributes is empty then the all configs are used except for tplNonAttributes defined.
Note Do not rename the config names that are part of the attributes since they are
mapped to the xml attributes needed by the template.
Defaults to:
true
Specifies a boolean value that indicates whether new items that appear after a refresh should be hidden by default.
A value of 1 or true indicates that items that appear after a refresh should be hidden by default.
A value of 0 or false indicates that items that appear after a refresh should be shown by default.
Defaults to:
null
Specifies a boolean value that indicates whether manual filter is in inclusive mode.
A value of 1 or true indicates the manual filter is inclusive.
A value of 0 or false indicates the manual filter is not inclusive.
Defaults to:
null
Sets the value of includeNewItemsInFilter
includeNewItemsInFilter : Boolean
Specifies a boolean value that indicates whether to insert a blank row after each item.
A value of 1 or true indicates that a blank row is inserted after each item.
A value of 0 or false indicates no additional rows are inserted after each item.
Defaults to:
null
Sets the value of insertBlankRow
insertBlankRow : Boolean
Specifies a boolean value that indicates whether to insert a page break after each item.
A value of 1 or true indicates that a page break is inserted after each item.
A value of 0 or false indicates no page breaks are inserted after items.
Defaults to:
null
Sets the value of insertPageBreak
insertPageBreak : Boolean
Specifies the number of items showed per page in the PivotTable.
Defaults to:
null
Represents the collection of items in a PivotTable field. The items in the collection are ordered by index.
Items represent the unique entries from the field in the source data.
Defaults to:
null
Specifies a boolean value that indicates whether to apply the 'max' aggregation function in the subtotal of this field.
A value of 1 or true indicates that the 'max' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Defaults to:
null
Specifies a boolean value that indicates whether field has a measure based filter.
A value of 1 or true indicates the field has a measure-based filter.
A value of 0 or false indicates does not have a measure-based filter.
Defaults to:
null
Specifies a boolean value that indicates whether to apply the 'min' aggregation function in the subtotal of this field.
A value of 1 or true indicates that the 'min' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Defaults to:
null
Specifies a boolean value that indicates whether the field can have multiple items selected in the page field.
A value of 1 or true indicates the PivotTable can have multiple items selected in the page field.
A value of 0 or false indicates the PivotTable cannot have multiple items selected in the page field. This attribute depends on the application support for selecting multiple items in page fields.
Defaults to:
null
Sets the value of multipleItemSelectionAllowed
multipleItemSelectionAllowed : Boolean
Specifies a boolean value that indicates whether sort operation that is applied to field should be AutoSort operation or simple data sort operation.
A value of 1 or true indicates that an AutoSort operation is applied to the field.
A value of 0 or false indicates a simple data sort operation is applied to the field.
Defaults to:
null
Sets the value of nonAutoSortDefault
nonAutoSortDefault : Boolean
Specifies the identifier of the number format to apply to this field. Number formats are written to the styles part. See the Styles section (§18.8) for more information on number formats.
Formatting information provided by cell table and by PivotTable need not agree. If the two formats differ, the cell-level formatting takes precedence. If you change the layout the PivotTable, the PivotTable formatting will then take precedence.
Defaults to:
null
Specifies a boolean value that indicates whether the items in this field should be shown in Outline form.
A value of 1 or true indicates the items in this field is shown in Outline form.
A value of 0 or false indicates the items in this field will not be shown in Outline form.
This attribute depends on the application support for displaying items in Outline form.
Defaults to:
null
Specifies a boolean value that indicates whether to apply 'product' aggregation function in the subtotal of this field.
A value of 1 or true indicates that the 'product' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Defaults to:
null
Sets the value of productSubtotal
productSubtotal : Boolean
Specifies the index of the data field by which AutoShow will rank.
Defaults to:
null
Specifies a boolean value that indicates whether this is a server-based page field.
A value of 1 or true indicates this is a server-based page field.
A value of 0 or false indicates this is a local page field.
Defaults to:
null
Specifies a boolean value that indicates whether to show all items for this field.
A value of 1 or true indicates that all items be shown.
A value of 0 or false indicates items be shown according to user specified criteria.
Defaults to:
null
Specifies a boolean value that indicates whether to hide drop down buttons on PivotField headers. This attribute depends on the application implementation for filtering in the user interface.
A value of 1 or true indicates the application will display some mechanism for selecting and applying filters – [Example: A dropdown menu end example] – in the user interface.
A value of 0 or false indicates for mechanism for applying a filter is displayed in the user interface.
Defaults to:
null
Specifies a boolean value that indicates whether to show the property as a member caption.
A value of 1 or true indicates the property is shown as a member caption.
A value of 0 or false indicates the property will not be shown as a member caption.
Defaults to:
null
Sets the value of showPropAsCaption
showPropAsCaption : Boolean
Specifies a boolean value that indicates whether to show the member property value in a PivotTable cell.
A value of 1 or true indicates the property value is shown in a PivotTable cell.
A value of 0 or false indicates the property value will not be shown in a PivotTable cell.
Defaults to:
null
Specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate PivotTable cells.
A value of 1 or true indicates the property value is shown in a tooltip in the user interface.
A value of 0 or false indicates the property will not be shown in a tooltip. This attribute depends on whether the application employs tooltips or similar mechanism in the user interface.
Defaults to:
null
Specifies the type of sort that is applied to this field.
Possible values:
ascending: Indicates the field is sorted in ascending order.descending: Indicates the field is sorted in descending order.manual: Indicates the field is sorted manually.Defaults to:
null
Specifies a boolean value that indicates whether to apply the 'stdDevP' aggregation function in the subtotal of this field.
A value of 1 or true indicates that the 'stdDevP' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Defaults to:
null
Sets the value of stdDevPSubtotal
stdDevPSubtotal : Boolean
Specifies a boolean value that indicates whether to use 'stdDev' in the subtotal of this field.
A value of 1 or true indicates that the 'stdDev' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Defaults to:
null
Sets the value of stdDevSubtotal
stdDevSubtotal : Boolean
Specifies the custom text that is displayed for the subtotals label.
Defaults to:
null
Sets the value of subtotalCaption
subtotalCaption : String
Specifies a boolean value that indicates whether to display subtotals at the top of the group. Applies only when Outline its true.
A value of 1 or true indicates a subtotal is display at the top of the group.
A value of 0 or false indicates subtotal will not be displayed at the top of the group.
Defaults to:
null
Specifies a boolean value that indicates whether apply the 'sum' aggregation function in the subtotal of this field.
A value of 1 or true indicates the 'sum' aggregation function is applied in the subtotal of this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.
Defaults to:
null
Specifies a boolean value that indicates whether an AutoShow filter applied to this field is set to show the top ranked values.
A value of 1 or true indicates whether an AutoShow filter will show top values for this field.
A value of 0 or false indicates bottom ranked values are shown.
Defaults to:
null
Defaults to:
[
'idPrefix',
'id',
'autoGenerateId',
'self',
'tplAttributes',
'tplNonAttributes'
]
Sets the value of tplNonAttributes
tplNonAttributes : Object
Specifies the unique name of the member property to be used as a caption for the field and field items.
Defaults to:
null
Sets the value of uniqueMemberProperty
uniqueMemberProperty : String
Specifies a boolean value that indicates whether to apply the 'varP' aggregation function in the subtotal of this field.
A value of 1 or true indicates the 'varP' aggregation function is applied in the subtotal of this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.
Defaults to:
null
Specifies a boolean value that indicates whether to apply the 'variance' aggregation function in the subtotal of this field.
A value of 1 or true indicates the 'variance' aggregation function is applied in the subtotal of this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.
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
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 after the destroy method is called.
Defaults to:
false
Set to true if you want to generate an attributes key on the template render data.
The value of this key is a concatenated string of pairs config_name=config_value.
This means that each config that will participate in the attributes has the same name
as the expected XML attribute. Changing the config name will have an impact on the XML
attribute.
In tplNonAttributes there is a list of configs that should not be part of attributes.
In tplAttributes define the configs that should be part of attributes.
If tplAttributes is empty then the all configs are used except for tplNonAttributes defined.
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 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)
Returns the result of calling the overridden method
Deprecated since version 4.1.0
Use method-callParent instead.
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 in any way, including access to its methods and properties.
To prevent potential memory leaks, all object references will be nulled
at the end of destruction sequence, unless clearPropertiesOnDestroy
is set to false.
Destroys member properties by name.
If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.
The property will be destroyed, and the corrected name (if the property is a config
and config names are prefixed) will set to null in this object's dictionary.
args : String...
One or more names of the properties to destroy and remove from the object.
Builds a Collection decoder for the specified className.
klass : Object
Returns a collection item key
item : 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
ifInitialized : Boolean (optional)
true to only return the initialized property value,
not the raw config value, and not to trigger initialization. Returns undefined if the
property has not yet been initialized.
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'
instanceConfig : 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.
Use this function to pre process the render data before applying it to the template
data : Object
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 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