Ext.chart.LegendItem

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

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

Defaults to: "ASC"

Available since: 4.0.0

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal|freezeEvent)$/

Available since: 4.0.0

End Definitions

Defaults to: true

Available since: 4.0.0

Defaults to: true

Available since: 4.0.0

Flag denoting that this object is sortable. Always true.

Defaults to: true

Available since: 4.0.0

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'

        return 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 property in each item that contains the data to sort.

Available since: 4.0.0

The collection of Sorters currently applied to this Store

Available since: 4.0.0

Performs the actual sorting based on a direction and a sorting function. Internally, this creates a temporary array of all items in the MixedCollection, sorts it and then writes the sorted array data back into this.items and this.keys

Available since: 3.4.0

Parameters

• property : String

  Property to sort by ('key', 'value', or 'index')

• dir : String (optional)

  Direction to sort 'ASC' or 'DESC'. Defaults to 'ASC'.

• fn : Function (optional)

  Comparison function that defines the sort order. Defaults to sorting by numeric value.

Inherit docs from MixedCollection

Adds an item to the collection. Fires the add event when complete.

Available since: Ext 1

Parameters

• key : String

  The key to associate with the item, or the new item.

  If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter.

• o : Object

  The item to add.

Returns

• Object

  The item added.

Overrides: Ext.util.AbstractMixedCollection.add

Adds all elements of an Array or an Object to the collection.

Available since: Ext 1

Parameters

• objs : Object/Array

  An Object containing properties which will be added to the collection, or an Array of values, each of which are added to the collection. Functions references will be added to the collection if allowFunctions has been set to true.

Available since: 4.0.0

Parameters

• obj : Object

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

Available since: 1.1.0

Parameters

• o : Object/String

  Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. Usage:

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

• more : String... (optional)

  Additional event names if multiple event names are being passed as separate parameters. Usage:

  this.addEvents('storeloaded', 'storecleared');
  

Available since: 4.0.6

Parameters

• members : Object

Returns

• Ext.Base

  this

Appends an event handler to this object.

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to listen for. May also be an object who's property names are event names.

• fn : Function

  The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope : Object (optional)

  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options : Object (optional)

  An object containing handler configuration.

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

  Combining Options

  Using the options argument, it is possible to combine different types of listeners:

  A delayed, one-time listener.

  myPanel.on('hide', this.handleClick, this, {
      single: true,
      delay: 100
  });
  

  Attaching multiple handlers in 1 call

  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple 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}
  });
  

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.

• opt : Object (optional)

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

• process the passed fx configuration.

Available since: 4.0.0

Parameters

• config : Object

Perform custom animation on this object.

This method is applicable to both the Component class and the Element class. It performs animated transitions of certain properties of this object over a specified timeline.

The sole parameter is an object which specifies start property values, end property values, and properties which describe the timeline. Of the properties listed below, only to is mandatory.

Properties include

• from
  An object which specifies start values for the properties being animated. If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon ths object being animated. See the sections below on Element and Component animation.
• to
  An object which specifies end values for the properties being animated.
• duration
  The duration in milliseconds for which the animation will run.
• easing
  A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:

  • ease
  • easeIn
  • easeOut
  • easeInOut
  • backIn
  • backOut
  • elasticIn
  • elasticOut
  • bounceIn
  • bounceOut
• keyframes
  This is an object which describes the state of animated properties at certain points along the timeline. it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.
• listeners
  This is a standard listeners configuration object which may be used to inject behaviour at either the beforeanimate event or the afteranimate event.

Animating an Element

• x
  The page X position in pixels.
• y
  The page Y position in pixels
• left
  The element's CSS left value. Units must be supplied.
• top
  The element's CSS top value. Units must be supplied.
• width
  The element's CSS width value. Units must be supplied.
• height
  The element's CSS height value. Units must be supplied.
• scrollLeft
  The element's scrollLeft value.
• scrollTop
  The element's scrollLeft value.
• opacity
  The element's opacity value. This must be a value between 0 and 1.

Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to directly animate certain properties of Components.

Animating a Component

• x
  The Component's page X position in pixels.
• y
  The Component's page Y position in pixels
• left
  The Component's left value in pixels.
• top
  The Component's top value in pixels.
• width
  The Component's width value in pixels.
• width
  The Component's width value in pixels.
• dynamic
  Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.

For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:

