Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

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 method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

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.

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

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

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:

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.

Ext JS 7.2.0 - Modern Toolkit


top

NPM Package

@sencha/ext-core

Hierarchy

Ext.Base
Ext.Mixin
Ext.data.LocalStore

Requires

Ext.data.Group

NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.

Summary

A mixin that provides common store methods for Ext.data.Store & Ext.data.ChainedStore.

No members found using the current filters

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

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

$configStrict : Boolean
private pri

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

$configTransforms : Object / Array
private pri

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

Defaults to:

{}

clearPropertiesOnDestroy : Boolean / "async"
protected pro

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

clearPrototypeOnDestroy : Boolean
private pri

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

destroyed : Boolean

This property is set to true after the destroy method is called.

Defaults to:

false

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

self : Ext.Class
protected pro

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

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

add ( record ) : Ext.data.Model[]

Adds Model instance to the Store. This method accepts either:

  • An array of Model instances or Model configuration objects.
  • Any number of Model instance or Model configuration object arguments.

The new Model instances will be added at the end of the existing collection.

Sample usage:

myStore.add({some: 'data'}, {some: 'other data'});

Note that if this Store is sorted, the new Model instances will be inserted at the correct point in the Store to maintain the sort order.

Parameters

record :  Ext.data.Model[]/Ext.data.Model.../Object[]/Object...

An array of records or configuration objects, or variable number of record or config arguments.

Returns

:Ext.data.Model[]

The record instances that were added.

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

aggregate ( fn, [scope], [grouped], field ) : Object

Runs the aggregate function for all the records in the store.

When store is filtered, only items within the filter are aggregated.

Parameters

fn :  Function

The function to execute. The function is called with a single parameter, an array of records for that group.

scope :  Object (optional)

The scope to execute the function in. Defaults to the store.

grouped :  Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the group average being the value. The grouped parameter is only honored if the store has a groupField.

field :  String

The field to get the value from

Returns

:Object

An object literal with the group names and their appropriate values.

average ( field, [grouped] ) : Object

Gets the average value in the store.

When store is filtered, only items within the filter are aggregated.

Parameters

field :  String

The field in each record

grouped :  Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the group average being the value. The grouped parameter is only honored if the store has a groupField.

Returns

:Object

The average value, if no items exist, 0.

callOverridden ( args ) : Object
deprecated dep protected pro

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"

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the overridden method

Deprecated since version 4.1.0
Use method-callParent instead.

callParent ( args ) : Object
protected pro

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.

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the superclass method

collect ( property, [includeOptions], [filtered] ) : Object[]

Collects unique values for a particular dataIndex from this store.

Note that the filtered option can also be passed as a separate parameter for compatibility with previous versions.

var store = Ext.create('Ext.data.Store', {
    fields: ['name'],
    data: [{
        name: 'Larry'
    }, {
        name: 'Darryl'
    }, {
        name: 'Darryl'
    }]
});

store.collect('name');
// returns ["Larry", "Darryl"]

Parameters

property :  String

The property to collect

includeOptions :  Object (optional)

An object which contains options which modify how the store is traversed. For compatibility, this argument may be the allowNull value itself. If so, the next argument is the filtered value.

allowNull :  Boolean (optional)

Pass true to allow null, undefined or empty string values.

filtered :  Boolean (optional)

Pass true to collect from all records, even ones which are filtered.

filtered :  Boolean (optional)

This argument only applies when the legacy call form is used and includeOptions is actually the allowNull value.

Returns

:Object[]

An array of the unique values

count ( [grouped] ) : Number

Gets the count of items in the store.

When store is filtered, only items within the filter are counted.

Parameters

grouped :  Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the count for each group being the value. The grouped parameter is only honored if the store has a groupField.

Returns

:Number

the count

createModel ( record ) : Ext.data.Model
private pri

Converts a literal to a model, if it's not a model already

Parameters

record :  Ext.data.Model/Object

The record to create

Returns

