Docs Help

Terms, Icons, and Labels

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

Access Levels

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

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

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

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

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

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

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

Getter and Setter Methods

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

History Bar

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

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

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

Search and Filters

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

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

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

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

API Doc Class Metadata

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

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext JS 6.2.1 - Classic Toolkit


top

Hierarchy

Ext.Base
Ext.draw.Matrix

Summary

Ext.draw.Matix is a utility class used to calculate affine transformation matrix. The matrix class is used to apply transformations to existing Ext.draw.sprite.Sprite using a number of convenience transform methods.

Transformations configured directly on a sprite are processed in the following order: scaling, rotation, and translation. The matrix class offers additional flexibility. Once a sprite is created, you can use the matrix class's transform methods as many times as needed and in any order you choose.

To demonstrate, we'll start with a simple Ext.draw.sprite.Rect sprite with the intent of rotating it 180 degrees with the bottom right corner being the center of rotation. To begin, let's look at the initial, untransformed sprite:

Next, we'll use the rotate and translate methods from our matrix class to position the rect sprite.

In the previous example we perform the following steps in order to achieve our desired rotated output:

  • translate the rect to the right and down by 100
  • rotate by 180 degrees
  • translate the rect to the right and down by 100

Note: A couple of things to note at this stage; 1) the rotation center point is the upper left corner of the sprite by default and 2) with transformations, the sprite itself isn't transformed, but rather the entire coordinate plane of the sprite is transformed. The coordinate plane itself is translated by 100 and then rotated 180 degrees. And that is why in the third step we translate the sprite using negative values. Translating by -100 in the third step results in the sprite visually moving to the right and down within the draw container.

Fortunately there is a shortcut we can apply using two optional params of the rotate method allowing us to specify the center point of rotation:

This class is compatible with SVGMatrix except:

  1. Ext.draw.Matrix is not read only
  2. Using Number as its values rather than floats

Using this class helps to reduce the severe numeric problem with HTML Canvas and SVG transformation

Additionally, there's no way to get the current transformation matrix in Canvas.

No members found using the current filters

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of false stores config values as properties using their exact name (no prefix).

Defaults to:

true

Available since: 5.0.0

$configStrict : Boolean
private pri

The value true instructs the initConfig method to only honor values for properties declared in the config block of a class. When false, properties that are not declared in a config block will be placed on the instance.

Defaults to:

true

Available since: 5.0.0

a : Number

Get x-to-x component of the matrix. Avoid using it for performance consideration. Use getXX instead.

clearPropertiesOnDestroy : Boolean / "async"
protected pro

Setting this property to false will prevent nulling object references on a Class instance after destruction. Setting this to "async" will delay the clearing for approx 50ms.

Defaults to:

true

Available since: 6.2.0

clearPrototypeOnDestroy : Boolean
private pri

Setting this property to true will result in setting the object's prototype to null after the destruction sequence is fully completed. After that, most attempts at calling methods on the object instance will result in "method not defined" exception. This can be very helpful with tracking down otherwise hard to find bugs like runaway Ajax requests, timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support Object.setPrototypeOf method, and is only available in debugging mode.

Defaults to:

false

Available since: 6.2.0

destroyed : Boolean
protected pro

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

Defaults to:

false

isConfiguring : Boolean
readonly ro protected pro

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

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

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

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

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

Defaults to:

true

self : Ext.Class
protected pro

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Defaults to:

Base

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

addDeprecations ( deprecations )
private pri

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

Parameters

deprecations :  Object

append ( xx, xy, yx, yy, dx, dy ) : Ext.draw.Matrix
chainable ch

Postpend a matrix onto the current.

Note: The given transform will come before the current one.

Parameters

xx :  Number

Coefficient from x to x.

xy :  Number

Coefficient from x to y.

yx :  Number

Coefficient from y to x.

yy :  Number

Coefficient from y to y.

dx :  Number

Offset of x.

dy :  Number

Offset of y.

Returns

:Ext.draw.Matrix

this

appendMatrix ( matrix ) : Ext.draw.Matrix

Postpend a matrix onto the current.