myWindow = Ext.create('Ext.window.Window', {
    title: 'Test Component animation',
    width: 500,
    height: 300,
    layout: {
        type: 'hbox',
        align: 'stretch'
    },
    items: [{
        title: 'Left: 33%',
        margins: '5 0 5 5',
        flex: 1
    }, {
        title: 'Left: 66%',
        margins: '5 5 5 5',
        flex: 2
    }]
});
myWindow.show();
myWindow.header.el.on('click', function() {
    myWindow.animate({
        to: {
            width: (myWindow.getWidth() == 500) ? 700 : 500,
            height: (myWindow.getHeight() == 300) ? 400 : 300,
        }
    });
});

For performance reasons, by default, the internal layout is only updated when the Window reaches its final "to" size. If dynamic updating of the Window's child Components is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.

Available since: 4.0.0

Parameters

• config : Object

  An object containing properties which describe the animation's start and end states, and the timeline of the animation.

Returns

• Object

  this

Available since: 4.0.0

Parameters

• o : Object

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

        return this;
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

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

Parameters

• args : Array/Arguments

  The arguments, either an array or the arguments object

Returns

• Object

  Returns the result after calling the overridden method

Call the parent's overridden method. For example:

Ext.define('My.own.A', {
    constructor: function(test) {
        alert(test);
    }
});

Ext.define('My.own.B', {
    extend: 'My.own.A',

    constructor: function(test) {
        alert(test);

        this.callParent([test + 1]);
    }
});

Ext.define('My.own.C', {
    extend: 'My.own.B',

    constructor: function() {
        alert("Going to call parent's overriden constructor...");

        this.callParent(arguments);
    }
});

var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                         // alerts '2', then alerts '3'

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 from the superclass' method

Removes all items from the collection. Fires the clear event when complete.

Available since: Ext 1

Removes all listeners for this object including the managed listeners

Available since: 4.0.0

Removes all managed listeners for this object.

Available since: 4.0.0

Creates a shallow copy of this collection

Available since: Ext 1

Returns

• Ext.util.MixedCollection

Collects unique values of a particular property in this MixedCollection

Available since: 4.0.0

Parameters

• property : String

  The property to collect on

• root : String (optional)

  'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object

• allowBlank : Boolean (optional)

  Pass true to allow null, undefined or empty string values

Returns

• Array

  The unique values

Returns true if the collection contains the passed Object as an item.

Available since: Ext 1

Parameters

• o : Object

  The Object to look for in the collection.

Returns

• Boolean

  True if the collection contains the Object as an item.

Returns true if the collection contains the passed Object as a key.

Available since: Ext 1

Parameters

• key : String

  The key to look for in the collection.

Returns

• Boolean

  True if the collection contains the Object as a key.

Continue to fire event.

Available since: Ext JS 4.0.7

Parameters

• eventName : String
• args : Array
• bubbles : Boolean

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

Returns

• Function

Returns a regular expression based on the given value and matching options. This is used internally for finding and filtering, and by Ext.data.Store.filter

Available since: Ext 3

Parameters

• value : String

  The value to create the regex for. This is escaped using Ext.escapeRe

• anyMatch : Boolean

  True to allow any match - no regex start/end line anchors will be added. Defaults to false

• caseSensitive : Boolean

  True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false.

• exactMatch : Boolean

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

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

• Ext.util.Sorter[]

  Array of Ext.util.Sorter objects

Destroys the SpriteGroup

Available since: 4.0.0

Available since: 4.0.0

Parameters

• sorterFn : Object

Executes the specified function once for every item in the collection, passing the following arguments:

The function should return a boolean value. Returning false from the function will stop the iteration.

Available since: Ext 1

Parameters

• fn : Function

  The function to execute for each item.

• scope : Object (optional)

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

Executes the specified function once for every key in the collection, passing each key, and its associated item as the first two parameters.

Available since: Ext 1

Parameters

• fn : Function

  The function to execute for each item.

• scope : Object (optional)

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

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.override(Ext.form.field.Base, {
    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
        this.enableBubble('change');
    }),

    //  We know that we want Field's events to bubble directly to the FormPanel.
    getBubbleTarget : function() {
        if (!this.formPanel) {
            this.formPanel = this.findParentByType('form');
        }
        return this.formPanel;
    }
});

