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

Ext.chart.series.Gauge series: series.gauge

Summary

Creates a Gauge Chart.

No members found using the current filters

configs

Required Configs

colors : Array
bindable bind required req

An array of color values which is used for the needle and the sectors.

Defaults to:

null

getColors : Array

Returns the value of colors

Returns

Array

setColors (colors)

Sets the value of colors

Parameters

colors :  Array

Optional Configs

angleField : String

The store record field name to be used for the gauge value. The values bound to this field name must be positive real numbers.

animation : Object
bindable bind

The series animation configuration.

Defaults to:

null

getAnimation : Object

Returns the value of animation

Returns

Object

setAnimation (animation)

Sets the value of animation

Parameters

animation :  Object

background : Object
bindable bind

Sets the background of the surface the series is attached.

Defaults to:

null

getBackground : Object

Returns the value of background

Returns

Object

setBackground (background)

Sets the value of background

Parameters

background :  Object

bind : Object / String
bindable bind

Setting this config option adds or removes data bindings for other configs. For example, to bind the title config:

 var panel = Ext.create({
     xtype: 'panel',
     bind: {
         title: 'Hello {user.name}'
     }
 });

To dynamically add bindings:

 panel.setBind({
     title: 'Greetings {user.name}!'
 });

To remove bindings:

 panel.setBind({
     title: null
 });

The bind expressions are presented to Ext.app.ViewModel#bind. The ViewModel instance is determined by lookupViewModel.

Note: If bind is passed as a string, it will use the Ext.Component#property-defaultBindProperty for the binding.

Defaults to:

null

getBind : Object / String

Returns the value of bind

Returns

Object / String

setBind (bind)

Sets the value of bind

Parameters

bind :  Object / String

chart : Object
bindable bind private pri

The chart that the series is bound.

Defaults to:

null

getChart : Object

Returns the value of chart

Returns

Object

setChart (chart)

Sets the value of chart

Parameters

chart :  Object

controller : String / Object / Ext.app.ViewController
bindable bind

A string alias, a configuration object or an instance of a ViewController for this container. Sample usage:

Ext.define('MyApp.UserController', {
    alias: 'controller.user'
});

Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: 'user'
});
// Or
Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: {
        type: 'user',
        someConfig: true
    }
});

// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
    controller: ctrl
});

Defaults to:

null

getController Ext.app.ViewController

Returns the Ext.app.ViewController instance associated with this component via the controller config or setController method.

Returns

:Ext.app.ViewController
Returns this component's ViewController or null if one was not configured

setController (controller)

Sets the value of controller

Parameters

controller :  String / Object / Ext.app.ViewController

defaultListenerScope : Boolean
bindable bind

If true, this component will be the default scope (this pointer) for events specified with string names so that the scope can be dynamically resolved. The component will automatically become the defaultListenerScope if a controller is specified.

See the introductory docs for Ext.container.Container for some sample usages.

NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.

Defaults to:

false

getDefaultListenerScope : Boolean

Returns the value of defaultListenerScope

Returns

Boolean

setDefaultListenerScope (defaultListenerScope)

Sets the value of defaultListenerScope

Parameters

defaultListenerScope :  Boolean

donut : Number
bindable bind

Percentage of the radius of the donut hole compared to the entire disk.

Defaults to:

30

getDonut : Number

Returns the value of donut

Returns

Number

setDonut (donut)

Sets the value of donut

Parameters

donut :  Number

hidden : Boolean / Array
bindable bind

Defaults to:

false

getHidden : Boolean / Array

Returns the value of hidden

Returns

Boolean / Array

setHidden (hidden)

Sets the value of hidden

Parameters

hidden :  Boolean / Array

highlight : Boolean / Object
bindable bind

The sprite attributes that will be applied to the highlighted items in the series. If set to 'true', the default highlight style from highlightCfg will be used. If the value of this config is an object, it will be merged with the highlightCfg. In case merging of 'highlight' and 'highlightCfg' configs in not the desired behavior, provide the 'highlightCfg' instead.

Defaults to:

false

getHighlight : Boolean / Object

Returns the value of highlight

Returns

Boolean / Object

setHighlight (highlight)

Sets the value of highlight

Parameters

highlight :  Boolean / Object

highlightCfg : Object
bindable bind protected pro

The default style for the highlighted item. Used when highlight config was simply set to 'true' instead of specifying a style.

Defaults to:

{
    fillStyle: 'yellow',
    strokeStyle: 'red'
}

getHighlightCfg : Object

Returns the value of highlightCfg

Returns

Object

setHighlightCfg (highlightCfg)

Sets the value of highlightCfg

Parameters

highlightCfg :  Object

highlightItem : Object
bindable bind

The item currently highlighted in the series.

Defaults to:

null

getHighlightItem : Object

Returns the value of highlightItem

Returns

Object

setHighlightItem (highlightItem)

Sets the value of highlightItem

Parameters

highlightItem :  Object

itemInstancing : Object
bindable bind protected pro

The sprite template used to create sprite instances in the series.

Defaults to:

null

getItemInstancing : Object

Returns the value of itemInstancing

Returns

Object

setItemInstancing (itemInstancing)

Sets the value of itemInstancing

Parameters

itemInstancing :  Object

label : Object
bindable bind

Object with the following properties:

Defaults to:

{}

Properties

display : String

Specifies the presence and position of the labels. The possible values depend on the series type. For Line and Scatter series: 'under' | 'over' | 'rotate'. For Bar and 3D Bar series: 'insideStart' | 'insideEnd' | 'outside'. For Pie series: 'inside' | 'outside' | 'rotate' | 'horizontal' | 'vertical'. Area, Radar and Candlestick series don't support labels. For Area and Radar series please consider using tooltips instead. 3D Pie series currently always display labels 'outside'. For all series: 'none' hides the labels. Default value: 'none'.

