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 and inheritance. 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 5.0.0

Guides
API
Ext
Getting Started
What's New?
Upgrades and Migrations
Core Concepts
Architecture
UI Components
Tutorials
Backend Connectors
Other Resources
Supported Browsers
top

Ext.chart.theme.SkyGradients chart: chart.theme.sky-gradients, chart.theme.Sky:gradients private singleton

Filters
Related Classes

Hierarchy

Ext.Base
Ext.chart.theme.Base
Ext.chart.theme.SkyGradients

Inherited Mixins

Ext.mixin.Factoryable

NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.
No members found using the current filters

configs

Array : Array
bindable bind

of colors/gradients to be used by the theme. Defaults to colorDefaults.

getArray Array

Returns the value of Array

Returns

Array

setArray (Array)

Sets the value of Array

Parameters

Array :  Array

axis : Object
bindable bind

Theme defaults for the axes. Can apply to all axes or only axes with a specific position. For example:

axis: {
  defaults: {
    style: {strokeStyle: 'red'}
  },
  left: {
    title: {fillStyle: 'green'}
  }
}

The values from the axis.defaults and axis.position configs (where position is a valid axis Ext.chart.axis.Axis#position, e.g. 'bottom') will be applied to corresponding Ext.chart.axis.Axis configs. E.g., the axis.defaults.label config will apply to the Ext.chart.axis.Axis#label config of all axes, where the axis.left.titleMargin config will only apply to the Ext.chart.axis.Axis#titleMargin config of all axes positioned to the left.

Defaults to: { defaults: { label: { x: 0, y: 0, textBaseline: 'middle', textAlign: 'center', fontSize: 'default', fontFamily: 'default', fontWeight: 'default' }, title: { fontSize: 'default*1.23', fontFamily: 'default', fontWeight: 'default' } }, top: { style: { textPadding: 5 } }, bottom: { style: { textPadding: 5 } } }

getAxis Object

Returns the value of axis

Returns

Object

setAxis (axis)

Sets the value of axis

Parameters

axis :  Object

background
deprecated dep bindable bind

Defaults to: null

Available since: 5.0.1

Deprecated
Use the #chart.background config instead.

getBackground

Returns the value of background

Returns

setBackground (background)

Sets the value of background

Parameters

background :  Object

baseColor
bindable bind private pri

Defaults to: '#4ce0e7'

getBaseColor

Returns the value of baseColor

Returns

setBaseColor (baseColor)

Sets the value of baseColor

Parameters

baseColor :  Object

chart : Object
bindable bind

Theme defaults for the chart. Can apply to all charts or just a specific type of chart. For example:

chart: {
  defaults: {
    background: 'lightgray'
  },
  polar: {
    background: 'green'
  }
}

The values from the chart.defaults and chart.type configs (where type is a valid chart xtype, e.g. Ext.chart.CartesianChart or Ext.chart.PolarChart) will be applied to corresponding chart configs. E.g., the chart.defaults.background config will set the Ext.chart.AbstractChart#background config of all charts, where the chart.cartesian.flipXY config will only set the Ext.chart.CartesianChart#flipXY config of all cartesian charts.

Defaults to: { defaults: { background: 'white' } }

getChart Object

Returns the value of chart

Returns

Object

setChart (chart)

Sets the value of chart

Parameters

chart :  Object

series : Object
bindable bind

Theme defaults for the series. Can apply to all series or just a specific type of series. For example:

series: {
  defaults: {
    style: {
      lineWidth: 2
    }
  },
  bar: {
    animation: {
      easing: 'bounceOut',
      duration: 1000
    }
  }
}

The values from the series.defaults and series.type configs (where type is a valid series Ext.chart.series.Series#type, e.g. 'line') will be applied to corresponding series configs. E.g., the series.defaults.label config will apply to the Ext.chart.series.Series#label config of all series, where the series.line.step config will only apply to the Ext.chart.series.Line#step config of Ext.chart.series.Line series.

Defaults to: { defaults: { label: { fontFamily: 'default', fontWeight: 'default', fontSize: 'default*1.077', textBaseline: 'middle', textAlign: 'center' }, labelOverflowPadding: 5 } }

getSeries Object

Returns the value of series

Returns

Object

setSeries (series)

Sets the value of series

Parameters

series :  Object

seriesThemes
bindable bind private pri

getSeriesThemes

Returns the value of seriesThemes

Returns

setSeriesThemes (seriesThemes)

Sets the value of seriesThemes

Parameters

seriesThemes :  Object

sprites : Object
bindable bind

Default style for the custom chart sprites by type. For example:

sprites: {
  text: {
    fontWeight: 300
  }
}

These sprite attribute overrides will apply to custom sprites of all charts specified using the Ext.draw.Container#sprites config. The overrides are specified by sprite type, e.g. sprites.text config tells to apply given attributes to all Ext.draw.sprite.Text sprites.

Defaults to: { text: { fontSize: 'default', fontWeight: 'default', fontFamily: 'default' } }

getSprites Object

Returns the value of sprites

Returns

Object

setSprites (sprites)

Sets the value of sprites

Parameters

sprites :  Object

The : Object
bindable bind

gradient config to be used by series' sprites. E.g.:

{
  type: 'linear',
  degrees: 90
}

Please refer to the documentation for the Ext.draw.gradient.Linear and Ext.draw.gradient.Radial gradients for all possible options. The color stops for the gradients will be generated by the theme based on the colors config.

Defaults to: null

getThe Object

Returns the value of The

Returns

Object

setThe (The)

Sets the value of The

Parameters

The :  Object

useGradients
deprecated dep bindable bind

Defaults to: false

Available since: 5.0.1

Deprecated
Use the #gradients config instead.

getUseGradients

Returns the value of useGradients

Returns

setUseGradients (useGradients)

Sets the value of useGradients

Parameters

useGradients :  Object

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

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

factoryConfig : Object

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

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

$onExtended
static sta private pri

Defaults to: []

methods

* ( v1 , v2 )
private pri

Parameters

v1 :  Object

v2 :  Object

+ ( v1 , v2 )
private pri

Parameters

v1 :  Object

v2 :  Object

- ( v1 , v2 )
private pri

Parameters

v1 :  Object

v2 :  Object

addCachedConfig ( config , isMixin )
private pri

Parameters

config :  Object

isMixin :  Object

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

applyBaseColor ( baseColor )
private pri

Parameters

baseColor :  Object

applyColors ( newColors )
private pri

Parameters

newColors :  Object

applySeriesThemes ( newSeriesThemes )
private pri

Parameters

newSeriesThemes :  Object

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

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

constructor ( config )
private pri

Parameters

config :  Object

destroy
protected pro

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further.

get
private pri

getAxis

see: axis

getBaseColor
private

see: baseColor

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.

getInitialConfig ( [name] ) : Object / Mixed

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

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.

getThe

see: The

hasConfig ( config )
private pri

Parameters

config :  Object

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

onClassMixedIn ( targetClass )
private pri

Parameters

targetClass :  Object

replaceDefaults ( target )
private pri

Parameters

target :  Object

set ( value )
private pri

Parameters

value :  Object

setAxis

see: axis

setBaseColor
private

see: baseColor

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

setThe

see: The

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

updateBackground ( background )
private pri

Parameters

background :  Object

updateGradients ( gradients )
private pri

Parameters

gradients :  Object

updateUseGradients ( useGradients )
private pri

Parameters

useGradients :  Object

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 :  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 : Object
static sta

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.

Returns

:Object

the created instance.

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

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

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 5.0.0

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation