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.
The TreeStore is a store implementation that owns the root node of a tree, and provides methods to load either local or remote data as child nodes of the root and any descendant non-leaf node.
The TreeStore must be used as the store of a Ext.tree.Panel.
This class also relays many node events from the underlying node structure.
If no Model is specified, an implicit model will be created that extends Ext.data.TreeModel. The standard Tree fields will also be copied onto the Model for maintaining their state. These fields are listed in the Ext.data.NodeInterface documentation.
For the tree to read nested data, the Ext.data.reader.Reader must be configured with a root property, so the reader can find nested data for each node (if a root is not specified, it will default to 'children'). This will tell the tree to look for any nested tree nodes by the same keyword, i.e., 'children'. If a root is specified in the config make sure that any nested nodes with children have the same name. Note that setting defaultRootProperty accomplishes the same thing.
The owner of this store if the store is used as part of an association.
Defaults to:
null
Sets the value of associatedEntity
associatedEntity : Ext.data.Model
When a Store is used by only one Ext.view.View, and should only exist for the lifetime of that view, then
configure the autoDestroy flag as true
. This causes the destruction of the view to trigger the destruction of its Store.
Defaults to:
undefined
If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method.
Defaults to:
undefined
Available since: 2.3.0
True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.
Defaults to:
false
Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal representation of the data after each operation of the batch has completed, 'complete' will wait until the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.
Defaults to:
'operation'
Sets the value of batchUpdateMode
batchUpdateMode : String
The event name to bubble, or an Array of event names.
Defaults to:
null
True to empty the store when loading another page via loadPage, nextPage or previousPage. Setting to false keeps existing records, allowing large data sets to be loaded one page at a time but rendered all together.
Defaults to:
true
Sets the value of clearOnPageLoad
clearOnPageLoad : Boolean
If true
, when a node is reloaded, any records in the removed record collection that were previously descendants of the node being reloaded will be cleared from the removed collection.
Only applicable if clearOnLoad is true
.
Defaults to:
true
Sets the value of clearRemovedOnLoad
clearRemovedOnLoad : Boolean
Array of Model instances or data objects to load locally. See "Inline data" above for details.
Defaults to:
0
Defaults to:
"children"
Sets the value of defaultRootProperty
defaultRootProperty : String
If you wish to create a TreeGrid, and configure your tree with a Ext.panel.Table#cfg-columns columns configuration, it is possilble to define the set of fields you wish to use in the Store instead of configuting the store with a cfg-model.
By default, the Store uses an Ext.data.TreeModel. If you configure fields, it uses a subclass of Ext.data.TreeModel defined with the set of fields that you specify (In addition to the fields which it uses for storing internal state).
Array of Ext.util.Filter for this store. Can also be passed array of functions which will be used as the filterFn config for filters:
filters: [
function(item) {
return item.weight > 0;
}
]
Individual filters can be specified as an Ext.util.Filter
instance, a config
object for Ext.util.Filter
or simply a function that will be wrapped in a
instance with its {@Ext.util.Filter#filterFn filterFn} set.
For fine grain control of the filters collection, call getFilters
to return
the Ext.util.Collection
instance that holds this store's filters.
var filters = store.getFilters(); // an Ext.util.FilterCollection
function legalAge (item) {
return item.age >= 21;
}
filters.add(legalAge);
//...
filters.remove(legalAge);
Any changes to the filters
collection will cause this store to adjust
its items accordingly.
Defaults to:
undefined
The direction in which sorting should be applied when grouping. Supported values are "ASC" and "DESC".
Defaults to:
'ASC'
The grouper by which to group the data store. May also be specified by the groupField config, however they should not be used together.
Defaults to:
null
The field by which to group data in the store. Internally, grouping is very similar to sorting - the groupField and groupDir are injected as the first sorter (see sort). Stores support a single level of grouping, and groups can be fetched via the getGroups method.
Defaults to:
undefined
A config object containing one or more event handlers to be added to this object during initialization. This
should be a valid listeners config
object as specified in the addListener example for attaching
multiple handlers at once.
See the Event guide for more
Note: It is bad practice to specify a listener's config
when you are defining a class using Ext.define()
.
Instead, only specify listeners when you are instantiating your class with Ext.create()
.
Defaults to:
null
Name of the Ext.data.Model associated with this store. See Ext.data.Model#entityName.
May also be the actual Model subclass.
This config is required for the store to be able to read data unless you have defined
the fields config which will create an anonymous Ext.data.Model
.
Defaults to:
undefined
The Record you want to bind this Store to. Note that this record will be decorated with the Ext.data.NodeInterface if this is not the case yet.
Defaults to:
null
The name of the parameter sent to the server which contains the identifier of the node.
Defaults to:
"node"
The number of records considered to form a 'page'. This is used to power the built-in paging using the nextPage and previousPage functions when the grid is paged using a Ext.toolbar.Paging Defaults to 25.
To disable paging, set the pageSize to 0
.
Defaults to:
25
This config allows node data to be returned from the server in linear format without having to structure it into children
arrays.
This property specifies which property name in the raw node data yields the id of the parent node.
For example the following data would be read into a geographic tree by configuring the TreeStore with parentIdProperty: 'parentId'
.
The node data contains an upward link to a parent node.
data: [{
name: 'North America',
id: 'NA'
}, {
name: 'Unites States',
id: 'USA',
parentId: 'NA'
}, {
name: 'Redwood City',
leaf: true,
parentId: 'USA'
}, {
name: 'Frederick, MD',
leaf: true,
parentId: 'USA'
}]
Defaults to:
null
Sets the value of parentIdProperty
parentIdProperty : String
The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance - see setProxy for details.
Defaults to:
undefined
Available since: 1.1.0
Set this to true
if you want this NodeStore to represent
all the descendants of the node in its flat data collection. This is useful for
rendering a tree structure to a DataView and is being used internally by
the TreeView. Any records that are moved, removed, inserted or appended to the
node at any depth below the node this store is bound to will be automatically
updated in this Store's internal flat data structure.
Defaults to:
false
true
to defer any filtering operation to the server. If false
, filtering is done locally on the client.
Defaults to:
false
true
if the sorting should be performed on the server side, false if it is local only.
Defaults to:
false
The root node for this store. For example:
root: {
expanded: true,
text: "My Root",
children: [
{ text: "Child 1", leaf: true },
{ text: "Child 2", expanded: true, children: [
{ text: "GrandChild", leaf: true }
] }
]
}
Setting the root
config option is the same as calling setRootNode.
Defaults to:
null
Sets the value of root
root : Ext.data.TreeModel / Ext.data.NodeInterface / Object
false
to not include the root node in this Stores collection.
Defaults to:
false
The session for this store. By specifying a session, it ensures any records that are added to this store are also included in the session. This store does not become a member of the session itself.
Defaults to:
null
Available since: 5.0.0
The initial set of Ext.util.Sorter
Individual sorters can be specified as an Ext.util.Sorter
instance, a config
object for Ext.util.Sorter
or simply the name of a property by which to sort.
An alternative way to extend the sorters is to call the sort
method and pass
a property or sorter config to add to the sorters.
For fine grain control of the sorters collection, call getSorters
to return
the Ext.util.Collection
instance that holds this collection's sorters.
var sorters = store.getSorters(); // an Ext.util.SorterCollection
sorters.add('name');
//...
sorters.remove('name');
Any changes to the sorters
collection will cause this store to adjust
its items accordingly.
Defaults to:
undefined
If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, ignored if remoteSort is true
Defaults to:
true
Configure as true
to have the filters saved when a client Ext.grid.Panel saves its state.
Defaults to:
false
Sets the value of statefulFilters
statefulFilters : Boolean
Unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager, making it easy to reuse elsewhere.
Note that when store is instatiated by Controller, the storeId will be overridden by the name of the store.
Defaults to:
null
This config controls whether removed records are remembered by this store for later saving to the server.
Defaults to:
true
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:
false
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
The data
property is a Collection
which holds this store's local cache of records.
If this property is specified by the target class of this mixin its properties are
used to configure the created Ext.Factory
.
This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class or on the Ext.app.EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.
The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:
if (this.hasListeners.foo) {
this.fireEvent('foo', this, arg1);
}
True if a model was created implicitly for this Store. This happens if a fields array is passed to the Store's constructor instead of a model constructor or name.
Defaults to:
false
This property is set to true
during the call to initConfig
.
Defaults to:
false
Available since: 5.0.0
True if the Store has already been destroyed. If this is true, the reference to Store should be deleted as it will not function correctly any more.
Defaults to:
false
Available since: 3.4.0
Recursion level counter. Incremented when expansion or collaping of a node is initiated, including when nested nodes below the expanding/collapsing root begin expanding or collapsing.
This ensures that collapsestart, collapsecomplete, expandstart and expandcomplete only fire on the top level node being collapsed/expanded.
Also, allows listeners to the add
and remove
events to know whether a collapse of expand is in progress.
Defaults to:
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
true
in this class to identify an object as an instantiated NodeStore, or subclass thereof.
Defaults to:
true
true
in this class to identify an object as an instantiated Store, or subclass thereof.
Defaults to:
true
true
in this class to identify an object as an instantiated TreeStore, or subclass thereof.
Defaults to:
true
Property to hold the last options from a method-load method call. This object is used for the method-reload to reuse the same options. Please see method-reload for a simple example on how to use the lastOptions property.
The number of times records have been loaded into the store. This includes loads via loadData & loadRecords.
Defaults to:
0
Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, at which point this is cleared.
This cache is maintained unless you set trackRemoved
to false
.
Defaults to:
[]
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
A counter that is increased by beginUpdate
and decreased by endUpdate
. When
this transitions from 0 to 1 the beginupdate
event is
fired. When it transitions back from 1 to 0 the endupdate
event is fired.
Defaults to:
0
Available since: 5.0.0
Adds Model instance to the Store. This method accepts either:
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.
model : Ext.data.Model[]/Ext.data.Model.../Object[]/Object...
An array of Model instances or Model configuration objects, or variable number of Model instance or config arguments.
The model instances that were added
Appends an after-event handler.
Same as addListener with order
set to 'after'
.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn
.
options : Object (optional)
An object containing handler configuration.
Appends a before-event handler. Returning false
from the handler will stop the event.
Same as addListener with order
set to 'before'
.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn
.
options : Object (optional)
An object containing handler configuration.
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated
config.
deprecations : Object
Adds the specified events to the list of events which this Observable may fire.
eventNames : Object/String...
Either an object with event names as properties with a value of true
or the first event name string if multiple event names are being passed as separate parameters.
Deprecated since version 2.0
It's no longer needed to add events before firing.
Adds a new Filter to this Store's filter set and by default, applys the updated filter set to the Store's unfiltered dataset.
filters : Object[]/Ext.util.Filter[]
The set of filters to add to the current filter set.
Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener:
container.addListener('tap', this.handleTap, this, {
single: true,
delay: 100
});
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
container.addListener({
tap : this.onTap,
swipe: this.onSwipe,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
container.addListener({
tap : { fn: this.onTap, scope: this, single: true },
swipe: { fn: button.onSwipe, scope: button }
});
See the Events Guide for more.
eventName : String/String[]/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String
The method the event invokes. Will be called with arguments given to
fireEvent plus the options
parameter described below.
scope : Object (optional)
The scope (this
reference) in which the handler function is executed. If
omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
This object may contain any of the following properties:
scope : Object (optional)
The scope (this
reference) in which the handler function is executed. If omitted, defaults to the object
which fired the event.
delay : Number (optional)
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean (optional)
true
to add a handler to handle just the next firing of the event, and then remove itself.
order : String (optional)
The order of when the listener should be added into the listener queue.
If you set an order of before
and the event you are listening to is preventable, you can return false
and it will stop the event.
Available options are before
, current
and after
.
Defaults to:
current
buffer : Number (optional)
Causes the handler to be delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
element : String (optional)
If this observable is a Component, allows you to add a listener onto a element of the component using the element's reference.
Ext.create('Ext.Component', {
listeners: {
element: 'element',
tap: function() {
alert('element tap!');
}
}
});
In Sencha Touch, All components have the element
reference, which is the outer
most element of the component. Ext.Container also has the innerElement
element which contains all children. In most cases element
is adequate.
delegate : String (optional)
For Ext.dom.Element, a simple DOM selector to filter the target or look for a descendant of the target.
Sencha Touch Components can use Ext.ComponentQuery selectors to filter child Components.
// Create a container with a two children; a button and a toolbar
var container = Ext.create('Ext.Container', {
items: [
{
xtype: 'toolbar',
docked: 'top',
title: 'My Toolbar'
},
{
xtype: 'button',
text: 'My Button'
}
]
});
container.addListener({
// Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
delegate: 'button',
tap: function() {
alert('Button tapped!');
}
});
capture : Boolean
true
to initiate capture which will fire the
listeners on the target Element before any descendant Elements. Normal events
start with the target element and propagate upward to ancestor elements, whereas
captured events propagate from the top of the DOM downward to descendant elements.
This option achieves the same result as the useCapture parameter in the standard
JavaScript addEventListener method.
order : String (optional)
The order of when the listener should be added into the listener queue.
Possible values are before
, current
and after
.
Defaults to: 'current'
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
eventName : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the eventName
parameter was an event name, this is the handler function.
scope : Object (optional)
If the eventName
parameter was an event name, this is the scope in which
the handler function is executed.
options : Object (optional)
If the eventName
parameter was an event name, this is the
addListener options.
Deprecated since version 2.0
All listeners are now automatically managed where necessary. Simply use addListener.
(Local sort only) Inserts the passed Record into the Store at the index where it should go based on the current sort information.
record : Ext.data.Model
A model instance should call this method on the Store it has been joined to.
Available since: 3.4.0
record : Ext.data.Model
The model instance that was edited
A model instance should call this method on the Store it has been joined to..
Available since: 3.4.0
record : Ext.data.Model
The model instance that was edited
Runs the aggregate function for all the records in the store.
When store is filtered, only items within the filter are aggregated.
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
An object literal with the group names and their appropriate values.
Gets the average value in the store.
When store is filtered, only items within the filter are aggregated.
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.
The average value, if no items exist, 0.
This method may be called to indicate the start of multiple changes to the store.
Automatic synchronization as configured by the autoSync flag is deferred until the endUpdate method is called, so multiple mutations can be coalesced into one synchronization operation.
Internally this method increments a counter that is decremented by endUpdate
. It
is important, therefore, that if you call beginUpdate
directly you match that
call with a call to endUpdate
or you will prevent the collection from updating
properly.
For example:
var store = Ext.StoreManager.lookup({
//...
autoSync: true
});
store.beginUpdate();
record.set('fieldName', 'newValue');
store.add(item);
// ...
store.insert(index, otherItem);
//...
// Interested parties will listen for the endupdate event
store.endUpdate();
Available since: 5.0.0
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 methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
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',
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 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 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
actionFn : Object
eventName : Object
fn : Object
scope : Object
options : Object
order : Object
Reverts to a view of the Record cache with no filtering applied.
suppressEvent : Boolean (optional)
If true
the filter is cleared silently.
For a locally filtered Store, this means that the filter collection is cleared without firing the datachanged event.
For a remotely filtered Store, this means that the filter collection is cleared, but the store is not reloaded from the server.
Removes all records that used to be descendants of the passed node from the removed array
node : Ext.data.NodeInterface
Collects unique values for a particular dataIndex from this store.
dataIndex : String
The property to collect
allowNull : Boolean (optional)
Pass true to allow null, undefined or empty string values
bypassFilter : Boolean (optional)
Pass true to collect from all records, even ones which are filtered.
An array of the unique values
Commits all Records with outstanding changes. To handle updates for changes, subscribe to the Store's update event, and perform updating when the third parameter is Ext.data.Record.COMMIT.
Checks if a record is in the current active data set.
record : Ext.data.Model
The record
true
if the record is in the current active data set.
Gets the count of items in the store.
When store is filtered, only items within the filter are counted.
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.
the count
Creates an event handling function which re-fires the event from this object as the passed event name.
newName : String
Converts a literal to a model, if it's not a model already
record : Ext.data.Model/Object
The record to create
This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further.
name : Object
fn : Object
scope : Object
options : Object
order : Object
Calls the specified function for each Ext.data.Model in the store.
When store is filtered, only loops over the filtered records.
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.
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if
present. There is no implementation in the Observable base class.
events : String/String[]
The event name to bubble, or an Array of event names.
This method is called after modifications are complete on a store. For details
see beginUpdate
.
Available since: 5.0.0
Fills a node with a series of child records.
node : Ext.data.NodeInterface
The node to fill
newNodes : Ext.data.TreeModel[]
The records to add
Filters by a function. The specified function will be called for each
Record in this Store. If the function returns true
the Record is included,
otherwise it is filtered out.
When store is filtered, most of the methods for accessing store data will be working only within the set of filtered records. The notable exception is getById.
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.
Finds the index of the first matching Record in this store by a specific field value.
When store is filtered, finds records only within filter.
**IMPORTANT
If this store is Ext.data.BufferedStore, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**
property : String
The name of the Record field to test.
value : String/RegExp
Either a string that the field value should begin with, or a RegExp to test against the field.
startIndex : Number (optional)
The index to start searching at
Defaults to: 0
anyMatch : Boolean (optional)
True to match any part of the string, not just the beginning.
Defaults to: false
caseSensitive : Boolean (optional)
True for case sensitive comparison
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
The matched index or -1
Find the index of the first matching Record in this Store by a function.
If the function returns true
it is considered a match.
When store is filtered, finds records only within filter.
**IMPORTANT
If this store is Ext.data.BufferedStore, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**
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.
startIndex : Number (optional)
The index to start searching at
Defaults to: 0
The matched index or -1
Finds the index of the first matching Record in this store by a specific field value.
When store is filtered, finds records only within filter.
**IMPORTANT
If this store is Ext.data.BufferedStore, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**
fieldName : String
The name of the Record field to test.
value : Object
The value to match the field against.
startIndex : Number (optional)
The index to start searching at
Defaults to: 0
The matched index or -1
Finds the first matching Record in this store by a specific field value.
When store is filtered, finds records only within filter.
**IMPORTANT
If this store is Ext.data.BufferedStore, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**
fieldName : String
The name of the Record field to test.
value : String/RegExp
Either a string that the field value should begin with, or a RegExp to test against the field.
startIndex : Number (optional)
The index to start searching at
Defaults to: 0
anyMatch : Boolean (optional)
True to match any part of the string, not just the beginning.
Defaults to: false
caseSensitive : Boolean (optional)
True for case sensitive comparison
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
The matched record or null
Fires the specified event with the passed parameters and execute a function (action)
at the end if there are no listeners that return false
.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handers.
fn : Function
Action.
scope : Object
Scope of fn.
Fires the specified event with the passed parameters (minus the event name, plus the options
object passed
to addListener).
The first argument is the name of the event. Every other argument passed will be available when you listen for the event.
Firstly, we set up a listener for our new event.
this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
console.log(arg1); // true
console.log(arg2); // 2
console.log(arg3); // { test: 'foo' }
console.log(arg4); // 14
console.log(options); // the options added when adding the listener
console.log(e); // the event object with information about the event
});
And then we can fire off the event.
this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);
An event may be set to bubble up an Observable parent hierarchy by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object...
Variable number of parameters are passed to handlers.
Returns false
if any of the handlers return false
.
Fires the specified event with the passed parameter list.
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object[]
An array of parameters which are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Convenience function for getting the first model instance in the store.
When store is filtered, will return first item within the filter.
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.
The first model instance in the store, or undefined
Get the Record at the specified index.
The index is effected by filtering.
index : Number
The index of the Record to find.
The Record at the passed index. Returns undefined if not found.
Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. This is broken out into a separate function to allow for customisation of the listeners
The listeners object
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.
id : Mixed
The id of the Record to find.
The Record with the passed id. Returns null if not found.
Get the Record with the specified internalId.
This method is not effected by filtering, lookup will be performed from all records inside the store, filtered or not.
internalId : Mixed
The id of the Record to find.
The Record with the passed internalId. Returns null if not found.
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.
Gets the number of records in store.
If using paging, this may not be the total size of the dataset. If the data object used by the Reader contains the dataset size, then the Ext.data.ProxyStore#getTotalCount function returns the dataset size. Note: see the Important note in Ext.data.ProxyStore#method-load.
When store is filtered, it's the number of records matching the filter.
The number of Records in the Store.
Returns an array containing the result of applying grouping to the records in this store. See groupField, groupDir. Example for a store containing records with a color field:
var myStore = Ext.create('Ext.data.Store', {
groupField: 'color',
groupDir : 'DESC'
});
myStore.getGroups(); // returns:
[
{
name: 'yellow',
children: [
// all records where the color field is 'yellow'
]
},
{
name: 'red',
children: [
// all records where the color field is 'red'
]
}
]
Group contents are effected by filtering.
The grouped data
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
id
Returns the initial configuration passed to constructor when instantiating this class.
name : String (optional)
Name of the config option to return.
The full config object or a single config value
when name
parameter specified.
Gets all Ext.data.Model added or updated since the last commit. Note that the order of records returned is not deterministic and does not indicate the order in which records were modified. Note also that removed records are not included (use getRemovedRecords for that).
The added and updated Model instances
Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not yet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)
The Model instances
Returns the record node by id
id : String
The id of the node to get.
Gathers a range of Records between specified indices.
This method is affected by filtering.
start : Number
The starting index. Defaults to zero.
end : Number
The ending index. Defaults to the last record. The end index is included.
An array of records.
Returns any records that have been removed from the store but not yet destroyed on the proxy.
The removed Model instances
Returns the root node for this tree.
Deprecated since version 5.0
Use getRoot instead
Returns the total number of Ext.data.Model instances that the Ext.data.proxy.Proxy indicates exist. This will usually differ from getCount when using paging - getCount returns the number of records loaded into the Store at the moment, getTotalCount returns the number of records that could be loaded into the Store if the Store contained all data
The total number of Model instances available via the Proxy. 0 returned if no value has been set via the reader.
Returns all valid, non-phantom Model instances that have been updated in the Store but not yet synchronized with the Proxy.
The updated Model instances
Groups data inside the store.
grouper : String/Object
Either a string name of one of the fields in this Store's configured Ext.data.Model, or an object, or a Ext.util.Grouper configuration object.
direction : String (optional)
The overall direction to group the data by. Defaults to the value of groupDir.
Checks to see if this object has any listeners for a specified event
eventName : String
The name of the event to check for
True if the event is being listened for, else false
Returns true if the store has a pending load task.
true
if the store has a pending load task.
Get the index of the record within the store.
When store is filtered, records outside of filter will not be found.
record : Ext.data.Model
The Ext.data.Model object to find.
The index of the passed Record. Returns -1 if not found.
Get the index within the store of the Record with the passed id.
Like #indexOf, this method is effected by filtering.
id : String
The id of the Record to find.
The index of the Record. Returns -1 if not found.
Gets the index of next visible node at either the same sibling level or a higher level.
This is to facilitate bulk removal of visible descendant nodes. eg in the following case TreeStore.indexOfNextVisibleNode(bletch) must return indexOf(belch) - the next sibling.
But TreeStore.indexOfNextVisibleNode(blivit) and TreeStore.indexOfNextVisibleNode(screeble) and TreeStore.indexOfNextVisibleNode(poot) must also return return indexOf(belch)
foo
├ bar
├ bletch
│ ├ zarg
│ └ blivit
│ ├ ik
│ └ screeble
│ ├ raz
│ └ poot
├ belch
apresfoo
This is so that removal of nodes at full depth can be optimized into one removeAt(start, length) call.
node : Object
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
Inserts Model instances into the Store at the given index and fires the event-add event. See also method-add.
index : Number
The start index at which to insert the passed Records.
records : Ext.data.Model[]
An Array of Ext.data.Model objects to add to the store.
records The added records
Tests whether the store currently has any active filters.
true
if the store is filtered.
Tests whether the store currently has an active grouper.
true
if the store is grouped.
Returns true
if the Store has been loaded.
true
if the Store has been loaded.
Returns true if the Store is currently performing a load operation
true
if the Store is currently loading
Tests whether the store currently has any active sorters.
true
if the store is sorted.
Checks if all events, or a specific event, is suspended.
eventName : String (optional)
The name of the specific event to check
true
if events are suspended
Convenience function for getting the last model instance in the store.
When store is filtered, will return last item within the filter.
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.
The last model instance in the store, or undefined
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.
Loads the Store using its configured proxy.
options : Object
config object. This is passed into the Ext.data.operation.Operation object that is created and then sent to the proxy's Ext.data.proxy.Proxy#read function. The options can also contain a node, which indicates which node is to be loaded. If not specified, it will default to the root node.
Loads an array of data straight into the Store.
Using this method is great if the data is in the correct format already (e.g. it doesn't need to be processed by a reader). If your data requires processing to decode the data structure, use a Ext.data.proxy.Memory or loadRawData.
data : Ext.data.Model[]/Object[]
Array of data to load. Any non-model instances will be cast into model instances first.
append : Boolean (optional)
true
to add the records to the existing records in the store, false
to remove the old ones first.
Defaults to: false
Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a normal load operation, passing in calculated 'start' and 'limit' params.
page : Number
The number of the page to load.
options : Object (optional)
See options for method-load.
Loads data via the bound Proxy's reader
Use this method if you are attempting to load data and want to utilize the configured data reader.
As of 4.2, this method will no longer fire the event-load event.
data : Object[]
The full JSON object you'd like to load into the Data store.
append : Boolean (optional)
true
to add the records to the existing records in the store, false
to remove the old ones first.
Defaults to: false
true
if the reader processed the records correctly. See Ext.data.reader.Reader#successProperty.
If the reader did not process the records, nothing will be added.
Loads an array of Ext.data.Model instances into the store, fires the datachanged event. This should only usually be called internally when loading from the Ext.data.proxy.Proxy, when adding records manually use method-add instead
records : Ext.data.Model[]
The array of records to load
options : Object
Gets the maximum value in the store.
When store is filtered, only items within the filter are aggregated.
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.
The maximum value, if no items exist, undefined.
Gets the minimum value in the store.
When store is filtered, only items within the filter are aggregated.
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.
The minimum value, if no items exist, undefined.
Alias for addManagedListener. Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
eventName : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the eventName
parameter was an event name, this is the handler function.
scope : Object (optional)
If the eventName
parameter was an event name, this is the scope in which
the handler function is executed.
options : Object (optional)
If the eventName
parameter was an event name, this is the
addListener options.
Deprecated since version 2.0.0
This is now done automatically
Alias for removeManagedListener. Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
eventName : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the eventName
parameter was an event name, this is the handler function.
scope : Object (optional)
If the eventName
parameter was an event name, this is the scope in which
the handler function is executed.
Deprecated since version 2.0.0
This is now done automatically
Loads the next 'page' in the current data set
options : Object
See options for method-load
Alias for addListener. Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener:
container.addListener('tap', this.handleTap, this, {
single: true,
delay: 100
});
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
container.addListener({
tap : this.onTap,
swipe: this.onSwipe,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
container.addListener({
tap : { fn: this.onTap, scope: this, single: true },
swipe: { fn: button.onSwipe, scope: button }
});
See the Events Guide for more.
eventName : String/String[]/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String
The method the event invokes. Will be called with arguments given to
fireEvent plus the options
parameter described below.
scope : Object (optional)
The scope (this
reference) in which the handler function is executed. If
omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
This object may contain any of the following properties:
scope : Object (optional)
The scope (this
reference) in which the handler function is executed. If omitted, defaults to the object
which fired the event.
delay : Number (optional)
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean (optional)
true
to add a handler to handle just the next firing of the event, and then remove itself.
order : String (optional)
The order of when the listener should be added into the listener queue.
If you set an order of before
and the event you are listening to is preventable, you can return false
and it will stop the event.
Available options are before
, current
and after
.
Defaults to:
current
buffer : Number (optional)
Causes the handler to be delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
element : String (optional)
If this observable is a Component, allows you to add a listener onto a element of the component using the element's reference.
Ext.create('Ext.Component', {
listeners: {
element: 'element',
tap: function() {
alert('element tap!');
}
}
});
In Sencha Touch, All components have the element
reference, which is the outer
most element of the component. Ext.Container also has the innerElement
element which contains all children. In most cases element
is adequate.
delegate : String (optional)
For Ext.dom.Element, a simple DOM selector to filter the target or look for a descendant of the target.
Sencha Touch Components can use Ext.ComponentQuery selectors to filter child Components.
// Create a container with a two children; a button and a toolbar
var container = Ext.create('Ext.Container', {
items: [
{
xtype: 'toolbar',
docked: 'top',
title: 'My Toolbar'
},
{
xtype: 'button',
text: 'My Button'
}
]
});
container.addListener({
// Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
delegate: 'button',
tap: function() {
alert('Button tapped!');
}
});
capture : Boolean
true
to initiate capture which will fire the
listeners on the target Element before any descendant Elements. Normal events
start with the target element and propagate upward to ancestor elements, whereas
captured events propagate from the top of the DOM downward to descendant elements.
This option achieves the same result as the useCapture parameter in the standard
JavaScript addEventListener method.
order : String (optional)
The order of when the listener should be added into the listener queue.
Possible values are before
, current
and after
.
Defaults to: 'current'
Alias for addAfterListener. Appends an after-event handler.
Same as addListener with order
set to 'after'
.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn
.
options : Object (optional)
An object containing handler configuration.
Attached as the 'complete' event listener to a proxy's Batch object. Iterates over the batch operations and updates the Store's internal data MixedCollection.
batch : Object
operation : Object
Attached as the 'operationcomplete' event listener to a proxy's Batch object. By default just calls through to onProxyWrite.
batch : Object
operation : Object
Alias for addBeforeListener.
Appends a before-event handler. Returning false
from the handler will stop the event.
Same as addListener with order
set to 'before'
.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn
.
options : Object (optional)
An object containing handler configuration.
Called from a node's expand method to ensure that child nodes are available.
This ensures that the child nodes are available before calling the passed callback.
node : Ext.data.NodeInterface
The node being expanded.
callback : Function
The function to run after the expand finishes
scope : Object
The scope in which to run the callback function
args : Array
The extra args to pass to the callback after the new child nodes
Removes any records when a write is returned from the server.
records : Ext.data.Model[]
The array of removed records
operation : Ext.data.operation.Operation
The operation that just completed
success : Boolean
True if the operation was successful
Called from a node's appendChild method.
parent : Object
node : Object
index : Object
Called from a node's collapse method
parent : Object
records : Object
callback : Object
scope : Object
Called from filter/clearFilter. Refreshes the view based upon the new filter setting.
root : Object
childNodes : Object
Called from a node's insertBefore method.
parent : Object
node : Object
index : Object
Called internally when a Proxy has completed a load request
operation : Object
Callback for any write Operation over the Proxy. Updates the Store's MixedCollection to reflect the updates provided by the Proxy
operation : Object
Loads the previous 'page' in the current data set
options : Object
See options for method-load
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.
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 an Ext.util.Collection of the matched records
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.
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 an Ext.util.Collection of the matched records
Determines if the passed range is available in the page cache.
start : Number
The start index
end : Number
The end index in the range
Registers a node so that it can be looked up by ID.
node : Ext.data.NodeInterface
The node to register
includeChildren : Boolean (optional)
True to unregister any child nodes
Rejects outstanding changes on all modified records and re-insert any records that were removed locally. Any phantom records will be removed.
args : Object
fn : Object
scope : Object
options : Object
order : Object
Relays selected events from the specified Observable as if the events were fired by this
.
object : Object
The Observable whose events this object is to relay.
events : String/Array/Object
Array of event names to relay.
Reloads the store using the last options passed to the method-load method. You can use the reload method to reload the store using the parameters from the last load() call. For example:
store.load({
params : {
userid : 22216
}
});
//...
store.reload();
The initial method-load execution will pass the userid
parameter in the request. The reload execution
will also send the same userid
parameter in its request as it will reuse the params
object from the last method-load call.
You can override a param by passing in the config object with the params
object:
store.load({
params : {
userid : 22216,
foo : 'bar'
}
});
//...
store.reload({
params : {
userid : 1234
}
});
The initial method-load execution sends the userid
and foo
parameters but in the reload it only sends
the userid
paramter because you are overriding the params
config not just overriding the one param. To only change a single param
but keep other params, you will have to get the last params from the lastOptions property:
var lastOptions = store.lastOptions,
lastParams = Ext.clone(lastOptions.params); // make a copy of the last params so we don't affect future reload() calls
lastParams.userid = 1234;
store.reload({
params : lastParams
});
This will now send the userid
parameter as 1234
and the foo
param as 'bar'
.
options : Object (optional)
A config object which contains options which may override the options passed to the previous load call. See the method-load method for valid configs.
Removes the specified record(s) from the Store, firing the event-remove event for the removed records.
After all records have been removed a single datachanged
is fired.
records : Ext.data.Model/Ext.data.Model[]/Number/Number[]
Model instance or array of instances to remove or an array of indices from which to remove records.
Removes a before-event handler.
Same as removeListener with order
set to 'after'
.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn
.
options : Object (optional)
Extra options object.
Removes all unfiltered items from the store. Filtered records will not be removed.
Individual record event-remove
events are not fired by this method.
silent : Boolean (optional)
Pass true
to prevent the event-clear
event from being fired.
Defaults to: false
The removed records.
Removes the model instance(s) at the given index
index : Number
The record index
count : Number (optional)
The number of records to delete
Defaults to: 1
Removes a before-event handler.
Same as removeListener with order
set to 'before'
.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn
.
options : Object (optional)
Extra options object.
Removes an individual Filter from the current filter set using the passed Filter/Filter id and by default, applys the updated filter set to the Store's unfiltered dataset.
toRemove : String/Ext.util.Filter
The id of a Filter to remove from the filter set, or a Filter instance to remove.
Removes an event handler.
eventName : String/String[]/Object
The type of event the handler was associated with.
fn : Function/String
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.
options : Object (optional)
Extra options object. See addListener for details.
order : String (optional)
The order of the listener to remove.
Possible values are before
, current
and after
.
Defaults to: 'current'
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.
object : Ext.mixin.Observable/HTMLElement
The item to which to add a listener/listeners.
eventName : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the eventName
parameter was an event name, this is the handler function.
scope : Object (optional)
If the eventName
parameter was an event name, this is the scope in which
the handler function is executed.
Deprecated since version 2.0
All listeners are now automatically managed where necessary. Simply use removeListener.
This method determines the scope (the this
pointer) of named listeners that have
not be given a specific scope. For example:
component.on({
click: 'onClick'
});
The default implementation of this method returns this object. Components and other observable objects that have natural hierarchies can override this method to pick the desired scope using other means.
Available since: 5.0.0
defaultScope : Object (optional)
The default scope to return if none is found.
Defaults to: this
The object on which non-scoped, named listeners should be fired.
Resumes automatically syncing the Store with its Proxy. Only applicable if autoSync is true
syncNow : Boolean
Pass true
to synchronize now. Only synchronizes with the Proxy if the suspension
count has gone to zero (We are not under a higher level of suspension)
Resumes firing of the named event(s).
After calling this method to resume events, the events will fire when requested to fire.
Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to resume.
Resumes firing events (see suspendEvents).
discardQueuedEvents : Boolean
Pass as true to discard any queued events.
Private method used to deeply retrieve the children of a record without recursion.
root : Ext.data.NodeInterface
Saves all pending changes via the configured proxy. Use sync instead.
Deprecated since version 4.0.0
Will be removed in the next major version
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
Make a set of records be current in the store. This means that unneeded records will be removed and new records will be added.
records : Ext.data.Model[]
The records to be current in the store.
Sets the root node for this store. See also the root config option.
root : Ext.data.TreeModel/Ext.data.NodeInterface/Object
The new root
Deprecated since version 5.0
Use setRoot instead
Sorts the data in the Store by one or more of its properties. Example usage:
//sort by a single field
myStore.sort('myField', 'DESC');
//sorting by multiple fields
myStore.sort([
{
property : 'age',
direction: 'ASC'
},
{
property : 'name',
direction: 'DESC'
}
]);
Internally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates the actual sorting to its internal Ext.util.Collection.
When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:
store.sort('myField');
store.sort('myField');
Is equivalent to this code, because Store handles the toggling automatically:
store.sort('myField', 'ASC');
store.sort('myField', 'DESC');
sorters : String/Ext.util.Sorter[] (optional)
Either a string name of one of the fields in this Store's configured Ext.data.Model, or an array of sorter configurations.
direction : String (optional)
The overall direction to sort the data by.
Defaults to: "ASC"
Sorter function for sorting records in index order
node1 : Ext.data.NodeInterface
node2 : Ext.data.NodeInterface
[splice description]
index : [type]
toRemove : [type]
toAdd : [type]
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
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.
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.
The sum
Suspends automatically syncing the Store with its Proxy. Only applicable if autoSync is true
Suspends firing of the named event(s).
After calling this method to suspend events, the events will no longer fire when requested to fire.
Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to suspend.
Suspends the firing of all events. (see resumeEvents)
queueSuspended : Boolean
true
to queue up suspended events to be fired
after the resumeEvents call instead of discarding all suspended events.
Synchronizes the store with its proxy. This asks the proxy to batch together any new, updated and deleted records in the store, updating the store's internal representation of the records as each operation completes.
options : Object (optional)
Object containing one or more properties supported by the sync method (these get passed along to the underlying proxy's batch method):
batch : Ext.data.Batch / Object (optional)
A Ext.data.Batch object (or batch config to apply to the created batch). If unspecified a default batch will be auto-created as needed.
callback : Function (optional)
The function to be called upon completion of the sync. The callback is called regardless of success or failure and is passed the following parameters:
batch : Ext.data.Batch
The Ext.data.Batch that was processed, containing all operations in their current state after processing
options : Object
The options argument that was originally passed into sync
success : Function (optional)
The function to be called upon successful completion of the sync. The success function is called only if no exceptions were reported in any operations. If one or more exceptions occurred then the failure function will be called instead. The success function is called with the following parameters:
batch : Ext.data.Batch
The Ext.data.Batch that was processed, containing all operations in their current state after processing
options : Object
The options argument that was originally passed into sync
failure : Function (optional)
The function to be called upon unsuccessful completion of the sync. The failure function is called when one or more operations returns an exception during processing (even if some operations were also successful). In this case you can check the batch's exceptions array to see exactly which operations had exceptions. The failure function is called with the following parameters:
batch : Ext.data.Batch
The Ext.data.Batch that was processed, containing all operations in their current state after processing
options : Object
The options argument that was originally passed into sync
params : Object (optional)
Additional params to send during the sync Operation(s).
scope : Object (optional)
The scope in which to execute any callbacks (i.e. the this
object inside
the callback, success and/or failure functions). Defaults to the store's proxy.
this
Alias for removeListener. Removes an event handler.
eventName : String/String[]/Object
The type of event the handler was associated with.
fn : Function/String
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.
options : Object (optional)
Extra options object. See addListener for details.
order : String (optional)
The order of the listener to remove.
Possible values are before
, current
and after
.
Defaults to: 'current'
Alias for removeAfterListener. Removes a before-event handler.
Same as removeListener with order
set to 'after'
.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn
.
options : Object (optional)
Extra options object.
Alias for removeBeforeListener. Removes a before-event handler.
Same as removeListener with order
set to 'before'
.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn
.
options : Object (optional)
Extra options object.
Destroys a given set of linked
objects. This is only needed if
the linked object is being destroyed before this instance.
names : String[]
The names of the linked objects to destroy.
this
Unregisters a node.
node : Ext.data.NodeInterface
The node to unregister
includeChildren : Boolean (optional)
True to unregister any child nodes
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 : 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
Fired when a Model instance has been added to this Store.
Available since: 1.1.0
store : Ext.data.Store
The store.
records : Ext.data.Model[]
The records that were added.
index : Number
The index at which the records were inserted.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a request is made for a new data object. If the beforeload handler returns false the load action will be canceled.
Available since: 1.1.0
store : Ext.data.Store
This Store
operation : Ext.data.operation.Operation
The Ext.data.operation.Operation object that will be passed to the Proxy to load the Store
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a prefetch occurs. Return false
to cancel.
this : Ext.data.Store
operation : Ext.data.operation.Operation
The associated operation.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a store is sorted.
For remotely sorted stores, this will be just before the load operation triggered by changing the store's sorters.
For locally sorted stores, this will be just before the data items in the store's backing collection are sorted.
Fired before a call to sync is executed. Return false from any listener to cancel the sync
options : Object
Hash of all records to be synchronized, broken down into create, update and destroy
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the beginUpdate method is called. Automatic synchronization as configured by the autoSync flag is deferred until the endUpdate method is called, so multiple mutations can be coalesced into one synchronization operation.
Fired after the removeAll method is called.
Available since: 1.1.0
this : Ext.data.Store
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever records are added to or removed from the Store.
To hook into modifications of records in this Store use the update event.
Available since: 1.1.0
this : Ext.data.Store
The data store
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the endUpdate method is called. Automatic synchronization as configured by the autoSync flag is deferred until the endUpdate method is called, so multiple mutations can be coalesced into one synchronization operation.
Fired whenever the filter set changes.
store : Ext.data.Store
The store.
filters : Ext.util.Filter[]
The array of Filter objects.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired whenever the grouping in the grid changes.
store : Ext.data.Store
The store.
grouper : Ext.util.Grouper
The grouper object.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever the store reads data from a remote data source.
this : Ext.data.TreeStore
records : Ext.data.TreeModel[]
An array of records.
successful : Boolean
True if the operation was successful.
operation : Ext.data.operation.Operation
The operation that triggered this load.
node : Ext.data.NodeInterface
The node that was loaded.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this store's underlying reader (available via the proxy) provides new metadata. Metadata usually consists of new field definitions, but can include any configuration data required by an application, and can be processed as needed in the event handler. This event is currently only fired for JsonReaders.
Available since: 1.1.0
this : Ext.data.Store
meta : Object
The JSON metadata
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a new child node is appended
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The newly appended node
index : Number
The index of the newly appended node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a new child is appended, return false to cancel the append.
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The child node to be appended
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before this node is collapsed.
this : Ext.data.NodeInterface
The collapsing node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before this node is expanded.
this : Ext.data.NodeInterface
The expanding node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a new child is inserted, return false to cancel the insert.
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The child node to be inserted
refNode : Ext.data.NodeInterface
The child node the node is being inserted before
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before this node is moved to a new location in the tree. Return false to cancel the move.
this : Ext.data.NodeInterface
This node
oldParent : Ext.data.NodeInterface
The parent of this node
newParent : Ext.data.NodeInterface
The new parent this node is moving to
index : Number
The index it is being moved to
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a child is removed, return false to cancel the remove.
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The child node to be removed
isMove : Boolean
true
if the child node is being removed so it can be moved to another position in the tree.
(a side effect of calling appendChild or
insertBefore with a node that already has a parentNode)
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this node is collapsed.
this : Ext.data.NodeInterface
The collapsing node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this node is expanded.
this : Ext.data.NodeInterface
The expanding node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a new child node is inserted.
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The child node inserted
refNode : Ext.data.NodeInterface
The child node the node was inserted before
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this node is moved to a new location in the tree
this : Ext.data.NodeInterface
This node
oldParent : Ext.data.NodeInterface
The old parent of this node
newParent : Ext.data.NodeInterface
The new parent of this node
index : Number
The index it was moved to
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a child node is removed
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The removed node
isMove : Boolean
true
if the child node is being removed so it can be moved to another position in the tree.
(a side effect of calling appendChild or
insertBefore with a node that already has a parentNode)
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this node's childNodes are sorted.
this : Ext.data.NodeInterface
This node.
childNodes : Ext.data.NodeInterface[]
The childNodes of this node.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever records have been prefetched.
this : Ext.data.Store
records : Ext.data.Model[]
An array of records.
successful : Boolean
true
if the operation was successful.
operation : Ext.data.operation.Operation
The associated operation.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a widget that is using this Store as a Record cache should refresh its view.
this : Ext.data.Store
The data store
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when one or more records have been removed from this Store.
The signature for this event has changed in 5.0:
Available since: 5.0.0
store : Ext.data.Store
The Store object
records : Ext.data.Model[]
The records that were removed. In previous releases this was a single record, not an array.
index : Number
The index at which the records were removed.
isMove : Boolean
true
if the child node is being removed so it can be
moved to another position in this Store.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires after a store is sorted.
For remotely sorted stores, this will be upon the success of a load operation triggered by changing the store's sorters.
For locally sorted stores, this will be just after the data items in the store's backing collection are sorted.
Fires when a Model instance has been updated.
Available since: 1.1.0
this : Ext.data.Store
record : Ext.data.Model
The Model instance that was updated
operation : String
The update operation being performed. Value may be one of:
Ext.data.Model.EDIT
Ext.data.Model.REJECT
Ext.data.Model.COMMIT
modifiedFieldNames : String[]
Array of field names changed during edit.
details : Object
An object describing the change. See the itemchanged event of the store's backing collection
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires whenever a successful write has been made via the configured Proxy
Available since: 3.4.0
store : Ext.data.Store
This Store
operation : Ext.data.operation.Operation
The Ext.data.operation.Operation object that was used in the write
eOpts : Object
The options object passed to Ext.util.Observable.addListener.