color : String

The color of the label text. Default value: '#000' (black).

field : String/String[]

The name(s) of the field(s) to be displayed in the labels. If your chart has 3 series that correspond to the fields 'a', 'b', and 'c' of your model, and you only want to display labels for the series 'c', you must still provide an array `[null, null, 'c']`. Default value: null.

font : String

The font used for the labels. Default value: '14px Helvetica'.

orientation : String

Either 'horizontal' or 'vertical'. If not set (default), the orientation is inferred from the value of the flipXY property of the series. Default value: ''.

renderer : Function

Optional function for formatting the label into a displayable value. The arguments to the method are: - *`text`*, *`sprite`*, *`config`*, *`rendererData`*, *`index`* Label's renderer is passed the same arguments as renderer plus one extra 'text' argument which comes first.

Returns

:Object/String
The attributes that have been changed or added, or the text for the label. Example to enclose every other label in parentheses: renderer: function (text) { if (index % 2 == 0) { return '(' + text + ')' } } Default value: null.

getLabel : Object

Returns the value of label

Returns

Object

setLabel (label)

Sets the value of label

Parameters

label :  Object

labelOverflowPadding : Number
bindable bind

Extra distance value for which the labelOverflow listener is triggered.

Defaults to:

null

getLabelOverflowPadding : Number

Returns the value of labelOverflowPadding

Returns

Number

setLabelOverflowPadding (labelOverflowPadding)

Sets the value of labelOverflowPadding

Parameters

labelOverflowPadding :  Number

listeners : Object
bindable bind

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Ext.Component

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the Ext.view.View'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'); }
        }
    }
});

setListeners ( listeners )

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

Parameters

listeners :  Object

The listeners

marker : Object / Boolean
bindable bind

The sprite template used by marker instances on the series. If the value of the marker config is set to true or the type of the sprite instance is not specified, the Ext.draw.sprite.Circle sprite will be used.

Examples:

marker: true

marker: {
    radius: 8
}

marker: {
    type: 'arrow',
    fx: {
        duration: 200,
        easing: 'backOut'
    }
}

Defaults to:

null

getMarker : Object / Boolean

Returns the value of marker

Returns

Object / Boolean

setMarker (marker)

Sets the value of marker

Parameters

marker :  Object / Boolean

markerSubStyle : Object
bindable bind

This is cyclic used if series have multiple marker sprites.

Defaults to:

null

getMarkerSubStyle : Object

Returns the value of markerSubStyle

Returns

Object

setMarkerSubStyle (markerSubStyle)

Sets the value of markerSubStyle

Parameters

markerSubStyle :  Object

maximum : Number
bindable bind

The maximum value of the gauge.

Defaults to:

100

getMaximum : Number

Returns the value of maximum

Returns

Number

setMaximum (maximum)

Sets the value of maximum

Parameters

maximum :  Number

minimum : Number
bindable bind

The minimum value of the gauge.

Defaults to:

0

getMinimum : Number

Returns the value of minimum

Returns

Number

setMinimum (minimum)

Sets the value of minimum

Parameters

minimum :  Number

needle : Boolean
bindable bind

If true, display the gauge as a needle, otherwise as a sector.

Defaults to:

false

getNeedle : Boolean

Returns the value of needle

Returns

Boolean

setNeedle (needle)

Sets the value of needle

Parameters

needle :  Boolean

needleLength : Number
bindable bind

Percentage of the length of needle compared to the radius of the entire disk.

Defaults to:

90

getNeedleLength : Number

Returns the value of needleLength

Returns

Number

setNeedleLength (needleLength)

Sets the value of needleLength

Parameters

needleLength :  Number

needleWidth : Number
bindable bind

Width of the needle in pixels.

Defaults to:

4

getNeedleWidth : Number

Returns the value of needleWidth

Returns

Number

setNeedleWidth (needleWidth)

Sets the value of needleWidth

Parameters

needleWidth :  Number

overlaySurface : Object
bindable bind protected pro

The surface used to render series labels.

Defaults to:

null

getOverlaySurface : Object

Returns the value of overlaySurface

Returns

Object

setOverlaySurface (overlaySurface)

Sets the value of overlaySurface

Parameters

overlaySurface :  Object

publishes : String / String[] / Object
bindable bind

One or more names of config properties that this component should publish to its ViewModel. Generally speaking, only properties defined in a class config block (including ancestor config blocks and mixins) are eligible for publishing to the viewModel. Some components override this and publish their most useful configs by default.

Note: We'll discuss publishing properties not found in the config block below.

Values determined to be invalid by component (often form fields and model validations) will not be published to the ViewModel.

This config uses the cfg-reference to determine the name of the data object to place in the ViewModel. If reference is not set then this config is ignored.

By using this config and cfg-reference you can bind configs between components. For example:

 ...
     items: [{
         xtype: 'textfield',
         reference: 'somefield',  // component's name in the ViewModel
         publishes: 'value' // value is not published by default
     },{
         ...
     },{
         xtype: 'displayfield',
         bind: 'You have entered "{somefield.value}"'
     }]
 ...

Classes must provide this config as an Object:

 Ext.define('App.foo.Bar', {
     publishes: {
         foo: true,
         bar: true
     }
 });

This is required for the config system to properly merge values from derived classes.