var myForm = new Ext.formPanel({
    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

• events : String/String[]

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

Extracts all of the given property values from the items in the MC. Mainly used as a supporting method for functions like sum and collect.

Available since: 4.0.0

Parameters

• property : String

  The property to extract

• root : String (optional)

  'root' property to extract the first argument from. This is used mainly when extracting field data from Model instances, where the fields are stored inside the 'data' object

Returns

• Array

  The extracted values

Filters the objects in this collection by a set of Filters, or by a single property/value pair with optional parameters for substring matching and case sensitivity. See Filter for an example of using Filter objects (preferred). Alternatively, MixedCollection can be easily filtered by property like this:

//create a simple store with a few people defined
var people = new Ext.util.MixedCollection();
people.addAll([
    {id: 1, age: 25, name: 'Ed'},
    {id: 2, age: 24, name: 'Tommy'},
    {id: 3, age: 24, name: 'Arne'},
    {id: 4, age: 26, name: 'Aaron'}
]);

//a new MixedCollection containing only the items where age == 24
var middleAged = people.filter('age', 24);

Available since: Ext 1

Parameters

• property : Ext.util.Filter[]/String

  A property on your objects, or an array of Filter objects

• value : String/RegExp

  Either string that the property values should start with or a RegExp to test against the property

• anyMatch : Boolean (optional)

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

  Defaults to: false

• caseSensitive : Boolean (optional)

  True for case sensitive comparison.

  Defaults to: false

Returns

• Ext.util.MixedCollection

  The new filtered collection

Filter by a function. Returns a new collection that has been filtered. The passed function will be called with each object in the collection. If the function returns true, the value is included otherwise it is filtered.

Available since: Ext 1

Parameters

• fn : Function

  The function to be called, it will receive the args o (the object), k (the key)

• scope : Object (optional)

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

Returns

• Ext.util.MixedCollection

  The new filtered collection

Returns the first item in the collection which elicits a true return value from the passed selection function.

Available since: Ext 1

Returns the first item in the collection which elicits a true return value from the passed selection function.

Available since: 4.0.0

Parameters

• fn : Function

  The selection function to execute for each item.

• scope : Object (optional)

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

Returns

• Object

  The first item in the collection which returned true from the selection function, or null if none was found

Finds the index of the first matching object in this collection by a specific property/value.

Available since: Ext 2

Parameters

• property : String

  The name of a property on your objects.

• value : String/RegExp

  A string that the property values should start with or a RegExp to test against the property.

• start : Number (optional)

  The index to start searching at.

  Defaults to: 0

• anyMatch : Boolean (optional)

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

  Defaults to: false

• caseSensitive : Boolean (optional)

  True for case sensitive comparison.

  Defaults to: false

Returns

• Number

  The matched index or -1

Find the index of the first matching object in this collection by a function. If the function returns true it is considered a match.

Available since: Ext 2

Parameters

• fn : Function

  The function to be called, it will receive the args o (the object), k (the key).

• scope : Object (optional)

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

• start : Number (optional)

  The index to start searching at.

  Defaults to: 0

Returns

• Number

  The matched index or -1

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.

Returns the first item in the collection.

Available since: Ext 1

Returns

• Object

  the first item in the collection..

Returns the item associated with the passed key OR index. Key has priority over index. This is the equivalent of calling getByKey first, then if nothing matched calling getAt.

Available since: Ext 1

Parameters

• key : String/Number

  The key or index of the item.

Returns

• Object

  If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null.

Returns the current animation if this object has any effects actively running or queued, else returns false.

Available since: 4.0.0

Returns

• Ext.fx.Anim/Boolean

  Anim if element has active effects, else false

Returns the item at the specified index.

Available since: 4.0.0

Parameters

• index : Number

  The index of the item.

Returns

• Object

  The item at the specified index.

Returns the group bounding box. Behaves like Ext.draw.Sprite.getBBox method.

Available since: 4.0.0

Returns

• Object

  an object with x, y, width, and height properties.

Gets the bubbling parent for an Observable

Available since: Ext JS 4.0.7

Returns

• Ext.util.Observable

  The bubble parent. null is returned if no bubble target exists

Returns the item associated with the passed key.

Available since: 4.0.0

Parameters

• key : String/Number

  The key of the item.

Returns

• Object

  The item associated with the passed key.

Returns the number of items in the collection.

Available since: Ext 1

Returns

• Number

  the number of items in the collection.

MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation simply returns item.id but you can provide your own implementation to return a different value as in the following examples:

// normal way
var mc = new Ext.util.MixedCollection();
mc.add(someEl.dom.id, someEl);
mc.add(otherEl.dom.id, otherEl);
//and so on

// using getKey
var mc = new Ext.util.MixedCollection();
mc.getKey = function(el){
   return el.dom.id;
};
mc.add(someEl);
mc.add(otherEl);

// or via the constructor
var mc = new Ext.util.MixedCollection(false, function(el){
   return el.dom.id;
});
mc.add(someEl);
mc.add(otherEl);

Available since: Ext 1

Parameters

• item : Object

  The item for which to find the key.

Returns

• Object

  The key for the passed item.

Returns a range of items in this collection

Available since: Ext 1

Parameters

• startIndex : Number (optional)

  The starting index. Defaults to 0.

• endIndex : Number (optional)

  The ending index. Defaults to the last item.

Returns

• Array

  An array of items

Available since: 4.0.0

Grab the surface from the items

Available since: 4.0.0

Returns

• Ext.draw.Surface

  The surface, null if not found

Returns the current animation if this object has any effects actively running or queued, else returns false.

Available since: 4.0.0

Returns

• Ext.fx.Anim/Boolean

  Anim if element has active effects, else false

Checks to see if this object has any listeners for a specified event

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, else false

Hides all sprites. If the first parameter of the method is true then a redraw will be forced for each sprite.

Available since: 4.0.0

Parameters

• redraw : Boolean

  Flag to immediatly draw the change.

Returns

• Ext.draw.CompositeSprite

  this

Returns index within the collection of the passed Object.

Available since: Ext 1

Parameters

• o : Object

  The item to find the index of.

Returns

• Number

  index of the item. Returns -1 if not found.

Returns index within the collection of the passed key.

Available since: Ext 1

Parameters

• key : String

  The key to find the index of.

Returns

• Number

  index of the key.

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

        return this;
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Available since: 4.0.0

Parameters

• config : Object

Returns

• Object

  mixins The mixin prototypes as key - value pairs

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

Available since: 4.0.0

Inserts an item at the specified index in the collection. Fires the add event when complete.

Available since: Ext 1

Parameters

• index : Number

  The index to insert the item at.

• key : String

  The key to associate with the new item, or the item itself.

• o : Object (optional)

  If the second parameter was a key, the new item.

Returns

• Object

  The item inserted.

Overrides: Ext.util.AbstractMixedCollection.insert

Returns the last item in the collection.

Available since: Ext 1

Returns

• Object

  the last item in the collection..

Used internally by the mixins pre-processor

Available since: 4.0.6

Parameters

• name : Object
• cls : Object

Shorthand for addManagedListener.

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

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.

• opt : Object (optional)

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

Shorthand for removeManagedListener.

Removes listeners that were added by the mon method.

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.

Shorthand for addListener.

Appends an event handler to this object.

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to listen for. May also be an object who's property names are event names.

• fn : Function

  The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope : Object (optional)

  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options : Object (optional)

  An object containing handler configuration.

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

  Combining Options

  Using the options argument, it is possible to combine different types of listeners:

  A delayed, one-time listener.

  myPanel.on('hide', this.handleClick, this, {
      single: true,
      delay: 100
  });
  

  Attaching multiple handlers in 1 call

  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple 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}
  });
  