Note: The given transform will come before the current one.

Parameters

matrix :  Ext.draw.Matrix

Returns

:Ext.draw.Matrix

this

callOverridden ( args ) : Object
deprecated dep protected pro

Call the original method that was previously overridden with Ext.Base#override

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

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

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the overridden method

Deprecated since version 4.1.0

callParent ( args ) : Object
protected pro

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static and private methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10));     // alerts 10
 alert(My.Derived2.method(10)); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use method-callSuper. This is often done to patch a method to fix a bug.

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     extend: 'Ext.some.Class',

     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

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

 Ext.define('App.patches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use method-callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the superclass method

clone Ext.draw.Matrix

Clone this matrix.

Returns

:Ext.draw.Matrix

constructor ( xx, xy, yx, yy, dx, dy )

Create an affine transform matrix.

Parameters

xx :  Number

Coefficient from x to x

xy :  Number

Coefficient from x to y

yx :  Number

Coefficient from y to x

yy :  Number

Coefficient from y to y

dx :  Number

Offset of x

dy :  Number

Offset of y

destroy

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further in any way, including access to its methods and properties.

To prevent potential memory leaks, all object references will be nulled at the end of destruction sequence, unless clearPropertiesOnDestroy is set to false.

equals ( matrix ) : Boolean
deprecated dep

Available since: 6.0.1

Parameters

matrix :  Ext.draw.Matrix

Returns

:Boolean

Deprecated

flipX Ext.draw.Matrix

Horizontally flip the matrix

Returns

:Ext.draw.Matrix

this

flipY Ext.draw.Matrix

Vertically flip the matrix

Returns

:Ext.draw.Matrix

this

get ( i, j ) : String
private pri

Parameters

i :  Number

j :  Number

Returns

:String

getConfig ( [name], [peek] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

true to peek at the raw value without calling the getter.

Defaults to: false

Returns

:Object

The config property value.

getDX Number

Get offset x component of the matrix.

Returns

:Number

getDY Number

Get offset y component of the matrix.

Returns

:Number

getInitialConfig ( [name] ) : Object/Mixed

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

Given this example Ext.button.Button definition and instance:

Ext.define('MyApp.view.Button', {
    extend: 'Ext.button.Button',
    xtype: 'mybutton',

    scale: 'large',
    enableToggle: true
});

var btn = Ext.create({
    xtype: 'mybutton',
    renderTo: Ext.getBody(),
    text: 'Test Button'
});

Calling btn.getInitialConfig() would return an object including the config options passed to the create method:

xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'

Calling btn.getInitialConfig('text')returns 'Test Button'.

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed

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

getScaleX Number

Get the x scale of the matrix.

Returns

:Number

getScaleY Number

Get the y scale of the matrix.

Returns

:Number

getXX Number

Get x-to-x component of the matrix

Returns

:Number

getXY Number

Get x-to-y component of the matrix.

Returns

:Number

getYX Number

Get y-to-x component of the matrix.

Returns

:Number

getYY Number

Get y-to-y component of the matrix.

Returns

:Number

hasConfig ( name )
private pri

Parameters

name :  String

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

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

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

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

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

inverse ( [target] ) : Ext.draw.Matrix

Return a new matrix represents the opposite transformation of the current one.

Parameters

target :  Ext.draw.Matrix (optional)

A target matrix. If present, it will receive the result of inversion to avoid creating a new object.

Returns

:Ext.draw.Matrix

isEqual ( matrix ) : Boolean

Determines if this matrix has the same values as another matrix.

Parameters

matrix :  Ext.draw.Matrix

A maxtrix or array of its elements.

Returns

:Boolean

isIdentity Boolean

Determines whether this matrix is an identity matrix (no transform).

Returns

:Boolean

multiply ( matrix ) : Ext.draw.Matrix

Performs matrix multiplication. This matrix is post-multiplied by another matrix.

Note: The given transform will come before the current one.

Parameters

matrix :  Ext.draw.Matrix

Returns

:Ext.draw.Matrix

this

precisionCompensate ( devicePixelRatio, comp ) : Object
private pri

Split Matrix to {{devicePixelRatio,c,0},{b,devicePixelRatio,0},{0,0,1}}.{{xx,0,dx},{0,yy,dy},{0,0,1}}

Parameters

devicePixelRatio :  Object

comp :  Object

Returns

:Object

Object with b,c,d=devicePixelRatio,xx,yy,dx,dy

precisionCompensateRect ( devicePixelRatio, comp ) : Object
private pri

Split Matrix to {{1,c,0},{b,d,0},{0,0,1}}.{{xx,0,dx},{0,xx,dy},{0,0,1}}

Parameters

devicePixelRatio :  Object

comp :  Object

Returns

:Object

Object with b,c,d,xx,yy=xx,dx,dy

prepend ( xx, xy, yx, yy, dx, dy ) : Ext.draw.Matrix
chainable ch

Prepend a matrix onto the current.

Note: The given transform will come after the current one.

Parameters

xx :  Number

Coefficient from x to x.

xy :  Number

Coefficient from x to y.

yx :  Number

Coefficient from y to x.

yy :  Number

Coefficient from y to y.

dx :  Number

Offset of x.

dy :  Number

Offset of y.

Returns

:Ext.draw.Matrix

this

prependMatrix ( matrix ) : Ext.draw.Matrix

Prepend a matrix onto the current.

Note: The given transform will come after the current one.

Parameters

matrix :  Ext.draw.Matrix

Returns

:Ext.draw.Matrix

this

reset Ext.draw.Matrix

Reset the matrix to identical.

Returns

:Ext.draw.Matrix

this

rotate ( angle, rcx, rcy, [prepend] ) : Ext.draw.Matrix

Rotate the matrix.

Parameters

angle :  Number

Radians to rotate

rcx :  Number/null

Center of rotation.

rcy :  Number/null

Center of rotation.

prepend :  Boolean (optional)

If true, this will transformation be prepended to the matrix.

Returns

:Ext.draw.Matrix

this

rotateFromVector ( x, y, [prepend] ) : Ext.draw.Matrix

Rotate the matrix by the angle of a vector.

Parameters

x :  Number

y :  Number

prepend :  Boolean (optional)

If true, this will transformation be prepended to the matrix.

Returns

:Ext.draw.Matrix

this

scale ( sx, sy, scx, scy, [prepend] ) : Ext.draw.Matrix

Scale the matrix.

Parameters

sx :  Number

sy :  Number

scx :  Number

scy :  Number

prepend :  Boolean (optional)

If true, this will transformation be prepended to the matrix.

Returns

:Ext.draw.Matrix

this

set ( xx, xy, yx, yy, dx, dy ) : Ext.draw.Matrix
chainable ch

Set the elements of a Matrix

Parameters

xx :  Number

xy :  Number

yx :  Number

yy :  Number

dx :  Number

dy :  Number

Returns

:Ext.draw.Matrix

this

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

Sets a single/multiple configuration options.

Parameters

name :  String/Object

The name of the property to set, or a set of key value pairs to set.

value :  Object (optional)

The value to set for the name parameter.

Returns

:Ext.Base

this

shearX ( factor ) : Ext.draw.Matrix

Shear the matrix along the x-axis.

Parameters

factor :  Object

The horizontal shear factor.

Returns

:Ext.draw.Matrix

this

shearY ( factor ) : Ext.draw.Matrix

Shear the matrix along the y-axis.

Parameters

factor :  Object

The vertical shear factor.

Returns

:Ext.draw.Matrix

this

skewX ( angle ) : Ext.draw.Matrix

Skew the matrix

Parameters

angle :  Number

Returns

:Ext.draw.Matrix

this

skewY ( angle ) : Ext.draw.Matrix

Skew the matrix

Parameters

angle :  Number

Returns

:Ext.draw.Matrix

this

split Object

Splits this transformation matrix into Scale, Rotate, Translate components, assuming it was produced by applying transformations in that order.

Returns

:Object

statics Ext.Class
protected pro

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

        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

Returns

:Ext.Class

toArray Array

Create an array of elements by horizontal order (xx,yx,dx,yx,yy,dy).

Returns

:Array

toContext ( ctx ) : Ext.draw.Matrix
chainable ch

Apply the matrix to a drawing context.

Parameters

ctx :  Object

Returns

:Ext.draw.Matrix

this

toString Array

Get an array of elements. The numbers are rounded to keep only 4 decimals.

Returns

:Array

toSvg String

Return a string that can be used as transform attribute in SVG.

Returns

:String

toVerticalArray Array/String

Create an array of elements by vertical order (xx,xy,yx,yy,dx,dy).

Returns

:Array/String

transformBBox ( bbox, [radius], [target] ) : Object

Parameters

bbox :  Object

Given as {x: Number, y: Number, width: Number, height: Number}.

radius :  Number (optional)

target :  Object (optional)

Optional target object to recieve the result. Recommended to use it for better gc.

Returns

:Object

Object with x, y, width and height.

transformList ( list ) : Array

Transform a list for points.

Note: will change the original list but not points inside it.

Parameters

list :  Array

Returns

:Array

list

transformPoint ( point ) : Array

Transform a point to a new array.

Parameters

point :  Array

Returns

:Array

translate ( x, y, [prepend] ) : Ext.draw.Matrix

Translate the matrix.

Parameters

x :  Number

y :  Number

prepend :  Boolean (optional)

If true, this will transformation be prepended to the matrix.

Returns

:Ext.draw.Matrix

this

x ( x, y ) : Number

Transform point returning the x component of the result.

Parameters

x :  Number

y :  Number

Returns

:Number

x component of the result.

y ( x, y ) : Number

Transform point returning the y component of the result.

Parameters

x :  Number

y :  Number

Returns

:Number

y component of the result.

Static Methods

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

Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

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

Parameters

name :  Object

member :  Object

Returns

:

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

Add methods / properties to the prototype of this class.

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

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

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

Parameters

members :  Object

The members to add to this class.

isStatic :  Boolean (optional)

Pass true if the members are static.

Defaults to: false

privacy :  Boolean (optional)

Pass true if the members are private. This only has meaning in debug mode and only for methods.

Defaults to: false

Returns

:

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

Add / override static properties of this class.

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

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base

this

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

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create ( mat ) : Ext.draw.Matrix
static sta

Create a matrix from mat. If mat is already a matrix, returns it.

Parameters

mat :  Mixed

Returns

:Ext.draw.Matrix

createAffineMatrixFromTwoPair ( x0, y0, x1, y1, x0p, y0p, x1p, y1p )
static sta

Return the affine matrix that transform two points (x0, y0) and (x1, y1) to (x0p, y0p) and (x1p, y1p)

Parameters

x0 :  Number

y0 :  Number

x1 :  Number

y1 :  Number

x0p :  Number

y0p :  Number

x1p :  Number

y1p :  Number

createAlias ( alias, origin )
static sta

Create aliases for existing prototype methods. Example:

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

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

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

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

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

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

Parameters

alias :  String/Object

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

origin :  String/Object

The original method name

createPanZoomFromTwoPair ( x0, y0, x1, y1, x0p, y0p, x1p, y1p )
static sta

Return the affine matrix that transform two points (x0, y0) and (x1, y1) to (x0p, y0p) and (x1p, y1p)

Parameters

x0 :  Number

y0 :  Number

x1 :  Number

y1 :  Number

x0p :  Number

y0p :  Number

x1p :  Number

y1p :  Number

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

fly ( elements ) : Ext.draw.Matrix
static sta

Create a flyweight to wrap the given array. The flyweight will directly refer the object and the elements can be changed by other methods.

Do not hold the instance of flyweight matrix.

Parameters

elements :  Array

Returns

:Ext.draw.Matrix

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Returns

:String

className

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

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

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

Parameters

fn :  Object

scope :  Object

Returns

:

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

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

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

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

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

Direct use of this method should be rare. Use Ext.define instead:

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

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

Returns

:Ext.Base

this class

triggerExtended
static sta private pri

Ext JS 6.2.1 - Classic Toolkit