For instances this value can be specified as a value as show above or an array or object as follows:

 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: [
         'value',
         'rawValue',
         'dirty'
     ]
 }

 // This achieves the same result as the above array form.
 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: {
         value: true,
         rawValue: true,
         dirty: true
     }
 }

In some cases, users may want to publish a property to the viewModel that is not found in a class config block. In these situations, you may utilize publishState if the property has a setter method. Let's use setFieldLabel as an example:

  setFieldLabel: function(fieldLabel) {
      this.callParent(arguments);
      this.publishState('fieldLabel', fieldLabel);
  }

With the above chunk of code, fieldLabel may now be published to the viewModel.

Defaults to:

null

Available since: 5.0.0

getPublishes : String / String[] / Object

Returns the value of publishes

Returns

String / String[] / Object

setPublishes (publishes)

Sets the value of publishes

Parameters

publishes :  String / String[] / Object

reference : String
bindable bind

Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its Ext.app.ViewController. See the documentation in Ext.container.Container for more information about references.

Note: Valid identifiers start with a letter or underscore and are followed by zero or more additional letters, underscores or digits. References are case sensitive.

Defaults to:

null

getReference : String

Returns the value of reference

Returns

String

setReference (reference)

Sets the value of reference

Parameters

reference :  String

renderer : Function
bindable bind

A function that can be provided to set custom styling properties to each rendered element. It receives (sprite, config, rendererData, index) as parameters.

Defaults to:

null

Parameters

sprite :  Object

The sprite affected by the renderer. The visual attributes are in `sprite.attr`. The data field is available in `sprite.getField()`.

config :  Object

The sprite configuration. It varies with the series and the type of sprite: for instance, a Line chart sprite might have just the `x` and `y` properties while a Bar chart sprite also has `width` and `height`. A type might be present too. For instance to draw each marker and each segment of a Line chart, the renderer is called with the `config.type` set to either marker or `line`.

rendererData :  Object

A record with different properties depending on the type of chart. The only guaranteed property is `rendererData.store`, the store used by the series. In some cases, a store may not exist: for instance a Gauge chart may read its value directly from its configuration; in this case rendererData.store is null and the value is available in rendererData.value.

index :  Number

The index of the sprite. It is usually the index of the store record associated with the sprite, in which case the record can be obtained with `store.getData().items[index]`. If the chart is not associated with a store, the index represents the index of the sprite within the series. For instance a Gauge chart may have as many sprites as there are sectors in the background of the gauge, plus one for the needle.

Returns

:Object
The attributes that have been changed or added. Note: it is usually possible to add or modify the attributes directly into the `config` parameter and not return anything, but returning an object with only those attributes that have been changed may allow for optimizations in the rendering of some series. Example to draw every other marker in red: renderer: function (sprite, config, rendererData, index) { if (config.type === 'marker') { return { strokeStyle: (index % 2 === 0 ? 'red' : 'black') }; } }

getRenderer : Function

Returns the value of renderer

Returns

Function

setRenderer (renderer)

Sets the value of renderer

Parameters

renderer :  Function

sectors : Array
bindable bind

Allows to paint sectors of different colors in the background of the gauge, with optional labels.

It can be an array of numbers (each between minimum and maximum) that define the highest value of each sector. For N sectors, only (N-1) values are needed because it is assumed that the first sector starts at minimum and the last sector ends at maximum. Example: a water temperature gauge that is blue below 20C, red above 80C, gray in-between, and with an orange needle...

 minimum: 0,
 maximum: 100,
 sectors: [20, 80],
 colors: ['orange', 'blue', 'lightgray', 'red']

It can be also an array of objects, each with the following properties:

Defaults to:

null

Properties

start : Number

The starting value of the sector. If omitted, it uses the previous sector's `end` value or the chart's minimum.

end : Number

The ending value of the sector. If omitted, it uses the maximum defined for the chart.

label : String

The label for this sector. Labels are styled using the series' label config.

color : String

The color of the sector. If omitted, it uses one of the colors defined for the series or for the chart.

style : Object

An additional style object for the sector (for instance to set the opacity or to draw a line of a different color around the sector). minimum: 0, maximum: 100, sectors: [{ end: 20, label: 'Cold', color: 'aqua' }, { end: 80, label: 'Temp.', color: 'lightgray', style: { strokeStyle:'black', strokeOpacity:1, lineWidth:1 } }, { label: 'Hot', color: 'tomato' }]

getSectors : Array

Returns the value of sectors

Returns

Array

setSectors (sectors)

Sets the value of sectors

Parameters

sectors :  Array

session : Boolean / Object / Ext.data.Session
bindable bind

If provided this creates a new Session instance for this component. If this is a Container, this will then be inherited by all child components.

To create a new session you can specify true:

 Ext.create({
     xtype: 'viewport',
     session: true,

     items: [{
         ...
     }]
 });

Alternatively, a config object can be provided:

 Ext.create({
     xtype: 'viewport',
     session: {
         ...
     },

     items: [{
         ...
     }]
 });

Defaults to:

null

getSession : Boolean / Object / Ext.data.Session

Returns the value of session

Returns

Boolean / Object / Ext.data.Session

setSession (session)

Sets the value of session

Parameters

session :  Boolean / Object / Ext.data.Session

showInLegend : Boolean
bindable bind

Whether to add the gauge chart elements as legend items.

Defaults to:

false

getShowInLegend : Boolean

Returns the value of showInLegend

Returns

Boolean

setShowInLegend (showInLegend)

Sets the value of showInLegend

Parameters

showInLegend :  Boolean

showMarkers : Boolean
bindable bind

Whether markers should be displayed at the data points along the line. If true, then the marker config item will determine the markers' styling.

Defaults to:

true

getShowMarkers : Boolean

