Ext JS 4.1.3 Sencha Docs

Ext.data.TreeStore

Hierarchy

Inherited mixins

Requires

Files

The TreeStore is a store implementation that is backed by by an Ext.data.Tree. It provides convenience methods for loading nodes, as well as the ability to use the hierarchical tree structure combined with a store. This class is generally used in conjunction with Ext.tree.Panel. This class also relays many events from the Tree for convenience.

Using Models

If no Model is specified, an implicit model will be created that implements Ext.data.NodeInterface. 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.

Reading Nested Data

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.

Available since: 4.0.0

Defined By

Config options

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called afte...

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.

Available since: 2.3.0

True to automatically sync the Store with its Proxy after every edit to one of its Records. ...

True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.

Defaults to: false

Available since: 4.0.0

Sets the updating behavior based on batch synchronization. ...

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'

Available since: 4.1.1

Ext.data.TreeStore
view source
: Boolean
Remove previously existing child nodes before loading. ...

Remove previously existing child nodes before loading.

Defaults to: true

Available since: 4.0.0

If true, when a node is reloaded, any records in the removed record collection that were previously descendants of th...

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

Available since: 4.1.0

Ext.data.TreeStore
view source
: String
The default root id. ...

The default root id.

Defaults to: "root"

Available since: 4.0.0

The root property to specify on the reader if one is not explicitly defined. ...

The root property to specify on the reader if one is not explicitly defined.

Defaults to: "children"

Available since: 4.0.0

The default root text (if not specified)/ ...

The default root text (if not specified)/

Defaults to: "Root"

Available since: 4.1.2

The default sort direction to use if one is not specified. ...

The default sort direction to use if one is not specified.

Defaults to: "ASC"

Available since: Ext JS 4.1.3

This may be used in place of specifying a model configuration. ...

This may be used in place of specifying a model configuration. The fields should be a set of Ext.data.Field configuration objects. The store will automatically create a Ext.data.Model with these fields. 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.

Available since: 2.3.0

If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. ...

If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, ignored if remoteFilter is true

Defaults to: true

Available since: 4.1.1

Array of Filters for this store. ...

Array of Filters 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.internalId > 0;
    }
]

To filter after the grid is loaded use the filterBy function.

Available since: 4.1.0

Ext.data.TreeStore
view source
: Boolean
Set to true to automatically prepend a leaf sorter. ...

Set to true to automatically prepend a leaf sorter.

Defaults to: false

Available since: 4.0.0

A config object containing one or more event handlers to be added to this object during initialization. ...

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 Components

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'); }
        }
    }
});

Available since: 1.1.0

Name of the Model associated with this store. ...

Name of the Model associated with this store. The string is used as an argument for Ext.ModelManager.getModel.

Available since: 4.0.4

Ext.data.TreeStore
view source
: String
The name of the parameter sent to the server which contains the identifier of the node. ...

The name of the parameter sent to the server which contains the identifier of the node.

Defaults to: "node"

Available since: 4.0.0

The Proxy to use for this Store. ...

The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance - see setProxy for details.

Available since: 1.1.0

True to defer any filtering operation to the server. ...

True to defer any filtering operation to the server. If false, filtering is done locally on the client.

Defaults to: false

Available since: 4.1.1

True to defer any sorting operation to the server. ...

True to defer any sorting operation to the server. If false, sorting is done locally on the client.

Defaults to: false

Available since: 4.1.1

The root node for this store. ...

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.

Available since: 4.0.2

If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. ...

If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, igored if remoteSort is true

Defaults to: true

Available since: 4.1.1

The property in each item that contains the data to sort.

The property in each item that contains the data to sort.

Available since: Ext JS 4.1.3

The initial set of Sorters

The initial set of Sorters

Available since: Ext JS 4.1.3

Unique identifier for this store. ...

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.

Available since: 4.0.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

The string type of the Proxy to create if none is specified. ...

The string type of the Proxy to create if none is specified. This defaults to creating a memory proxy.

Defaults to: 'memory'

Available since: 4.0.0

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Available since: 4.1.1

Ext.data.TreeStore
view source
: Object
If we have no fields declare for the store, add some defaults. ...

If we have no fields declare for the store, add some defaults. These will be ignored if a model is explicitly specified.

Available since: 4.0.0

