The documentation for the ExtReact product diverges somewhat from the
documentation of other Sencha products. The sections below describe
documentation for all products except where indicated as unique to
ExtReact.
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.
ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.
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.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
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.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
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
Or in the case of an ExtReact component class this
indicates a member of type prop
- 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.
ExtReact component classes do not hoist the getter /
setter methods into the prop. All methods will be described in the
Methods section
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.
Small helper class to make creating Ext.data.Stores from Array data easier. An ArrayStore will be automatically configured with a Ext.data.reader.Array.
A store configuration would be something like:
var store = Ext.create('Ext.data.ArrayStore', {
// store configs
storeId: 'myStore',
// reader configs
fields: [
'company',
{name: 'price', type: 'float'},
{name: 'change', type: 'float'},
{name: 'pctChange', type: 'float'},
{name: 'lastChange', type: 'date', dateFormat: 'n/j h:ia'}
]
});
This store is configured to consume a returned object of the form:
var myData = [
['3m Co',71.72,0.02,0.03,'9/1 12:00am'],
['Alcoa Inc',29.01,0.42,1.47,'9/1 12:00am'],
['Boeing Co.',75.43,0.53,0.71,'9/1 12:00am'],
['Hewlett-Packard Co.',36.53,-0.03,-0.08,'9/1 12:00am'],
['Wal-Mart Stores, Inc.',45.45,0.73,1.63,'9/1 12:00am']
];
An object literal of this form could also be used as the cfg-data config option.
This defaults to true when this store's cfg-proxy is asynchronous, such as an
Ext.data.proxy.Ajax.
When the proxy is synchronous, such as a Ext.data.proxy.Memory memory proxy, this
defaults to false.
NOTE: This does not cause synchronous Ajax requests if configured false when an Ajax proxy
is used. It causes immediate issuing of an Ajax request when method-load is called
rather than issuing the request at the end of the current event handler run.
What this means is that when using an Ajax proxy, calls to method-load do not fire the request to the remote resource immediately, but schedule a request to be made. This is so that multiple requests are not fired when mutating a store's remote filters and sorters (as happens during state restoration). The request is made only once after all relevant store state is fully set.
Defaults to:
undefined
Available since: 6.0.1
Sets the value of asynchronousLoad
asynchronousLoad : Boolean
When a Store is used by only one DataView, 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.
It's important to note that Ext.data.TreeStore will load regardless of autoLoad's value if expand is set to true on the root node.
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
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
true to clear anything in the removed record collection when the store loads.
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:
undefined
Returns the store's records.
Note: If your store has been filtered, getData() will return a filtered
collection. Use getData().getSource() to
fetch all unfiltered records.
An Ext.util.Collection of records (an empty Collection if no records are held by the store).
Loads an array of data directly into the Store.
setData() is ideal if your data's format is already in its appropriate format (e.g. it doesn't need to be processed by a reader). If your data's structure requires processing, use a Ext.data.proxy.Memory or loadRawData.
Use loadData, method-add, or insert if records need to be appended to the current recordset.
data : Ext.data.Model[]/Object[]
Array of data to load. Any non-model instances will be cast into model instances first.
An Array of Ext.data.field.Field config objects, simply the field
name, or a mix of config objects and strings.
If just a name is given, the field type defaults to auto.
In a Ext.data.field.Field config object you may pass the alias of
the Ext.data.field.* type using the type config option.
// two fields are set:
// - an 'auto' field with a name of 'firstName'
// - and an Ext.data.field.Integer field with a name of 'age'
fields: ['firstName', {
type: 'int',
name: 'age'
}]
Fields will automatically be created at read time for any for any keys in the
data passed to the Model's proxy's
Ext.data.reader.Reader whose name is not explicitly configured in
the fields config.
Extending a Model class will inherit all the fields from the superclass /
ancestor classes.
Note: In general, this configuration option should only be used
for simple stores like a two-field store of
ComboBox. For anything more complicated, such
as specifying a particular id property or associations, a
Ext.data.Model should be defined and specified for the
model config.
Defaults to:
undefined
Available since: 2.3.0
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:
null
Gets the filters for this store.
The filters
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 method-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.
DOM events from Ext JS Ext.Component
While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually
only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a
child element of a Component, we need to specify the element option to identify the Component property to add a
DOM listener to:
new Ext.panel.Panel({
width: 400,
height: 200,
dockedItems: [{
xtype: 'toolbar'
}],
listeners: {
click: {
element: 'el', //bind to the underlying el property on the panel
fn: function(){ console.log('click el'); }
},
dblclick: {
element: 'body', //bind to the underlying body property on the panel
fn: function(){ console.log('dblclick body'); }
}
}
});
An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.
listeners : Object
The listeners
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 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 PagingToolbar Defaults to 25.
To disable paging, set the pageSize to 0.
Defaults to:
25
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
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 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:
null
Gets the sorters for this store.
The sorters
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
grid 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 a store is instantiated by a Controller, the storeId will default to the name of the store if not specified in the class.
Defaults to:
null
This config controls whether removed records are remembered by this store for later saving to the server.
Defaults to:
true
If this property is specified by the target class of this mixin its properties are
used to configure the created Ext.Factory.
true in this class to identify an object as an instantiated Observable, or subclass thereof.
Defaults to:
true
true in this class to identify an object as an instantiated Store, 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.
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.
record : Ext.data.Model[]/Ext.data.Model.../Object[]/Object...
An array of records or configuration objects, or variable number of record or config arguments.
The record instances that were added.
Adds a new Filter to this Store's filter set and by default, applies 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.
suppressEvent : Boolean (optional)
If true the filter is cleared silently.
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : 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 (optional)
The method the event invokes or the name of
the method within the specified scope. Will be called with arguments
given to Ext.util.Observable#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.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask 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.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.
destroyable : Boolean (optional)
When specified as true, the function returns a destroyable object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority option instead. Available options are:
'before': equal to a priority of 100'current': equal to a priority of 0 or default priority'after': equal to a priority of -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener.
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.
grid.on({
itemclick: 'onItemClick',
itemcontextmenu: grid.onItemContextmenu,
destroy: {
fn: function () {
// function called within the 'altCmp' scope instead of grid
},
scope: altCmp // unique scope for the destroy handler
},
scope: grid // default scope - provided for example clarity
});
Delegate
This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:
var panel = Ext.create({
xtype: 'panel',
renderTo: document.body,
title: 'Delegate Handler Example',
frame: true,
height: 220,
width: 220,
html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});
// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
click: function (e) {
console.log(e.getTarget().innerHTML);
},
element: 'body',
delegate: 'h1.myTitle'
});
Defaults to: 'current'
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.
item : Ext.util.Observable/Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function/String (optional)
If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
options : Object (optional)
If the ename parameter was an event name, this is the
addListener options.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
(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.Record
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
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.
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 = new Ext.data.Store({
fields: ['name'],
data: [{
name: 'Larry'
}, {
name: 'Darryl'
}, {
name: 'Darryl'
}]
});
store.collect('name');
// returns ["Larry", "Darryl"]
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.
filtered : Boolean (optional)
This argument only applies when the legacy call form
is used and includeOptions is actually the allowNull value.
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
Perform the Store destroying sequence. Override this method to add destruction behaviors to your custom Stores.
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.
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.
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.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.
Example:
Ext.define('Ext.overrides.form.field.Base', {
override: 'Ext.form.field.Base',
// Add functionality to Field's initComponent to enable the change event to bubble
initComponent: function () {
this.callParent();
this.enableBubble('change');
}
});
var myForm = Ext.create('Ext.form.Panel', {
title: 'User Details',
items: [{
...
}],
listeners: {
change: function() {
// Title goes red if form has been modified.
myForm.header.setStyle('color', 'red');
}
}
});
eventNames : 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
Filters the data in the Store by one or more fields. Example usage:
//filter with a single field
myStore.filter('firstName', 'Don');
//filtering with multiple filters
myStore.filter([
{
property : 'firstName',
value : 'Don'
},
{
property : 'lastName',
value : 'Griffin'
}
]);
Internally, Store converts the passed arguments into an array of Ext.util.Filter instances, and delegates the actual filtering to its internal Ext.util.Collection or the remote server.
filters : String/Ext.util.Filter[] (optional)
Either a string name of one of the fields in this Store's configured Ext.data.Model, or an array of filter configurations.
value : String (optional)
The property value by which to filter. Only applicable if
filters is a string.
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.
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.
start : Number (optional)
The index at which to start searching.
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 (minus the event name, plus the options object passed
to addListener).
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...
Variable number of parameters are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
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.
Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.
By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handlers and to the action function.
fn : Function/String
The action function.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
fnArgs : Array/Boolean (optional)
Optional arguments for the action fn. If not
given, the normal args will be used to call fn. If false is passed, the
args are used but if the first argument is this instance it will be removed
from the args passed to the action function.
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 null if not found.
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.
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 a collection of readonly sub-collections of your store's records with grouping applied. These sub-collections are maintained internally by the collection.
See groupField, groupDir. Example for a store containing records with a color field:
var myStore = new Ext.data.Store({
groupField: 'color',
groupDir : 'DESC'
});
myStore.getGroups();
The above should result in the following format:
[
{
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 affected by filtering.
The grouped data
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
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. Note that this is a copy of the store's array, so may be mutated.
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, or whether the event bubbles. The answer indicates whether the event needs firing or not.
eventName : String
The name of the event to check for
true if the event is being listened for or bubbles, else false
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 affected by filtering.
id : String
The id of the Record to find.
The index of the Record. Returns -1 if not found.
Inserts Model instances into the Store at the given index and fires the add event. See also method-add.
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.
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.
event : 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
Marks this store as needing a load. When the current executing event handler exits, this store will send a request to load using its configured proxy.
Upon return of the data from whatever data source the proxy connected to, the retrieved Ext.data.Model will be loaded into this store, and the optional callback will be called. Example usage:
store.load({
scope: this,
callback: function(records, operation, success) {
// the operation object
// contains all of the details of the load operation
console.log(records);
}
});
If the callback scope does not need to be set, a function can simply be passed:
store.load(function(records, operation, success) {
console.log('loaded records');
});
Available since: 1.1.0
options : Object (optional)
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. In addition to the options listed below, this object may contain properties to configure the Ext.data.operation.Operation.
callback : Function (optional)
A function which is called when the response arrives.
records : Ext.data.Model[]
Array of records.
operation : Ext.data.operation.Operation
The Operation itself.
success : Boolean
true when operation completed successfully.
addRecords : Boolean (optional)
Specify as true to add the incoming records rather than the
default which is to have the incoming records replace the existing store contents.
Defaults to:
false
this
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
addRecords : Boolean (optional)
Pass true to add these records to the existing records, false to remove the Store's existing records first.
Defaults to:
false
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.
Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.
item : Ext.util.Observable/Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function/String (optional)
If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
options : Object (optional)
If the ename parameter was an event name, this is the
addListener options.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
Loads the next 'page' in the current data set
options : Object
See options for method-load
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : 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 (optional)
The method the event invokes or the name of
the method within the specified scope. Will be called with arguments
given to Ext.util.Observable#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.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask 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.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopPropagation on the event object
before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call preventDefault on the event object
before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.
destroyable : Boolean (optional)
When specified as true, the function returns a destroyable object. An object
which implements the destroy method which removes all listeners added in this call.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority option instead. Available options are:
'before': equal to a priority of 100'current': equal to a priority of 0 or default priority'after': equal to a priority of -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A delayed, one-time listener.
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.
grid.on({
itemclick: 'onItemClick',
itemcontextmenu: grid.onItemContextmenu,
destroy: {
fn: function () {
// function called within the 'altCmp' scope instead of grid
},
scope: altCmp // unique scope for the destroy handler
},
scope: grid // default scope - provided for example clarity
});
Delegate
This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:
var panel = Ext.create({
xtype: 'panel',
renderTo: document.body,
title: 'Delegate Handler Example',
frame: true,
height: 220,
width: 220,
html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});
// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
click: function (e) {
console.log(e.getTarget().innerHTML);
},
element: 'body',
delegate: 'h1.myTitle'
});
Defaults to: 'current'
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
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.
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
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.
The matched records
Rejects outstanding changes on all modified records and re-insert any records that were removed locally. Any phantom records will be removed.
Relays selected events from the specified Observable as if the events were fired by this.
For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:
this.relayEvents(this.getStore(), ['load']);
The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).
origin : Object
The Observable whose events this object is to relay.
events : String[]/Object
Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});
Would now redispatch the add event of this as a push event and the remove event as a pop event.
prefix : String (optional)
A common prefix to prepend to the event names. For example:
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Can be undone by calling
Ext.destroy(this.storeRelayers);
or this.store.relayers.destroy();
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 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 an individual Filter from the current filter set using the passed Filter/Filter id and by default, applies 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.
suppressEvent : Boolean (optional)
If true the filter is cleared silently.
Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
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 Ext.util.Observable#addListener or the listener will not be removed.
Convenience Syntax
You can use the addListener
destroyable: true config option in place of calling un(). For example:
var listeners = cmp.on({
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide,
destroyable: true
});
// Remove listeners
listeners.destroy();
// or
cmp.un(
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide
);
Exception - DOM event handlers using the element config option
You must go directly through the element to detach an event handler attached using the addListener element option.
panel.on({
element: 'body',
click: 'onBodyCLick'
});
panel.body.un({
click: 'onBodyCLick'
});
Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)
in which the handler function is executed.
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).
If events were suspended using the queueSuspended parameter, then all events fired
during event suspension will be sent to any listeners now.
discardQueue : Boolean (optional)
true to prevent any previously queued events from firing
while we were suspended. See suspendEvents.
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 either delegates the actual sorting to its internal Ext.util.Collection or the remote server.
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');
field : 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 : "ASC"/"DESC" (optional)
The overall direction to sort the data by.
Defaults to: "ASC"
mode : "append"/"prepend"/"replace"/"multi" (optional)
Defaults to: "replace"
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
Shorthand for removeListener. Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
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 Ext.util.Observable#addListener or the listener will not be removed.
Convenience Syntax
You can use the addListener
destroyable: true config option in place of calling un(). For example:
var listeners = cmp.on({
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide,
destroyable: true
});
// Remove listeners
listeners.destroy();
// or
cmp.un(
scope: cmp,
afterrender: cmp.onAfterrender,
beforehide: cmp.onBeforeHide
);
Exception - DOM event handlers using the element config option
You must go directly through the element to detach an event handler attached using the addListener element option.
panel.on({
element: 'body',
click: 'onBodyCLick'
});
panel.body.un({
click: 'onBodyCLick'
});
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 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.
Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
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.
store : Ext.data.Store
The store being sorted
sorters : Ext.util.Sorter[]
Array of sorters applied to the store
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
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.
Available since: 1.1.0
this : Ext.data.Store
records : Ext.data.Model[]
An array of records
successful : Boolean
True if the operation was successful.
operation : Ext.data.operation.Read
The Ext.data.operation.Read object that was used in the data load call
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 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.
store : Ext.data.Store
The store being sorted
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
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 itemchange 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.
ExtReact | Terms of Use