Returns the value of showMarkers

Returns

Boolean

setShowMarkers (showMarkers)

Sets the value of showMarkers

Parameters

showMarkers :  Boolean

store : Object
bindable bind

The store to use for this series. If not specified, the series will use the chart's store.

Defaults to:

null

getStore : Object

Returns the value of store

Returns

Object

setStore (store)

Sets the value of store

Parameters

store :  Object

style : Object
bindable bind

Custom style configuration for the sprite used in the series. It overrides the style that is provided by the current theme.

Defaults to:

{}

getStyle : Object

Returns the value of style

Returns

Object

setStyle (style)

Sets the value of style

Parameters

style :  Object

subStyle : Object
bindable bind

This is the cyclic used if the series has multiple sprites.

Defaults to:

{}

getSubStyle : Object

Returns the value of subStyle

Returns

Object

setSubStyle (subStyle)

Sets the value of subStyle

Parameters

subStyle :  Object

surface : Ext.draw.Surface
bindable bind protected pro

The chart surface used to render series sprites.

Defaults to:

null

getSurface : Ext.draw.Surface

Returns the value of surface

Returns

Ext.draw.Surface

setSurface (surface)

Sets the value of surface

Parameters

surface :  Ext.draw.Surface

themeStyle : Object
bindable bind private pri

Style configuration that is provided by the current theme. It is composed of five objects:

Defaults to:

{}

Properties

style : Object

Properties common to all the series, for instance the 'lineWidth'.

subStyle : Object

Cyclic used if the series has multiple sprites.

label : Object

Sprite config for the labels, for instance the font and color.

marker : Object

Sprite config for the markers, for instance the size and stroke color.

markerSubStyle : Object

Cyclic used if series have multiple marker sprites.

getThemeStyle : Object

Returns the value of themeStyle

Returns

Object

setThemeStyle (themeStyle)

Sets the value of themeStyle

Parameters

themeStyle :  Object

title : String / String[]
bindable bind

The human-readable name of the series (displayed in the legend). If the series is stacked (has multiple components in it) this should be an array, where each string corresponds to a stacked component.

Defaults to:

null

getTitle : String / String[]

Returns the value of title

Returns

String / String[]

setTitle (title)

Sets the value of title

Parameters

title :  String / String[]

tooltip : Object
bindable bind

Add tooltips to the visualization's markers. The config options for the tooltip are the same configuration used with Ext.tip.ToolTip plus a renderer config option and a scope for the renderer. For example:

tooltip: {
  trackMouse: true,
  width: 140,
  height: 28,
  renderer: function (toolTip, record, ctx) {
      toolTip.setHtml(record.get('name') + ': ' + record.get('data1') + ' views');
  }
}

Note that tooltips are shown for series markers and won't work if the marker is not configured.

Defaults to:

null

Properties

scope : Object

The scope to use when the renderer function is called. Defaults to the Series instance.

renderer : Function

An 'interceptor' method which can be used to modify the tooltip attributes before it is shown. The renderer function is passed the following params:

toolTip :  Ext.tip.ToolTip

The tooltip instance

record :  Ext.data.Model

The record instance for the chart item (sprite) currently targeted by the tooltip.

ctx :  Object

A data object with values relating to the currently targeted chart sprite

category :  String

The type of sprite passed to the renderer function (will be "items", "markers", or "labels" depending on the target sprite of the tooltip)

field :  String

The yField for the series

index :  Number

The target sprite's index within the series' items

record :  Ext.data.Model

The record instance for the chart item (sprite) currently targeted by the tooltip.

series :  Ext.chart.series.Series

The series instance containing the tooltip's target sprite

sprite :  Ext.draw.sprite.Sprite

The sprite (item) target of the tooltip

getTooltip : Object

Returns the value of tooltip

Returns

Object

setTooltip (tooltip)

Sets the value of tooltip

Parameters

tooltip :  Object

totalAngle : Number
bindable bind

The size of the sector that the series will occupy.

Defaults to:

Math.PI / 2

getTotalAngle : Number

Returns the value of totalAngle

Returns

Number

setTotalAngle (totalAngle)

Sets the value of totalAngle

Parameters

totalAngle :  Number

triggerAfterDraw
bindable bind private pri

Trigger drawlistener flag

Defaults to:

false

getTriggerAfterDraw

Returns the value of triggerAfterDraw

Returns

setTriggerAfterDraw (triggerAfterDraw)

Sets the value of triggerAfterDraw

Parameters

triggerAfterDraw :  Object

twoWayBindable : String / String[] / Object
bindable bind

This object holds a map of config properties that will update their binding as they are modified. For example, value is a key added by form fields. The form of this config is the same as publishes.

This config is defined so that updaters are not created and added for all bound properties since most cannot be modified by the end-user and hence are not appropriate for two-way binding.

Defaults to:

null

getTwoWayBindable : String / String[] / Object

Returns the value of twoWayBindable

Returns

String / String[] / Object

setTwoWayBindable (twoWayBindable)

Sets the value of twoWayBindable

Parameters

twoWayBindable :  String / String[] / Object

useDarkerStrokeColor : Boolean / Number
bindable bind

Colors for the series can be set directly through the 'colors' config, or indirectly with the current theme or the 'colors' config that is set onto the chart. These colors are used as "fill color". Set this config to true, if you want a darker color for the strokes. Set it to false if you want to use the same color as the fill color. Alternatively, you can set it to a number between 0 and 1 to control how much darker the strokes should be. Note: this should be initial config and cannot be changed later on.

Defaults to:

true

getUseDarkerStrokeColor : Boolean / Number