Ext.data.TreeStore
view source
: Numberprivate
...

Defaults to: 0

Available since: 4.1.2

The collection of Filters currently applied to this Store

The collection of Filters currently applied to this Store

Available since: 4.0.0

This object holds a key for any event that has a listener. ...

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 (via observe) or on the MVC 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);
 }

Available since: 4.1.0

True if a model was created implicitly for this Store. ...

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

Available since: 4.0.0

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

True if the Store has already been destroyed. ...

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

...

Defaults to: true

Available since: 4.1.1

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Available since: 4.0.0

true in this class to identify an object as an instantiated Sortable, or subclass thereof. ...

true in this class to identify an object as an instantiated Sortable, or subclass thereof.

Defaults to: true

Available since: 4.0.0

true in this class to identify an object as an instantiated Store, or subclass thereof. ...

true in this class to identify an object as an instantiated Store, or subclass thereof.

Defaults to: true

Available since: 4.0.0

A set of default values to be applied to every model instance added via insert or created via createModel. ...

A set of default values to be applied to every model instance added via insert or created via createModel. This is used internally by associations to set foreign keys and other fields. See the Association classes source code for examples. This should not need to be used by application developers.

Available since: 4.0.0

Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, at which poin...

Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, at which point this is cleared.

Defaults to: []

Available since: 4.0.0

Ext.data.TreeStore
view source
: Stringprivate
Keep a copy of the default so we know if it's been changed in a subclass/config ...

Keep a copy of the default so we know if it's been changed in a subclass/config

Defaults to: 'children'

Available since: 4.1.1

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See 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'

Available since: 4.0.0

The collection of Sorters currently applied to this Store

The collection of Sorters currently applied to this Store

Available since: 4.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance methods

Ext.data.TreeStore
view source
new( config ) : Ext.data.TreeStore
documented above ...

documented above

Available since: 4.0.0

Parameters

Returns

Fires

Overrides: Ext.data.AbstractStore.constructor

Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

Available since: 1.1.0

Parameters

  • eventNames : Object/String...

    Either an object with event names as properties with a value of true. For example:

    this.addEvents({
        storeloaded: true,
        storecleared: true
    });
    

    Or any number of event names as separate parameters. For example:

    this.addEvents('storeloaded', 'storecleared');
    
( eventName, [fn], [scope], [options] ) : Object
Appends an event handler to this object. ...

Appends an event handler to this object. For example:

myGridPanel.on("mouseover", this.onMouseOver, 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,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    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},
    mouseover: {fn: panel.onMouseOver, scope: panel}
});

Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

myGridPanel.on({
    cellClick: {fn: 'onCellClick', scope: this, single: true},
    mouseover: {fn: 'onMouseOver', scope: panel}
});

Available since: 1.1.0

Parameters

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

    The method the event invokes, or if scope is specified, the name* of the method within the specified scope. 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.

    Note: Unlike in ExtJS 3.x, 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.

    • 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 Components. The name of a Component property which references an element to add a listener to.

      This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

        new Ext.panel.Panel({
            title: 'The title',
            listeners: {
                click: this.handlePanelClick,
                element: 'body'
            }
        });
      
    • 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.

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

      Defaults to: false

Returns

  • Object

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