:Ext.data.Model

destroy

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.

destroyMembers ( args )

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.

Parameters

args :  String...

One or more names of the properties to destroy and remove from the object.

each ( fn, [scope], [includeOptions] )

Calls the specified function for each Ext.data.Model in the store.

When store is filtered, only loops over the filtered records.

Parameters

fn :  Function

The function to call. The Ext.data.Model is passed as the first parameter. Returning false aborts and exits the iteration.

scope :  Object (optional)

The scope (this reference) in which the function is executed. Defaults to the current Ext.data.Model in the iteration.

includeOptions :  Object/Boolean (optional)

An object which contains options which modify how the store is traversed. Or simply the filtered option.

filtered :  Boolean (optional)

Pass true to include filtered out nodes in the iteration.

first ( [grouped] ) : Ext.data.Model/undefined

Convenience function for getting the first model instance in the store.

When store is filtered, will return first item within the filter.

Parameters

grouped :  Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the first record being the value. The grouped parameter is only honored if the store has a groupField.

Returns

:Ext.data.Model/undefined

The first model instance in the store, or undefined

getById ( id ) : Ext.data.Model

Get the Record with the specified id.

This method is not affected by filtering, lookup will be performed from all records inside the store, filtered or not.

Parameters

id :  Mixed

The id of the Record to find.

Returns

:Ext.data.Model

The Record with the passed id. Returns null if not found.

getByInternalId ( internalId ) : Ext.data.Model
private pri

Get the Record with the specified internalId.

This method is not affected by filtering, lookup will be performed from all records inside the store, filtered or not.

Parameters

internalId :  Mixed

The id of the Record to find.

Returns

:Ext.data.Model

The Record with the passed internalId. Returns null if not found.

getConfig ( [name], [peek], [ifInitialized] ) : 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.

Parameters

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

Returns

:Object

The config property value.

getDataSource
private pri

Returns the complete unfiltered collection.

getInitialConfig ( [name] ) : Object/Mixed

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

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed

The full config object or a single config value when name parameter specified.

getSummaryRecord Ext.data.Model

Get the summary record for this store. See Ext.data.Model#summary.

Available since: 6.5.0

Returns

:Ext.data.Model

hasConfig ( name )
private pri

Parameters

name :  String

indexOf ( record ) : Number

Get the index of the record within the store.

When store is filtered, records outside of filter will not be found.

Parameters

record :  Ext.data.Model

The Ext.data.Model object to find.

Returns

:Number

The index of the passed Record. Returns -1 if not found.

indexOfId ( id ) : Number

Get the index within the store of the Record with the passed id.

Like #indexOf, this method is affected by filtering.

Parameters

id :  String

The id of the Record to find.

Returns

:Number

The index of the Record. Returns -1 if not found.

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

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'

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

insert ( index, records ) : Ext.data.Model[]

Inserts Model instances into the Store at the given index and fires the add event. See also method-add.

Parameters

index :  Number

The start index at which to insert the passed Records.

records :  Ext.data.Model/Ext.data.Model[]/Object/Object[]

An Ext.data.Model instance, the data needed to populate an instance or an array of either of these.

Returns

:Ext.data.Model[]

records The added records

last ( [grouped] ) : Ext.data.Model/undefined

Convenience function for getting the last model instance in the store.

When store is filtered, will return last item within the filter.

Parameters

grouped :  Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the last record being the value. The grouped parameter is only honored if the store has a groupField.

Returns

:Ext.data.Model/undefined

The last model instance in the store, or undefined

max ( field, [grouped] ) : Object

Gets the maximum value in the store.

When store is filtered, only items within the filter are aggregated.

Parameters

field :  String

The field in each record

grouped :  Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the maximum in the group being the value. The grouped parameter is only honored if the store has a groupField.

Returns

:Object

The maximum value, if no items exist, undefined.

min ( field, [grouped] ) : Object

Gets the minimum value in the store.