Returns the value of useDarkerStrokeColor

Returns

Boolean / Number

setUseDarkerStrokeColor (useDarkerStrokeColor)

Sets the value of useDarkerStrokeColor

Parameters

useDarkerStrokeColor :  Boolean / Number

value : Number
bindable bind

Directly sets the displayed value of the gauge. It is ignored if angleField is provided.

Defaults to:

null

getValue : Number

Returns the value of value

Returns

Number

setValue (value)

Sets the value of value

Parameters

value :  Number

viewModel : String / Object / Ext.app.ViewModel
bindable bind

The ViewModel is a data provider for this component and its children. The data contained in the ViewModel is typically used by adding bind configs to the components that want present or edit this data.

When set, the ViewModel is created and links to any inherited viewModel instance from an ancestor container as the "parent". The ViewModel hierarchy, once established, only supports creation or destruction of children. The parent of a ViewModel cannot be changed on the fly.

If this is a root-level ViewModel, the data model connection is made to this component's associated Ext.data.Session. This is determined by calling getInheritedSession.

Defaults to:

null

getViewModel : String / Object / Ext.app.ViewModel

Returns the value of viewModel

Returns

String / Object / Ext.app.ViewModel

setViewModel (viewModel)

Sets the value of viewModel

Parameters

viewModel :  String / Object / Ext.app.ViewModel

wholeDisk : Boolean
bindable bind

Indicates whether to show the whole disk or only the marked part.

Defaults to:

false

getWholeDisk : Boolean

Returns the value of wholeDisk

Returns

Boolean

setWholeDisk (wholeDisk)

Sets the value of wholeDisk

Parameters

wholeDisk :  Boolean

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

$eventOptions
private pri

Matches options property names within a listeners specification object - property names which are never used as event names.

Defaults to:

{
    scope: 1,
    delay: 1,
    buffer: 1,
    onFrame: 1,
    single: 1,
    args: 1,
    destroyable: 1,
    priority: 1,
    order: 1
}

$vetoClearingPrototypeOnDestroy
private pri

We don't want the base destructor to clear the prototype because our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.

Defaults to:

true

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

defaultBindProperty : String
protected pro

This property is used to determine the property of a bind config that is just the value. For example, if defaultBindProperty="value", then this shorthand bind config:

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

The defaultBindProperty is set to "value" for form fields and to "store" for grids and trees.

Defaults to:

null

destroyed : Boolean
protected pro

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

Defaults to:

false

eventsSuspended
private pri

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

Defaults to:

0

hasListeners : Object
readonly ro

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the Ext.app.EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }

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

isObservable : Boolean

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

Defaults to:

true

isStoreDependantColorCount
private pri

Series, where the number of sprites (an so unique colors they require) depends on the number of records in the store should set this to 'true'.

Defaults to:

false

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

seriesType : String

Default series sprite type.

Defaults to:

'sprite'

type : String
protected pro

The type of series. Set in subclasses.

Defaults to:

null

validRefRe : RegExp
private pri

Regular expression used for validating reference values.

Defaults to:

/^[a-z_][a-z0-9_]*$/i

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

_addDeclaredListeners ( listeners ) : Boolean
private pri

Adds declarative listeners as nested arrays of listener objects.

Parameters

listeners :  Array

Returns

:Boolean
`true` if any listeners were added

addBindableUpdater ( property )
private pri

Ensures that the given property (if it is a Config System config) has a proper "updater" method on this instance to sync changes to the config.

Available since: 5.0.0

Parameters

property :  String

The name of the config property.

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

addListener ( eventName, [fn], [scope], [options], [order] ) : Object
chainable ch

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

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

fn :  Function/String (optional)

The method the event invokes or the *name* of the method within the specified `scope`. Will be called with arguments given to Ext.util.Observable#fireEvent plus the `options` parameter described below.

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration. **Note:** The options object will also be passed as the last argument to every event handler. This object may contain any of the following properties:

scope :  Object

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

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
                              title: 'The title',
                              listeners: {
                                  click: this.handlePanelClick,
                                  element: 'body'
                              }
                          });
                        

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)
                        

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional set of arguments to pass to the handler function before the actual fired event arguments. For example, if args is set to ['foo', 42], the event handler function will be called with an arguments list like this:

 handler('foo', 42, <actual event arguments>...);
                        

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the `order` event option. Provided for backward compatibility. Please use the `priority` event option instead. **Combining Options** Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. myPanel.on('hide', this.handleClick, this, { single: true, delay: 100 }); **Attaching multiple handlers in 1 call** The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs. grid.on({ itemclick: 'onItemClick', itemcontextmenu: grid.onItemContextmenu, destroy: { fn: function () { // function called within the 'altCmp' scope instead of grid }, scope: altCmp // unique scope for the destroy handler }, scope: grid // default scope - provided for example clarity }); **Delegate** This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: var panel = Ext.create({ xtype: 'panel', renderTo: document.body, title: 'Delegate Handler Example', frame: true, height: 220, width: 220, html: '

BODY TITLE

Body content' }); // The click handler will only be called when the click occurs on the // delegate: h1.myTitle ("h1" tag with class "myTitle") panel.on({ click: function (e) { console.log(e.getTarget().innerHTML); }, element: 'body', delegate: 'h1.myTitle' });

Defaults to: 'current'

Returns

:Object
**Only when the `destroyable` option is specified. ** A `Destroyable` object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy();

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

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function/String (optional)

If the `ename` parameter was an event name, this is the handler function or the name of a method on the specified `scope`.

scope :  Object (optional)

If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

options :  Object (optional)

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

Returns

:Object
**Only when the `destroyable` option is specified. ** A `Destroyable` object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy();

applyBind ( binds, currentBindings ) : Object
private pri

Available since: 5.0.0

Parameters

binds :  String/Object

currentBindings :  Object

Returns

:Object

applySession ( session ) : Ext.data.Session
private pri

Transforms a Session config to a proper instance.

Available since: 5.0.0

Parameters

session :  Object

Returns

:Ext.data.Session

applyViewModel ( viewModel ) : Ext.app.ViewModel
private pri

Transforms a ViewModel config to a proper instance.

Available since: 5.0.0

Parameters

viewModel :  String/Object/Ext.app.ViewModel

Returns

:Ext.app.ViewModel

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

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

coordinateData ( items, field, axis ) : Array
private pri

This method will return an array containing data coordinated by a specific axis.

Parameters

items :  Array

Store records.

field :  String

The field to fetch from each record.

axis :  Ext.chart.axis.Axis

The axis used to lay out the data.

Returns

:Array

createRelayer ( newName, [beginEnd] ) : Function
private pri

Creates an event handling function which re-fires the event from this object as the passed event name.

Parameters

newName :  String

The name under which to re-fire the passed parameters.

beginEnd :  Array (optional)

The caller can specify on which indices to slice.

Returns

:Function

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.

doFireEvent ( eventName, args, bubbles )
private pri

Continue to fire event.

Parameters

eventName :  String

args :  Array

bubbles :  Boolean

enableBubble ( eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Parameters

eventNames :  String/String[]

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

findMatchingAxis ( directionAxes, directionFields )
private pri

Given the list of axes in a certain direction and a list of series fields in that direction returns the first matching axis for the series in that direction, or undefined if a match wasn't found.

Parameters

directionAxes :  Object

directionFields :  Object

fireAction ( eventName, args, fn, [scope], [options], [order] )
deprecated dep

Fires the specified event with the passed parameters and executes a function (action). By default, the action function will be executed after any "before" event handlers (as specified using the order option of addListener), but before any other handlers are fired. This gives the "before" handlers an opportunity to cancel the event by returning false, and prevent the action function from being called.

The action can also be configured to run after normal handlers, but before any "after" handlers (as specified using the order event option) by passing 'after' as the order parameter. This configuration gives any event handlers except for "after" handlers the opportunity to cancel the event and prevent the action function from being called.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function

The action function.

scope :  Object (optional)

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

options :  Object (optional)

Event options for the action function. Accepts any of the options of addListener

order :  String (optional)

The order to call the action function relative too the event handlers (`'before'` or `'after'`). Note that this option is simply used to sort the action function relative to the event handlers by "priority". An order of `'before'` is equivalent to a priority of `99.5`, while an order of `'after'` is equivalent to a priority of `-99.5`. See the `priority` option of addListener for more details.

Defaults to: 'before'

Deprecated since version 5.5

fireEvent ( eventName, args ) : Boolean

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.

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.

fireEventArgs ( eventName, args ) : Boolean

Fires the specified event with the passed parameter list.

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

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

fireEventedAction ( eventName, args, fn, [scope], [fnArgs] ) : Boolean

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function/String

The action function.

scope :  Object (optional)

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

fnArgs :  Array/Boolean (optional)

Optional arguments for the action `fn`. If not given, the normal `args` will be used to call `fn`. If `false` is passed, the `args` are used but if the first argument is this instance it will be removed from the args passed to the action function.

Returns

:Boolean

getBubbleParent Ext.util.Observable
private pri

Gets the bubbling parent for an Observable

Returns

:Ext.util.Observable
The bubble parent. null is returned if no bubble target exists

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.

getId String

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

:String
id

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.

getItemByIndex ( index, [category] ) : Object

Returns a series item by index and (optional) category.

Parameters

index :  Number

The index of the item (matches store record index).

category :  String (optional)

The category of item, e.g.: 'items', 'markers', 'sprites'.

Returns

:Object
item

getItemForPoint ( x, y, [target] ) : Object

For a given x/y point relative to the main rect, find a corresponding item from this series, if any.

Parameters

x :  Number

y :  Number

target :  Object (optional)

optional target to receive the result

Returns

:Object
An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following:

record :  Ext.data.Model

the record of the item.

point :  Array

the x/y coordinates relative to the chart box of a single point for this data item, which can be used as e.g. a tooltip anchor point.

sprite :  Ext.draw.sprite.Sprite

the item's rendering Sprite.

subSprite :  Number

the index if sprite is an instancing sprite.

getSprites

Returns sprites the are used to draw this series.

hasConfig ( name )
private pri

Parameters

name :  String

hasListener ( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

Parameters

eventName :  String

The name of the event to check for

Returns

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

initBindable
private pri

This method triggers the lazy configs and must be called when it is time to fully boot up. The configs that must be initialized are: bind, publishes, session, twoWayBindable and viewModel.

Available since: 5.0.0

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

initInheritedState ( inheritedState )
protected pro

Called by getInherited to initialize the inheritedState the first time it is requested.

Parameters

inheritedState :  Object

isSuspended ( [event] ) : Boolean

Checks if all events, or a specific event, is suspended.

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean
`true` if events are suspended

isSyncing ( name ) : Boolean
private pri

Checks if a particular binding is synchronizing the value.

Parameters

name :  String

The name of the property being bound to.

Returns

:Boolean
`true` if the binding is syncing.

lookupController ( [skipThis] ) : Ext.app.ViewController

Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.

Available since: 5.0.1

Parameters

skipThis :  Boolean (optional)

`true` to not consider the controller directly attached to this view (if it exists).

Defaults to: false

Returns

:Ext.app.ViewController
The controller. `null` if no controller is found.

lookupSession ( [skipThis] ) : Ext.data.Session

Returns the Ext.data.Session for this instance. This property may come from this instance's session or be inherited from this object's parent.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

Pass `true` to ignore a session configured on this instance and only consider an inherited session.

Defaults to: false

Returns

:Ext.data.Session

lookupViewModel ( [skipThis] ) : Ext.app.ViewModel

Returns the Ext.app.ViewModel for this instance. This property may come from this this instance's viewModel or be inherited from this object's parent.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

Pass `true` to ignore a viewModel configured on this instance and only consider an inherited view model.

Defaults to: false

Returns

:Ext.app.ViewModel

makeBindableUpdater ( cfg ) : Function
private pri

Returns an update method for the given Config that will call publishState to ensure two-way bindings (via bind) as well as any publishes are updated. This method is cached on the cfg instance for re-use.

Available since: 5.0.0

Parameters

cfg :  Ext.Config

Returns

:Function
The updater function.

mon ( item, ename, [fn], [scope], [options] ) : Object

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function/String (optional)

If the `ename` parameter was an event name, this is the handler function or the name of a method on the specified `scope`.

scope :  Object (optional)

If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

options :  Object (optional)

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

Returns

:Object
**Only when the `destroyable` option is specified. ** A `Destroyable` object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = myButton.mon({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy();

mun ( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the `ename` parameter was an event name, this is the handler function.

scope :  Object (optional)

If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

on ( eventName, [fn], [scope], [options], [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

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

fn :  Function/String (optional)

The method the event invokes or the *name* of the method within the specified `scope`. Will be called with arguments given to Ext.util.Observable#fireEvent plus the `options` parameter described below.

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration. **Note:** The options object will also be passed as the last argument to every event handler. This object may contain any of the following properties:

scope :  Object

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

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
                              title: 'The title',
                              listeners: {
                                  click: this.handlePanelClick,
                                  element: 'body'
                              }
                          });
                        

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)
                        

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional set of arguments to pass to the handler function before the actual fired event arguments. For example, if args is set to ['foo', 42], the event handler function will be called with an arguments list like this:

 handler('foo', 42, <actual event arguments>...);
                        

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the `order` event option. Provided for backward compatibility. Please use the `priority` event option instead. **Combining Options** Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. myPanel.on('hide', this.handleClick, this, { single: true, delay: 100 }); **Attaching multiple handlers in 1 call** The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs. grid.on({ itemclick: 'onItemClick', itemcontextmenu: grid.onItemContextmenu, destroy: { fn: function () { // function called within the 'altCmp' scope instead of grid }, scope: altCmp // unique scope for the destroy handler }, scope: grid // default scope - provided for example clarity }); **Delegate** This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: var panel = Ext.create({ xtype: 'panel', renderTo: document.body, title: 'Delegate Handler Example', frame: true, height: 220, width: 220, html: '

BODY TITLE

Body content' }); // The click handler will only be called when the click occurs on the // delegate: h1.myTitle ("h1" tag with class "myTitle") panel.on({ click: function (e) { console.log(e.getTarget().innerHTML); }, element: 'body', delegate: 'h1.myTitle' });

Defaults to: 'current'

Returns

:Object
**Only when the `destroyable` option is specified. ** A `Destroyable` object. An object which implements the destroy method which removes all listeners added in this call. For example: this.btnListeners = = myButton.on({ destroyable: true mouseover: function() { console.log('mouseover'); }, mouseout: function() { console.log('mouseout'); }, click: function() { console.log('click'); } }); And when those listeners need to be removed: Ext.destroy(this.btnListeners); or this.btnListeners.destroy();

onAfter ( eventName, fn, [scope], [options] )

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for `fn`.

options :  Object (optional)

An object containing handler configuration.

onBefore ( eventName, fn, [scope], [options] )

Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for `fn`.

options :  Object (optional)

An object containing handler configuration.

provideLegendInfo ( target )

Provide legend information to target array.

Parameters

target :  Array

The information consists:

name :  String

mark :  String

disabled :  Boolean

series :  String

index :  Number

publishState ( [property], [value] )
protected pro

Publish this components state to the ViewModel. If no arguments are given (or if this is the first call), the entire state is published. This state is determined by the publishes property.

This method is called only by component authors.

Available since: 5.0.0

Parameters

property :  String (optional)

The name of the property to update.

value :  Object (optional)

The value of `property`. Only needed if `property` is given.

relayEvents ( origin, events, [prefix] ) : Object

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

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]/Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'}); Would now redispatch the add event of this as a push event and the remove event as a pop event.

prefix :  String (optional)

A common prefix to prepend to the event names. For example: this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

:Object
A `Destroyable` object. An object which implements the destroy method which, when destroyed, removes all relayers. For example: this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store'); Can be undone by calling Ext.destroy(this.storeRelayers); or this.store.relayers.destroy();

removeListener ( eventName, fn, [scope] ) :
chainable ch

Removes an event handler.

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 Ext.util.Observable#addListener or the listener will not be removed. **Convenience Syntax** You can use the addListener `destroyable: true` config option in place of calling un(). For example: var listeners = cmp.on({ scope: cmp, afterrender: cmp.onAfterrender, beforehide: cmp.onBeforeHide, destroyable: true }); // Remove listeners listeners.destroy(); // or cmp.un( scope: cmp, afterrender: cmp.onAfterrender, beforehide: cmp.onBeforeHide ); **Exception - DOM event handlers using the element config option** You must go directly through the element to detach an event handler attached using the addListener _element_ option. panel.on({ element: 'body', click: 'onBodyCLick' }); panel.body.un({ click: 'onBodyCLick' });

Returns

:

removeManagedListener ( item, ename, [fn], [scope] )

Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the `ename` parameter was an event name, this is the handler function.

scope :  Object (optional)

If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

removeManagedListenerItem ( isClear, managedListener )
private pri

Remove a single managed listener item

Parameters

isClear :  Boolean

True if this is being called during a clear

managedListener :  Object

The managed listener item See removeManagedListener for other args

resolveListenerScope ( [defaultScope] ) : Object
protected pro

Gets the default scope for firing late bound events (string names with no scope attached) at runtime.

Parameters

defaultScope :  Object (optional)

The default scope to return if none is found.

Defaults to: this

Returns

:Object
The default event scope

resumeEvent ( eventName )

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to resume.

resumeEvents ( [discardQueue] )

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.

Parameters

discardQueue :  Boolean (optional)

`true` to prevent any previously queued events from firing while we were suspended. See suspendEvents.

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

setHiddenByIndex ( index, value )

Parameters

index :  Number

value :  Boolean

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

suspendEvent ( eventName )

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to suspend.

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

`true` to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

themeColorCount Number
private pri

Returns the number of colors this series needs. A Pie chart needs one color per slice while a Stacked Bar chart needs one per segment. An OHLC chart needs 2 colors (one for drops, one for rises), and most other charts need just 1 color.

Returns

:Number

themeMarkerCount Number
private pri

Returns the number of markers this series needs. Currently, only the Line, Scatter and Radar series use markers - and they need just one each.

Returns

:Number

un ( eventName, fn, [scope] ) :

Shorthand for removeListener. Removes an event handler.

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 Ext.util.Observable#addListener or the listener will not be removed. **Convenience Syntax** You can use the addListener `destroyable: true` config option in place of calling un(). For example: var listeners = cmp.on({ scope: cmp, afterrender: cmp.onAfterrender, beforehide: cmp.onBeforeHide, destroyable: true }); // Remove listeners listeners.destroy(); // or cmp.un( scope: cmp, afterrender: cmp.onAfterrender, beforehide: cmp.onBeforeHide ); **Exception - DOM event handlers using the element config option** You must go directly through the element to detach an event handler attached using the addListener _element_ option. panel.on({ element: 'body', click: 'onBodyCLick' }); panel.body.un({ click: 'onBodyCLick' });

Returns

:

unAfter ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for `fn`.

options :  Object (optional)

Extra options object.

unBefore ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for `fn`.

options :  Object (optional)

Extra options object.

updateChartColors ( colors )
private pri

When the chart's "colors" config changes, these colors are passed onto the series where they are used with the same priority as theme colors, i.e. they do not override the series' "colors" config, nor the series' "style" config, but they do override the colors from the theme's "seriesThemes" config.

Parameters

colors :  Object

updateLegendStore ( hidden, index )
private pri

Updates chart's legend store when the value of the series' hidden config changes or when the setHiddenByIndex method is called.

Parameters

hidden :  Object

Whether series (or its component) should be hidden or not.

index :  Object

Used for stacked series. If present, only the component with the specified index will change visibility.

updateSession ( session )
private pri

Updates the session config.

Parameters

session :  Ext.data.Session

updateViewModel ( viewModel, oldViewModel )
private pri

Updates the viewModel config.

Parameters

viewModel :  Ext.app.ViewModel

oldViewModel :  Ext.app.ViewModel

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

events

chartattached ( chart, series, eOpts )

Fires when the Ext.chart.AbstractChart has been attached to this series.

Parameters

chart :  Ext.chart.AbstractChart

series :  Ext.chart.series.Series

eOpts : Object

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

chartdetached ( chart, series, eOpts )

Fires when the Ext.chart.AbstractChart has been detached from this series.

Parameters

chart :  Ext.chart.AbstractChart

series :  Ext.chart.series.Series

eOpts : Object

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

itemclick ( series, item, event, eOpts )

Fires when a click event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

series :  Ext.chart.series.Series

item :  Object

event :  Event

eOpts : Object

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

itemdblclick ( series, item, event, eOpts )

Fires when a double click event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

series :  Ext.chart.series.Series

item :  Object

event :  Event

eOpts : Object

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

itemmousedown ( series, item, event, eOpts )

Fires when a mousedown event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

series :  Ext.chart.series.Series

item :  Object

event :  Event

eOpts : Object

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

itemmousemove ( series, item, event, eOpts )

Fires when the mouse is moved on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

series :  Ext.chart.series.Series

item :  Object

event :  Event

eOpts : Object

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

itemmouseout ( series, item, event, eOpts )

Fires when the mouse exits a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

series :  Ext.chart.series.Series

item :  Object

event :  Event

eOpts : Object

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

itemmouseover ( series, item, event, eOpts )

Fires when the mouse enters a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

series :  Ext.chart.series.Series

item :  Object

event :  Event

eOpts : Object

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

itemmouseup ( series, item, event, eOpts )

Fires when a mouseup event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

series :  Ext.chart.series.Series

item :  Object

event :  Event

eOpts : Object

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

itemtap ( series, item, event, eOpts )

Fires when a tap event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

Parameters

series :  Ext.chart.series.Series

item :  Object

event :  Event

eOpts : Object

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

storechange ( series, newStore, oldStore, eOpts )

Fires when the store of the series changes.

Parameters

series :  Ext.chart.series.Series

newStore :  Ext.data.Store

oldStore :  Ext.data.Store

eOpts : Object

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

Ext JS 6.2.1 - Classic Toolkit