Fires

    Overrides: Ext.AbstractComponent.addListener

    ( item, ename, [fn], [scope], [options] ) : Object
    Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

    Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.

    Available since: 4.0.0

    Parameters

    • item : Ext.util.Observable/Ext.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 (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.

    • options : Object (optional)

      If the ename parameter was an event name, this is the addListener options.

    Returns

    • Object

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

    Fires

      A model instance should call this method on the Store it has been joined to. ...

      A model instance should call this method on the Store it has been joined to.

      Available since: 3.4.0

      Parameters

      Fires

      ( record, modifiedFieldNames )private
      A model instance should call this method on the Store it has been joined to. ...

      A model instance should call this method on the Store it has been joined to.

      Available since: 3.4.0

      Parameters

      • record : Ext.data.Model

        The model instance that was edited

      • modifiedFieldNames : String[]

        Array of field names changed during edit.

      Fires

      A model instance should call this method on the Store it has been joined to.. ...

      A model instance should call this method on the Store it has been joined to..

      Available since: 3.4.0

      Parameters

      Fires

      Ext.data.TreeStore
      view source
      ( )private
      ...

      Available since: 4.1.2

      Fires

      • beforebulkremove
      ( args ) : Objectdeprecatedprotected
      Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

      Call the original method that was previously overridden with override

      Ext.define('My.Cat', {
          constructor: function() {
              alert("I'm a cat!");
          }
      });
      
      My.Cat.override({
          constructor: function() {
              alert("I'm going to be a cat!");
      
              this.callOverridden();
      
              alert("Meeeeoooowwww");
          }
      });
      
      var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                // alerts "I'm a cat!"
                                // alerts "Meeeeoooowwww"
      

      Available since: 4.0.0

      This method has been deprecated

      as of 4.1. Use callParent instead.

      Parameters

      • args : Array/Arguments

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

      Returns

      • Object

        Returns the result of calling the overridden method

      Call the "parent" method of the current method. ...

      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.

      Available since: 4.0.0

      Parameters

      • args : Array/Arguments

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

      Returns

      • Object

        Returns the result of calling the parent method

      ( args ) : Objectprotected
      This method is used by an override to call the superclass method but bypass any overridden 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', {
           method: function () {
               console.log('Bad');
      
               // ... logic but with a bug ...
      
               this.callParent();
           }
       });
      

      To patch the bug in DerivedClass.method, the typical solution is to create an override:

       Ext.define('App.paches.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".

      Available since: Ext JS 4.1.3

      Parameters

      • args : Array/Arguments

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

      Returns

      • Object

        Returns the result of calling the superclass method

      Ext.data.TreeStore
      view source
      ( node, records )private
      ...

      Available since: 4.1.0

      Parameters

      to be implemented by subclasses ...

      to be implemented by subclasses

      Available since: 4.0.0

      ...

      Available since: 4.0.0

      Parameters

      Removes all listeners for this object including the managed listeners ...

      Removes all listeners for this object including the managed listeners

      Available since: 4.0.0

      Fires

        Removes all managed listeners for this object. ...

        Removes all managed listeners for this object.

        Available since: 4.0.0

        Fires

          Ext.data.TreeStore
          view source
          ( node )private
          Removes all records that used to be descendants of the passed node from the removed array ...

          Removes all records that used to be descendants of the passed node from the removed array

          Available since: 4.1.0

          Parameters

          Fires

            ...

            Available since: 4.1.1

            ( eventName, args, bubbles )private
            Continue to fire event. ...

            Continue to fire event.

            Available since: 4.0.7

            Parameters

            Fires

              saves any phantom records ...

              saves any phantom records

              Available since: 4.0.0

              Parameters

              Creates an event handling function which refires the event from this object as the passed event name. ...

              Creates an event handling function which refires the event from this object as the passed event name.

              Available since: 4.0.0

              Parameters

              • newName : Object
              • beginEnd : Array (optional)

                The caller can specify on which indices to slice

              Returns

              Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances ...

              Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances

              Available since: 4.0.0

              Parameters

              • filters : Object[]

                The filters array

              Returns

              Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances ...

              Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances

              Available since: 4.0.0

              Parameters

              • sorters : Object[]

                The sorters array

              Returns

              tells the attached proxy to destroy the given records ...

              tells the attached proxy to destroy the given records

              Available since: 3.4.0

              Parameters

              Fires

                Overrides: Ext.Base.destroy

                private ...

                private

                Available since: 4.0.0

                Fires

                  Ext.data.TreeStore
                  view source
                  ( sorterFn )private
                  inherit docs ...

                  inherit docs

                  Available since: 4.0.0

                  Parameters

                  Fires

                  Overrides: Ext.data.AbstractStore.doSort

                  ...

                  Available since: 4.1.0

                  Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

                  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');
                          }
                      }
                  });
                  

                  Available since: 3.4.0

                  Parameters

                  • eventNames : String/String[]

                    The event name to bubble, or an Array of event names.

                  Ext.data.TreeStore
                  view source
                  ( )private
                  ...

                  Available since: 4.1.2

                  Fires

                  • bulkremovecomplete
                  Ext.data.TreeStore
                  view source
                  ( node, newNodes )private
                  Fills a node with a series of child records. ...

                  Fills a node with a series of child records.

                  Available since: 4.0.0

                  Parameters

                  Fires

                  • beforefill
                  • fillcomplete
                  ...

                  Available since: 4.0.0

                  Parameters

                  ...

                  Available since: 4.0.0

                  Parameters

                  Filter function for new records. ...

                  Filter function for new records.

                  Available since: 4.0.0

                  Parameters

                  Filter function for updated records. ...

                  Filter function for updated records.

                  Available since: 4.0.0

                  Parameters

                  Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

                  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.

                  Available since: 1.1.0

                  Parameters

                  • eventName : String

                    The name of the event to fire.

                  • args : Object...

                    Variable number of parameters are passed to handlers.

                  Returns

                  • Boolean

                    returns false if any of the handlers return false otherwise it returns true.

                  Fires

                    Returns a comparator function which compares two items and returns -1, 0, or 1 depending on the currently defined set...

                    Returns a comparator function which compares two items and returns -1, 0, or 1 depending on the currently defined set of sorters.

                    If there are no sorters defined, it returns a function which returns 0 meaning that no sorting will occur.

                    Available since: 4.1.0

                    Fires

                      Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. ...

                      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

                      Available since: 4.0.0

                      Returns

                      Gets the bubbling parent for an Observable ...

                      Gets the bubbling parent for an Observable

                      Available since: 4.0.7

                      Returns

                      Fires

                        Ext.data.TreeStore
                        view source
                        ( id )private
                        inherit docs ...

                        inherit docs

                        Available since: 4.0.0

                        Parameters

                        Fires

                          Overrides: Ext.data.AbstractStore.getById

                          ...

                          Available since: 4.1.0

                          Parameters

                          to be implemented by subclasses ...

                          to be implemented by subclasses

                          Available since: 4.0.0

                          Gets the first sorter from the sorters collection, excluding any groupers that may be in place ...

                          Gets the first sorter from the sorters collection, excluding any groupers that may be in place

                          Available since: 4.1.1

                          Returns

                          Returns the initial configuration passed to constructor when instantiating this class. ...

                          Returns the initial configuration passed to constructor when instantiating this class.

                          Available since: 4.1.0

                          Parameters

                          • name : String (optional)

                            Name of the config option to return.

                          Returns

                          • Object/Mixed

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

                          Gets all records added or updated since the last commit. ...

                          Gets all records 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).

                          Available since: 4.1.0

                          Returns

                          Fires

                            Ext.data.TreeStore
                            view source
                            ( ) : Ext.data.Model[]
                            inherit docs ...

                            inherit docs

                            Available since: 4.0.0

                            Returns

                            Overrides: Ext.data.AbstractStore.getNewRecords

                            Returns the record node by id ...

                            Returns the record node by id

                            Available since: 4.0.0

                            Parameters

                            Returns

                            Returns the proxy currently attached to this proxy instance ...

                            Returns the proxy currently attached to this proxy instance

                            Available since: 4.0.0

                            Returns

                            Returns any records that have been removed from the store but not yet destroyed on the proxy. ...

                            Returns any records that have been removed from the store but not yet destroyed on the proxy.

                            Available since: 4.0.0

                            Returns

                            Returns the root node for this tree. ...

                            Returns the root node for this tree.

                            Available since: 4.0.0

                            Returns

                            ...

                            Available since: 4.0.0

                            inherit docs ...

                            inherit docs

                            Available since: 4.0.0

                            Returns

                            Overrides: Ext.data.AbstractStore.getUpdatedRecords

                            ...

                            Available since: 4.1.0

                            Parameters

                            Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

                            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.

                            Available since: 1.1.0

                            Parameters

                            • eventName : String

                              The name of the event to check for

                            Returns

                            • Boolean

                              true if the event is being listened for or bubbles, else false

                            ( config ) : Ext.Basechainableprotected
                            Initialize configuration for this class. ...

                            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'
                            

                            Available since: 4.0.0

                            Parameters

                            Returns

                            Performs initialization of this mixin. ...

                            Performs initialization of this mixin. Component classes using this mixin should call this method during their own initialization.

                            Available since: 4.0.0

                            Fires

                              ...

                              Available since: 4.0.0

                              Returns true if the Store is currently performing a load operation ...

                              Returns true if the Store is currently performing a load operation

                              Available since: 4.0.0

                              Returns

                              • Boolean

                                True if the Store is currently loading

                              Ext.data.TreeStore
                              view source
                              ( [options] )
                              Loads the Store using its configured proxy. ...

                              Loads the Store using its configured proxy.

                              Available since: 4.0.0

                              Parameters

                              • options : Object (optional)

                                config object. This is passed into the 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.

                              Fires

                                Overrides: Ext.data.AbstractStore.load

                                ( item, ename, [fn], [scope], [options] ) : Object
                                Shorthand for addManagedListener. ...

                                Shorthand for addManagedListener.

                                Available since: 4.0.2

                                Parameters

                                • item : Ext.util.Observable/Ext.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 (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.

                                • options : Object (optional)

                                  If the ename parameter was an event name, this is the addListener options.

                                Returns

                                • Object

                                  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();
                                  
                                ( item, ename, [fn], [scope] )
                                Shorthand for removeManagedListener. ...

                                Shorthand for removeManagedListener.

                                Available since: 4.0.2

                                Parameters

                                • item : Ext.util.Observable/Ext.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.

                                ( eventName, [fn], [scope], [options] ) : Object
                                Shorthand for addListener. ...

                                Shorthand for addListener.

                                Available since: 1.1.0

                                Parameters

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

                                  The method the event invokes, or if scope is specified, the name* of the method within the specified scope. 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.

                                  Note: Unlike in ExtJS 3.x, 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.

                                  • 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 Components. The name of a Component property which references an element to add a listener to.

                                    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

                                      new Ext.panel.Panel({
                                          title: 'The title',
                                          listeners: {
                                              click: this.handlePanelClick,
                                              element: 'body'
                                          }
                                      });
                                    
                                  • 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.

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

                                    Defaults to: false

                                Returns

                                • Object

                                  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();
                                  
                                Attached as the 'complete' event listener to a proxy's Batch object. ...

                                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.

                                Available since: 4.0.0

                                Parameters

                                Fires

                                ...

                                Available since: 4.0.0

                                Parameters

                                Attached as the 'operationcomplete' event listener to a proxy's Batch object. ...

                                Attached as the 'operationcomplete' event listener to a proxy's Batch object. By default just calls through to onProxyWrite.

                                Available since: 4.0.0

                                Parameters

                                Fires

                                Ext.data.TreeStore
                                view source
                                ( node, callback, scope )private
                                Called before a node is collapsed. ...

                                Called before a node is collapsed.

                                Available since: 4.0.0

                                Parameters

                                • node : Ext.data.NodeInterface

                                  The node being collapsed.

                                • callback : Function

                                  The function to run after the collapse finishes

                                • scope : Object

                                  The scope in which to run the callback function

                                Ext.data.TreeStore
                                view source
                                ( node, callback, scope )private
                                Called before a node is expanded. ...

                                Called before a node is expanded.

                                Available since: 4.0.0

                                Parameters

                                • 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

                                Fires

                                  Ext.data.TreeStore
                                  view source
                                  ( )private
                                  inherit docs ...

                                  inherit docs

                                  Available since: 4.0.0

                                  Fires

                                  Overrides: Ext.util.Sortable.onBeforeSort

                                  ...

                                  Available since: 4.1.0

                                  Parameters

                                  ( names, callback, scope )private
                                  ...

                                  Available since: 4.1.0

                                  Parameters

                                  Ext.data.TreeStore
                                  view source
                                  ( records )private
                                  may be implemented by store subclasses ...

                                  may be implemented by store subclasses

                                  Available since: 4.0.0

                                  Parameters

                                  Fires

                                    Overrides: Ext.data.AbstractStore.onCreateRecords

                                    ( records, operation, success )private
                                    Removes any records when a write is returned from the server. ...

                                    Removes any records when a write is returned from the server.

                                    Available since: 4.1.0

                                    Parameters

                                    private ...

                                    private

                                    Available since: 4.1.0

                                    Parameters

                                    Fires

                                    Ext.data.TreeStore
                                    view source
                                    ( parent, node )private
                                    ...

                                    Available since: 4.0.0

                                    Parameters

                                    Fires

                                    Ext.data.TreeStore
                                    view source
                                    ( parent, node, isMove )private
                                    ...

                                    Available since: 4.0.0

                                    Parameters

                                    Fires

                                    Ext.data.TreeStore
                                    view source
                                    ( )private
                                    ...

                                    Available since: 4.1.0

                                    Fires

                                    Ext.data.TreeStore
                                    view source
                                    ( operation )private
                                    inherit docs ...

                                    inherit docs

                                    Available since: 4.0.0

                                    Parameters

                                    Fires

                                    • beforefill
                                    • fillcomplete
                                    • load
                                    • read
                                    Callback for any write Operation over the Proxy. ...

                                    Callback for any write Operation over the Proxy. Updates the Store's MixedCollection to reflect the updates provided by the Proxy

                                    Available since: 4.0.0

                                    Parameters

                                    Fires

                                    may be implemented by store subclasses ...

                                    may be implemented by store subclasses

                                    Available since: 4.1.0

                                    Prepares a given class for observable instances. ...

                                    Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

                                    Available since: 4.1.2

                                    Parameters

                                    • T : Function

                                      The class constructor to prepare.

                                    ...

                                    Available since: 4.0.0

                                    Relays selected events from the specified Observable as if the events were fired by this. ...

                                    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.

                                    Available since: 2.3.0

                                    Parameters

                                    • origin : Object

                                      The Observable whose events this object is to relay.

                                    • events : String[]

                                      Array of event names to relay.

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

                                    Returns

                                    • Object

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

                                    Fires

                                      Reloads the store using the last options passed to the load method. ...

                                      Reloads the store using the last options passed to the load method.

                                      Available since: 4.1.1

                                      Parameters

                                      • options : Object

                                        A config object which contains options which may override the options passed to the previous load call.

                                      Fires

                                      Ext.data.TreeStore
                                      view source
                                      ( )
                                      inherit docs ...

                                      inherit docs

                                      Available since: 1.1.0

                                      Fires

                                      Overrides: Ext.data.AbstractStore.removeAll

                                      Removes an event handler. ...

                                      Removes an event handler.

                                      Available since: 1.1.0

                                      Parameters

                                      • 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 addListener or the listener will not be removed.

                                      Fires

                                        Removes listeners that were added by the mon method. ...

                                        Removes listeners that were added by the mon method.

                                        Available since: 4.0.0

                                        Parameters

                                        • item : Ext.util.Observable/Ext.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.

                                        Fires

                                          Remove a single managed listener item ...

                                          Remove a single managed listener item

                                          Available since: 4.0.1

                                          Parameters

                                          • isClear : Boolean

                                            True if this is being called during a clear

                                          • managedListener : Object

                                            The managed listener item See removeManagedListener for other args

                                          Overrides: Ext.AbstractComponent.removeManagedListenerItem

                                          Resumes automatically syncing the Store with its Proxy. ...

                                          Resumes automatically syncing the Store with its Proxy. Only applicable if autoSync is true

                                          Available since: 4.1.0

                                          Resumes firing events (see suspendEvents). ...

                                          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.

                                          Available since: 2.3.0

                                          Saves all pending changes via the configured proxy. ...

                                          Saves all pending changes via the configured proxy. Use sync instead.

                                          Available since: 4.0.0

                                          This method has been deprecated since 4.0.0

                                          Will be removed in the next major version

                                          ( config, applyIfNotSet ) : Ext.Basechainableprivate
                                          ...

                                          Available since: 4.0.0

                                          Parameters

                                          Returns

                                          Ext.data.TreeStore
                                          view source
                                          ( proxy ) : Ext.data.proxy.Proxy
                                          inherit docs ...

                                          inherit docs

                                          Available since: 4.0.0

                                          Parameters

                                          Returns

                                          Fires

                                            Overrides: Ext.data.AbstractStore.setProxy

                                            Sets the root node for this store. ...

                                            Sets the root node for this store. See also the root config option.

                                            Available since: 4.0.0

                                            Parameters

                                            Returns

                                            Fires

                                              Sorts the data in the Store by one or more of its properties. ...

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

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

                                              Available since: 4.0.0

                                              Parameters

                                              • sorters : String/Ext.util.Sorter[] (optional)

                                                Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations.

                                              • direction : String (optional)

                                                The overall direction to sort the data by.

                                                Defaults to: "ASC"

                                              Returns

                                              Fires

                                              • beforeload
                                              • beforesort
                                              • datachanged
                                              • refresh
                                              • sort
                                              Ext.data.TreeStore
                                              view source
                                              ( node1, node2 ) : Numberprivate
                                              Sorter function for sorting records in index order ...

                                              Sorter function for sorting records in index order

                                              Available since: 4.1.0

                                              Parameters

                                              Returns

                                              Get the reference to the class from which this object was instantiated. ...

                                              Get the reference to the class from which this object was instantiated. Note that unlike 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
                                              

                                              Available since: 4.0.0

                                              Returns

                                              Suspends automatically syncing the Store with its Proxy. ...

                                              Suspends automatically syncing the Store with its Proxy. Only applicable if autoSync is true

                                              Available since: 4.1.0

                                              Suspends the firing of all events. ...

                                              Suspends the firing of all events. (see resumeEvents)

                                              Available since: 2.3.0

                                              Parameters

                                              • queueSuspended : Boolean

                                                Pass as 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. ...

                                              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.

                                              Available since: 4.0.0

                                              Parameters

                                              • 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:

                                                  Parameters

                                                  • batch : Ext.data.Batch

                                                    The 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:

                                                  Parameters

                                                  • batch : Ext.data.Batch

                                                    The 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:

                                                  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

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

                                              Returns

                                              Fires

                                              ( eventName, fn, [scope] )
                                              Shorthand for removeListener. ...

                                              Shorthand for removeListener.

                                              Available since: 1.1.0

                                              Parameters

                                              • 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 addListener or the listener will not be removed.

                                              ...

                                              Available since: 4.0.0

                                              Parameters

                                              Fires

                                                Defined By

                                                Static methods

                                                ( config )privatestatic
                                                ...

                                                Available since: 4.1.1

                                                Parameters

                                                ( members )chainableprivatestatic
                                                ...

                                                Available since: 4.1.1

                                                Parameters

                                                ( name, member )chainableprivatestatic
                                                ...

                                                Available since: 4.1.1

                                                Parameters

                                                ( members )chainablestatic
                                                Add methods / properties to the prototype of this class. ...

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

                                                Available since: 4.1.0

                                                Parameters

                                                ( members ) : Ext.Basechainablestatic
                                                Add / override static properties of this class. ...

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

                                                Available since: 4.0.2

                                                Parameters

                                                Returns

                                                ( xtype )chainableprivatestatic
                                                ...

                                                Available since: 4.1.1

                                                Parameters

                                                ( fromClass, members ) : Ext.Basechainableprivatestatic
                                                Borrow another class' members to the prototype of this class. ...

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

                                                Available since: 4.0.2

                                                Parameters

                                                • fromClass : Ext.Base

                                                  The class to borrow members from

                                                • members : Array/String

                                                  The names of the members to borrow

                                                Returns

                                                ( alias, origin )static
                                                Create aliases for existing prototype methods. ...

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

                                                Available since: 4.0.2

                                                Parameters

                                                ( config )privatestatic
                                                ...

                                                Available since: 4.1.1

                                                Parameters

                                                Get the current class' name in string format. ...

                                                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'
                                                

                                                Available since: 4.0.4

                                                Returns

                                                ( )deprecatedstatic
                                                Adds members to class. ...

                                                Adds members to class.

                                                Available since: 4.0.2

                                                This method has been deprecated since 4.1

                                                Use addMembers instead.

                                                ( name, mixinClass )chainableprivatestatic
                                                Used internally by the mixins pre-processor ...

                                                Used internally by the mixins pre-processor

                                                Available since: 4.1.1

                                                Parameters

                                                ( fn, scope )chainableprivatestatic
                                                ...

                                                Available since: 4.1.1

                                                Parameters

                                                ( members ) : Ext.Basechainabledeprecatedstatic
                                                Override members of this class. ...

                                                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"
                                                

                                                As of 4.1, direct use of this method is deprecated. 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).

                                                Available since: 4.0.2

                                                This method has been deprecated since 4.1.0

                                                Use Ext.define instead

                                                Parameters

                                                • members : Object

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

                                                Returns

                                                ...

                                                Available since: 4.1.1

                                                Defined By

                                                Events

                                                ( store, records, index, eOpts )
                                                Fired when a Model instance has been added to this Store. ...

                                                Fired when a Model instance has been added to this Store.

                                                Available since: 1.1.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, node, index, eOpts )
                                                Fires when a new child node is appended ...

                                                Fires when a new child node is appended

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, node, eOpts )
                                                Fires before a new child is appended, return false to cancel the append. ...

                                                Fires before a new child is appended, return false to cancel the append.

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, eOpts )
                                                Fires before this node is collapsed. ...

                                                Fires before this node is collapsed.

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, eOpts )
                                                Fires before this node is expanded. ...

                                                Fires before this node is expanded.

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, node, refNode, eOpts )
                                                Fires before a new child is inserted, return false to cancel the insert. ...

                                                Fires before a new child is inserted, return false to cancel the insert.

                                                Available since: 4.0.0

                                                Parameters

                                                Fires before a request is made for a new data object. ...

                                                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

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, oldParent, newParent, index, eOpts )
                                                Fires before this node is moved to a new location in the tree. ...

                                                Fires before this node is moved to a new location in the tree. Return false to cancel the move.

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, node, isMove, eOpts )
                                                Fires before a child is removed, return false to cancel the remove. ...

                                                Fires before a child is removed, return false to cancel the remove.

                                                Available since: 4.0.0

                                                Parameters

                                                Fired before a call to sync is executed. ...

                                                Fired before a call to sync is executed. Return false from any listener to cancel the sync

                                                Available since: 4.0.0

                                                Parameters

                                                ( store, records, indexes, eOpts )
                                                Fired at the end of the remove method when all records in the passed array have been removed. ...

                                                Fired at the end of the remove method when all records in the passed array have been removed.

                                                If many records may be removed in one go, then it is more efficient to listen for this event and perform any processing for a bulk remove than to listen for many remove events.

                                                Available since: 4.1.2

                                                Parameters

                                                Fired after the removeAll method is called. ...

                                                Fired after the removeAll method is called.

                                                Available since: 1.1.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, eOpts )
                                                Fires when this node is collapsed. ...

                                                Fires when this node is collapsed.

                                                Available since: 4.0.0

                                                Parameters

                                                Fires whenever the records in the Store have changed in some way - this could include adding or removing records, or ...

                                                Fires whenever the records in the Store have changed in some way - this could include adding or removing records, or updating the data in existing records

                                                Available since: 1.1.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, eOpts )
                                                Fires when this node is expanded. ...

                                                Fires when this node is expanded.

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, node, refNode, eOpts )
                                                Fires when a new child node is inserted. ...

                                                Fires when a new child node is inserted.

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, node, records, successful, eOpts )
                                                Fires whenever the store reads data from a remote data source. ...

                                                Fires whenever the store reads data from a remote data source.

                                                Available since: 4.0.0

                                                Parameters

                                                Overrides: Ext.data.AbstractStore.load

                                                Fires when this store's underlying reader (available via the proxy) provides new metadata. ...

                                                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

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, oldParent, newParent, index, eOpts )
                                                Fires when this node is moved to a new location in the tree ...

                                                Fires when this node is moved to a new location in the tree

                                                Available since: 4.0.0

                                                Parameters

                                                Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a widget that i...

                                                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.

                                                Available since: 4.1.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, node, isMove, eOpts )
                                                Fires when a child node is removed ...

                                                Fires when a child node is removed

                                                Available since: 4.0.0

                                                Parameters

                                                Overrides: Ext.data.AbstractStore.remove

                                                Ext.data.TreeStore
                                                view source
                                                ( root, eOpts )
                                                Fires whenever the root node is changed in the tree. ...

                                                Fires whenever the root node is changed in the tree.

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.TreeStore
                                                view source
                                                ( this, childNodes, eOpts )
                                                Fires when this node's childNodes are sorted. ...

                                                Fires when this node's childNodes are sorted.

                                                Available since: 4.0.0

                                                Parameters

                                                ( this, record, operation, modifiedFieldNames, eOpts )
                                                Fires when a Model instance has been updated. ...

                                                Fires when a Model instance has been updated.

                                                Available since: 1.1.0

                                                Parameters

                                                ( store, operation, eOpts )
                                                Fires whenever a successful write has been made via the configured Proxy ...

                                                Fires whenever a successful write has been made via the configured Proxy

                                                Available since: 3.4.0

                                                Parameters