When store is filtered, only items within the filter are aggregated.

Parameters

field :  String

The field in each record

grouped :  Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the minimum in the group being the value. The grouped parameter is only honored if the store has a groupField.

Returns

:Object

The minimum value, if no items exist, undefined.

query ( property, value, [anyMatch], [caseSensitive], [exactMatch] ) : Ext.util.Collection

Query all the cached records in this Store by name/value pair. The parameters will be used to generated a filter function that is given to the queryBy method.

This method complements queryBy by generating the query function automatically.

This method is not affected by filtering, it will always search all records in the store regardless of filtering.

Parameters

property :  String

The property to create the filter function for

value :  String/RegExp

The string/regex to compare the property value to

anyMatch :  Boolean (optional)

True to match any part of the string, not just the beginning.

Defaults to: false

caseSensitive :  Boolean (optional)

true to create a case-sensitive regex.

Defaults to: false

exactMatch :  Boolean (optional)

True to force exact match (^ and $ characters added to the regex). Ignored if anyMatch is true.

Defaults to: false

Returns

:Ext.util.Collection

The matched records

queryBy ( fn, [scope] ) : Ext.util.Collection

Query all the cached records in this Store using a filtering function. The specified function will be called with each record in this Store. If the function returns true the record is included in the results.

This method is not affected by filtering, it will always search all records in the store regardless of filtering.

Parameters

fn :  Function

The function to be called. It will be passed the following parameters:

record :  Ext.data.Model

The record to test for filtering. Access field values using Ext.data.Model#get.

id :  Object

The ID of the Record passed.

scope :  Object (optional)

The scope (this reference) in which the function is executed Defaults to this Store.

Returns

:Ext.util.Collection

The matched records

queryRecords ( field, value ) : Ext.data.Model[]
private pri

Query all the cached records in this Store by field.

This method is not affected by filtering, it will always search all records in the store regardless of filtering.

Parameters

field :  String

The field from each record to use.

value :  Object

The value to match.

Returns

:Ext.data.Model[]

The matched records.

queryRecordsBy ( fn, [scope] ) : Ext.data.Model[]
private pri

Query all the cached records in this Store using a filtering function. The specified function will be called with each record in this Store. If the function returns true the record is included in the results.

This method is not affected by filtering, it will always search all records in the store regardless of filtering.

Parameters

fn :  Function

The function to be called. It will be passed the following parameters:

record :  Ext.data.Model

The record to test for filtering.

scope :  Object (optional)

The scope (this reference) in which the function is executed Defaults to this Store.

Returns

:Ext.data.Model[]

The matched records.

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

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.

Returns

:Ext.Base

this

statics Ext.Class
protected pro

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();

        // always equals to 'Cat' no matter what 'this' refers to
        // equivalent to: My.Cat.speciesName
        alert(statics.speciesName);


        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self();   // dependent on 'this'

        // equivalent to: My.Cat.speciesName
        cloned.groupName = this.statics().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

Returns

:Ext.Class

sum ( field, [grouped] ) : Number

Sums the value of field for each Ext.data.Model in store and returns the result.

When store is filtered, only sums items within the filter.

Parameters

field :  String

A field in each record

grouped :  Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the sum for that group being the value. The grouped parameter is only honored if the store has a groupField.

Returns

:Number

The sum

watchConfig ( name, fn, scope )
private pri

Watches config properties.

 instance.watchConfig({
     title: 'onTitleChange',
     scope: me
 });

Available since: 6.7.0

Parameters

name :  Object

fn :  Object

scope :  Object

Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

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.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member, privacy ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

privacy :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

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();

Parameters

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

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

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() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base

this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

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 '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

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.

Returns

:Object

the created instance.

createAlias ( alias, origin )
static sta

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

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

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'

Returns

:String

className

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch static sta

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

Parameters

members :  Object

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

Returns

:Ext.Base

this class

triggerExtended
static sta private pri

Ext JS 7.2.0 - Modern Toolkit