Available since: 4.0.0

Available since: 4.0.0

Parameters

• e : Object

Available since: 4.0.0

Parameters

• e : Object

Available since: 4.0.0

Parameters

• e : Object

Available since: 4.0.0

Parameters

• e : Object

Available since: 4.0.0

Parameters

• e : Object

Available since: 4.0.6

Parameters

• name : Object
• value : Object

Available since: 4.0.0

Parameters

• name : Object
• fn : Object

Available since: 1.1.0

Available since: 4.0.0

Available since: 4.0.0

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

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

Inherit docs from MixedCollection

Remove an item from the collection.

Available since: Ext 1

Parameters

• o : Object

  The item to remove.

Returns

• Object

  The item removed or false if no item was removed.

Overrides: Ext.util.AbstractMixedCollection.remove

Remove all items in the passed array from the collection.

Available since: 4.0.0

Parameters

• items : Array

  An array of items to be removed.

Returns

• Ext.util.MixedCollection

  this object

Remove an item from a specified index in the collection. Fires the remove event when complete.

Available since: Ext 1

Parameters

• index : Number

  The index within the collection of the item to remove.

Returns

• Object

  The item removed or false if no item was removed.

Removed an item associated with the passed key fom the collection.

Available since: 4.0.0

Parameters

• key : String

  The key of the item to remove.

Returns

• Object

  The item removed or false if no item was removed.

Available since: 4.0.0

Parameters

• obj : Object

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.

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.

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

Reorders each of the items based on a mapping from old index to new index. Internally this just translates into a sort. The 'sort' event is fired whenever reordering has occured.

Available since: 3.4.0

Parameters

• mapping : Object

  Mapping from old item index to new item index

Replaces an item in the collection. Fires the replace event when complete.

Available since: Ext 1

Parameters

• key : String

  The key associated with the item to replace, or the replacement item.

  If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter.

• o : Object

  {Object} o (optional) If the first parameter passed was a key, the item to associate with that key.

Returns

• Object

  The new item.

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

Ensures that all effects queued after sequenceFx is called on this object are run in sequence. This is the opposite of syncFx.

Available since: 4.0.0

Returns

• Object

  this

Iterates through all sprites calling setAttributes on each one. For more information Ext.draw.Sprite provides a description of the attributes that can be set with this method.

Available since: 4.0.0

Parameters

• attrs : Object

  Attributes to be changed on the sprite.

• redraw : Boolean

  Flag to immediatly draw the change.

Returns

• Ext.draw.CompositeSprite

  this

Available since: 4.0.0

Parameters

• config : Object

Returns

• Ext.Base

  this

Available since: 4.0.0

Parameters

• obj : Object

Shows all sprites. If the first parameter of the method is true then a redraw will be forced for each sprite.

Available since: 4.0.0

Parameters

• redraw : Boolean

  Flag to immediatly draw the change.

Returns

• Ext.draw.CompositeSprite

  this

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[]

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

• direction : String

  The overall direction to sort the data by. Defaults to "ASC".

Returns

• Ext.util.Sorter[]

Sorts the collection by a single sorter function

Available since: 4.0.0

Parameters

• sorterFn : Function

  The function to sort by

Sorts this collection by keys.

Available since: 4.0.0

Parameters

• direction : String (optional)

  'ASC' or 'DESC'. Defaults to 'ASC'.

• fn : Function (optional)

  Comparison function that defines the sort order. Defaults to sorting by case insensitive string.

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++;

        return this;
    },

    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

• Ext.Class

Stops any running effects and clears this object's internal effects queue if it contains any additional effects that haven't started yet.

Available since: 4.0.0

Returns

• Ext.Element

  The Element

Available since: 4.0.0

Returns

• Ext.Element

  The Element

Collects all of the values of the given property and returns their sum

Available since: 4.0.0

Parameters

• property : String

  The property to sum by

• root : String (optional)

  'root' property to extract the first argument from. This is used mainly when summing fields in records, where the fields are all stored inside the 'data' object

• start : Number (optional)

  The record index to start at

  Defaults to: 0

• end : Number (optional)

  The record index to end at

  Defaults to: -1

Returns

• Number

  The total

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.

Ensures that all effects queued after syncFx is called on this object are run concurrently. This is the opposite of sequenceFx.

Available since: 4.0.0

Returns

• Object

  this

Shorthand for removeListener.

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.

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 : String/String[]

  The names of the members to borrow

Returns

• Ext.Base

  this

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Available since: 4.0.2

Returns

• Object

  the created instance.

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Available since: 4.0.2

Parameters

• alias : String/Object

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

• origin : String/Object

  The original method name

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

• String

  className

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.implement({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat;
 kitty.meow();

Available since: 4.0.2

Parameters

• members : Object

Override prototype members of this class. Overridden methods can be invoked via callOverridden

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

        return this;
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Available since: 4.0.2

Parameters

• members : Object

Returns

• Ext.Base

  this

Fires when the collection is cleared.

Available since: Ext 1

Parameters

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when an item is removed from the collection.

Available since: Ext 1

Parameters

• o : Object

  The item being removed.

• key : String (optional)

  The key associated with the removed item.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when an item is replaced in the collection.

Available since: Ext 1

Parameters

• key : String

  he key associated with the new added.

• old : Object

  The item being replaced.

• new : Object

  The new item.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.