ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

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.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

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

Or in the case of an ExtReact component class this indicates a member of type prop

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

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

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.

ExtReact 6.6.0


top

Summary

The Ext.chart package provides the capability to visualize data. Each chart binds directly to a Ext.data.Store enabling automatic updates of the chart. A chart configuration object has some overall styling options as well as an array of axes and series. A chart instance example could look like this:

Ext.create('Ext.chart.CartesianChart', {
    width: 800,
    height: 600,
    animation: {
        easing: 'backOut',
        duration: 500
    },
    store: store1,
    legend: {
        position: 'right'
    },
    axes: [
        // ...some axes options...
    ],
    series: [
        // ...some series options...
    ]
});

In this example we set the width and height of a chart; We decide whether our series are animated or not and we select a store to be bound to the chart; We also set the legend to the right part of the chart.

You can register certain interactions such as Ext.chart.interactions.PanZoom on the chart by specify an array of names or more specific config objects. All the events will be wired automatically.

You can also listen to series itemXXX events on both chart and series level.

For example:

Ext.create('Ext.chart.CartesianChart', {
    plugins: {
        ptype: 'chartitemevents',
        moveEvents: true
    },
    store: {
        fields: ['pet', 'households', 'total'],
        data: [
            {pet: 'Cats', households: 38, total: 93},
            {pet: 'Dogs', households: 45, total: 79},
            {pet: 'Fish', households: 13, total: 171}
        ]
    },
    axes: [{
        type: 'numeric',
        position: 'left'
    }, {
        type: 'category',
        position: 'bottom'
    }],
    series: [{
        type: 'bar',
        xField: 'pet',
        yField: 'households',
        listeners: {
            itemmousemove: function (series, item, event) {
                console.log('itemmousemove', item.category, item.field);
            }
        }
    }, {
        type: 'line',
        xField: 'pet',
        yField: 'total',
        marker: true
    }],
    listeners: { // Listen to itemclick events on all series.
        itemclick: function (chart, item, event) {
            console.log('itemclick', item.category, item.field);
        }
    }
});

For more information about the axes and series configurations please check the documentation of each series (Line, Bar, Pie, etc).

No members found using the current filters

configs

Optional Configs

activeItem : Object / String / Number
bindable bind

The item from the items collection that will be active first. This is usually only meaningful in a Ext.layout.Card, where only one item can be active at a time. If passes a string, it will be assumed to be a Ext.ComponentQuery selector.

Defaults to:

0

getActiveItem : Object / String / Number

Returns the value of activeItem

Returns

Object / String / Number

setActiveItem (activeItem)

Sets the value of activeItem

Parameters

activeItem :  Object / String / Number

animation : Boolean / Object
bindable bind

true for the default animation (easing: 'ease' and duration: 500) or a standard animation config object to be used for default chart animations.

getAnimation : Boolean / Object

Returns the value of animation

Returns

Boolean / Object

setAnimation (animation)

Sets the value of animation

Parameters

animation :  Boolean / Object

ariaAttributes : Object
bindable bind

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state, such as aria-live, aria-flowto, etc.

Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.

getAriaAttributes : Object

Returns the value of ariaAttributes

Returns

Object

setAriaAttributes (ariaAttributes)

Sets the value of ariaAttributes

Parameters

ariaAttributes :  Object

ariaDescribedBy : String

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

ariaLabel : String

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabel and ariaLabelledBy config options are mutually exclusive.

ariaLabelledBy : String

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by #id, the label element can be any existing element, not necessarily a child of the main Component element.

ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.

autoDestroy : Boolean
bindable bind

If true, children will be destroyed as soon as they are removed from this container.

Defaults to:

true

getAutoDestroy : Boolean

Returns the value of autoDestroy

Returns

Boolean

setAutoDestroy (autoDestroy)

Sets the value of autoDestroy

Parameters

autoDestroy :  Boolean

autoSize : Boolean
bindable bind

May be set to false for improved layout performance if auto-sizing is not required.

Some versions of Safari, both desktop and mobile, have very slow performance if the application has deeply nested containers due to the following WebKit bug: https://bugs.webkit.org/show_bug.cgi?id=150445

Applications that experience performance issues in the affected versions of Safari may need to turn off autoSizing globally for all Container instances by placing the following override in the application's "overrides" directory:

Ext.define('MyApp.overrides.Container', {
    override: 'Ext.Container',
    config: {
        autoSize: false
    }
});

Once auto-sizing support has turned off by default, it can be selectively turned back on only on those container instances that explicitly need auto-sizing behavior by setting autoSize to true.

This option can also be used to allow children to be sized in percentage units as a workaround for the following browser bug: https://bugs.webkit.org/show_bug.cgi?id=137730

To illustrate, the following example should render a 200px by 200px green box (the container) with a yellow box inside of it (the child item). The child item's height and width are both set to '50%' so the child should render exactly 100px by 100px in size.

<Container
    height={200}
    width={200}
    style="background: green"
>
    <Component
        style="background: yellow"
        height="50%"
        width="50%"
    />
</Container>

All browsers except for Safari render the previous example correctly, but Safari does not assign a height to the component. To make percentage-sized children work in Safari, simply set autoSize to false on the container.

Since the underlying implementation works by absolutely positioning the container's body element, this option can only be used when the container is not "shrink wrapping" the content in either direction. When autoSize is set to false, shrink wrapped dimension(s) will collapse to 0.

Defaults to:

true

getAutoSize : Boolean

Returns the value of autoSize

Returns

Boolean

setAutoSize (autoSize)

Sets the value of autoSize

Parameters

autoSize :  Boolean

axes : Ext.chart.axis.Axis / Array / Object
bindable bind

Array of Ext.chart.axis.Axis instances or config objects. For example:

axes: [{
    type: 'numeric',
    position: 'left',
    title: 'Number of Hits',
    minimum: 0
}, {
    type: 'category',
    position: 'bottom',
    title: 'Month of the Year'
}]

Defaults to:

[]

getAxes : Ext.chart.axis.Axis / Array / Object

Returns the value of axes

Returns

Ext.chart.axis.Axis / Array / Object

setAxes (axes)

Sets the value of axes

Parameters

axes :  Ext.chart.axis.Axis / Array / Object

axisLock : Boolean

If true, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints fail, only fallback to "r-l" is considered.

Defaults to:

null

background : Object
bindable bind

Set the chart background. This can be a gradient object, image, or color.

For example, if background were to be a color we could set the object as

background: '#ccc'

You can specify an image by using:

background: {
    type: 'image',
    src: 'http://path.to.image/'
}

Also you can specify a gradient by using the gradient object syntax:

background: {
    type: 'linear',
    degrees: 0,
    stops: [
        {
            offset: 0,
            color: 'white'
        },
        {
            offset: 1,
            color: 'blue'
        }
    ]
}

Defaults to:

null

getBackground : Object

Returns the value of background

Returns

Object

setBackground (background)

Sets the value of background

Parameters

background :  Object

border : Boolean
bindable bind

Enables or disables bordering on this component. The following values are accepted:

  • null or `true (default): Do nothing and allow the border to be specified by the theme.
  • false: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a border-color or border-style CSS property to the component; you provide the border-color and border-style via CSS rule or style configuration (if not already provide by the theme).

Defaults to:

null

getBorder : Boolean

Returns the value of border

Returns

Boolean

setBorder (border)

Sets the value of border

Parameters

border :  Boolean

bottom : Number / String
bindable bind

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

getBottom : Number / String

Returns the value of bottom

Returns

Number / String

setBottom (bottom)

Sets the value of bottom

Parameters

bottom :  Number / String

buttonAlign : String

The alignment of any buttons added to this panel. Valid values are 'right', 'left' and 'center' (defaults to 'right' for buttons/fbar, 'left' for other toolbar types).

NOTE: The preferred way to specify toolbars is to use the items config specifying the docked config on the item. Instead of buttonAlign you would add the layout: { pack: 'start' | 'center' | 'end' } option to the docked item config.

Defaults to:

null

Available since: 6.5.0

centered : Boolean
bindable bind

Configure this as true to have this Component centered within its Container. Setting this value to true will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

getCentered : Boolean

Returns the value of centered

Returns

Boolean

setCentered (centered)

Sets the value of centered

Parameters

centered :  Boolean

cls : String / String[]
bindable bind

The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a Container).

Defaults to:

null

getCls : String / String[]

Returns the value of cls

Returns

String / String[]

setCls (cls)

Sets the value of cls

Parameters

cls :  String / String[]

colors : Array
bindable bind

Array of colors/gradients to override the color of items and legends.

Defaults to:

null

getColors : Array

Returns the value of colors

Returns

Array

setColors (colors)

Sets the value of colors

Parameters

colors :  Array

contentEl : Ext.dom.Element / HTMLElement / String
bindable bind

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Defaults to:

null

getContentEl : Ext.dom.Element / HTMLElement / String

Returns the value of contentEl

Returns

Ext.dom.Element / HTMLElement / String

setContentEl (contentEl)

Sets the value of contentEl

Parameters

contentEl :  Ext.dom.Element / HTMLElement / String

data : Object
bindable bind

The initial set of data to apply to the tpl to update the content area of the Component.

Defaults to:

null

getData : Object

Returns the value of data

Returns

Object

setData (data)

Sets the value of data

Parameters

data :  Object

defaultFocus : String

Specifies a child Component to receive focus when this Container's method-focus method is called. Should be a valid Ext.ComponentQuery selector.

defaults : Object
bindable bind

A set of default configurations to apply to all child Components in this Container.

It's often useful to specify defaults when creating more than one children with similar configurations. For example here we can specify that each child has a height of 20px and avoid repeating the declaration for each one:

<Container
    fullscreen
    defaults={{
        height: 20
    }}
>
    <Panel>Panel 1</Panel>
    <Panel>Panel 2</Panel>
</Container>

Defaults to:

null

getDefaults : Object

Returns the value of defaults

Returns

Object

setDefaults (defaults)

Sets the value of defaults

Parameters

defaults :  Object

defaultType : String
bindable bind

The default Ext.Component of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component.

Defaults to:

null

getDefaultType : String

Returns the value of defaultType

Returns

String

setDefaultType (defaultType)

Sets the value of defaultType

Parameters

defaultType :  String

disabled : Boolean
bindable bind

Whether or not this component is disabled

Defaults to:

null

getDisabled : Boolean

Returns the value of disabled

Returns

Boolean

setDisabled (disabled)

Sets the value of disabled

Parameters

disabled :  Boolean

docked : String
bindable bind

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Defaults to:

null

getDocked : String

Returns the value of docked

Returns

String

setDocked (docked)

Sets the value of docked

Parameters

docked :  String

downloadServerUrl : String
bindable bind

The default URL used by the download method.

getDownloadServerUrl : String

Returns the value of downloadServerUrl

Returns

String

setDownloadServerUrl (downloadServerUrl)

Sets the value of downloadServerUrl

Parameters

downloadServerUrl :  String

draggable : Object
bindable bind

Configuration options to make this Component draggable

Defaults to:

null

getDraggable : Object

Returns the value of draggable

Returns

Object

setDraggable (draggable)

Sets the value of draggable

Parameters

draggable :  Object

engine : String

Defines the engine (type of surface) used to render draw container contents.

The render engine is selected automatically depending on the platform used. Priority is given to the Ext.draw.engine.Canvas engine due to its performance advantage.

You may also set the engine config to be Ext.draw.engine.Svg if so desired.

Defaults to:

"Ext.draw.engine.Canvas"

focusCls : String

CSS class that will be added to focused component's focusClsEl, and removed when component blurs.

Defaults to:

'x-focused'

fullscreen : Boolean

Force the component to take up 100% width and height available, by adding it to Ext.Viewport.

gradients : Object[]
bindable bind

Defines a set of gradients that can be used as color properties (fillStyle and strokeStyle, but not shadowColor) in sprites. The gradients array is an array of objects with the following properties:

  • id - string - The unique name of the gradient.
  • type - string, optional - The type of the gradient. Available types are: 'linear', 'radial'. Defaults to 'linear'.
  • angle - number, optional - The angle of the gradient in degrees.
  • stops - array - An array of objects with 'color' and 'offset' properties, where 'offset' is a real number from 0 to 1.

For example:

gradients: [{
    id: 'gradientId1',
    type: 'linear',
    angle: 45,
    stops: [{
        offset: 0,
        color: 'red'
    }, {
       offset: 1,
       color: 'yellow'
    }]
}, {
   id: 'gradientId2',
   type: 'radial',
   stops: [{
       offset: 0,
       color: '#555',
   }, {
       offset: 1,
       color: '#ddd',
   }]
}]

Then the sprites can use 'gradientId1' and 'gradientId2' by setting the color attributes to those ids, for example:

sprite.setAttributes({
    fillStyle: 'url(#gradientId1)',
    strokeStyle: 'url(#gradientId2)'
});

Defaults to:

[]

getGradients : Object[]

Returns the value of gradients

Returns

Object[]

setGradients (gradients)

Sets the value of gradients

Parameters

gradients :  Object[]

height : Number / String
bindable bind

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

getHeight : Number / String

Returns the value of height

Returns

Number / String

setHeight (height)

Sets the value of height

Parameters

height :  Number / String

hidden : Boolean
bindable bind

Whether or not this Component is hidden (its CSS display property is set to none).

Defaults to true for floated Components.

Defaults to:

null

getHidden : Boolean

Returns the value of hidden

Returns

Boolean

setHidden (hidden)

Sets the value of hidden

Parameters

hidden :  Boolean

hideAnimation : String / Mixed
bindable bind

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

getHideAnimation : String / Mixed

Returns the value of hideAnimation

Returns

String / Mixed

setHideAnimation (hideAnimation)

Sets the value of hideAnimation

Parameters

hideAnimation :  String / Mixed

hideOnMaskTap : Boolean
bindable bind

When using a modal Component, setting this to true will hide the modal mask and the Container when the mask is tapped on.

Defaults to:

null

getHideOnMaskTap : Boolean

Returns the value of hideOnMaskTap

Returns

Boolean

setHideOnMaskTap (hideOnMaskTap)

Sets the value of hideOnMaskTap

Parameters

hideOnMaskTap :  Boolean

highlightItem : Object
bindable bind

The current highlight item in the chart. The object must be the one that you get from item events.

Note that series can also own highlight items. This notion is separate from this one and should not be used at the same time.

Defaults to:

null

getHighlightItem : Object

Returns the value of highlightItem

Returns

Object

setHighlightItem (highlightItem)

Sets the value of highlightItem

Parameters

highlightItem :  Object

html : String / Ext.dom.Element / HTMLElement
bindable bind

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Defaults to:

null

getHtml : String / Ext.dom.Element / HTMLElement

Returns the value of html

Returns

String / Ext.dom.Element / HTMLElement

setHtml (html)

Sets the value of html

Parameters

html :  String / Ext.dom.Element / HTMLElement

insetPadding : Object / Number / String
bindable bind

The amount of inset padding in pixels for the chart. Inset padding is the padding from the boundary of the chart to any of its contents.

getInsetPadding : Object / Number / String

Returns the value of insetPadding

Returns

Object / Number / String

setInsetPadding (insetPadding)

Sets the value of insetPadding

Parameters

insetPadding :  Object / Number / String

interactions : Array
bindable bind

Interactions are optional modules that can be plugged in to a chart to allow the user to interact with the chart and its data in special ways. The interactions config takes an Array of Object configurations, each one corresponding to a particular interaction class identified by a type property:

new Ext.chart.AbstractChart({
    renderTo: Ext.getBody(),
    width: 800,
    height: 600,
    store: store1,
    axes: [
        // ...some axes options...
    ],
    series: [
        // ...some series options...
    ],
    interactions: [{
        type: 'interactiontype'
        // ...additional configs for the interaction...
    }]
});

When adding an interaction which uses only its default configuration (no extra properties other than type), you can alternately specify only the type as a String rather than the full Object:

interactions: ['reset', 'rotate']

The current supported interaction types include:

See the documentation for each of those interaction classes to see how they can be configured.

Additional custom interactions can be registered using 'interactions.' alias prefix.

Defaults to:

[]

getInteractions : Array

Returns the value of interactions

Returns

Array

setInteractions (interactions)

Sets the value of interactions

Parameters

interactions :  Array

keyMap : Object
bindable bind

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:

  • handler: The function or its name to call to handle the event.
  • scope: The this pointer context (can be "this" or "controller").
  • event: An optional override of the key event to which to listen.

Important: Calls to setKeyMap do not replace the entire keyMap but instead update the provided mappings. That is, unless null is passed as the value of the keyMap which will clear the keyMap of all entries.

Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of cfg-listeners. It defaults to the "controller", but using 'this' means that an instance method will be used.

getKeyMap : Object

Returns the value of keyMap

Returns

Object

setKeyMap (keyMap)

Sets the value of keyMap

Parameters

keyMap :  Object

keyMapEnabled : Boolean
bindable bind

Enables or disables processing keys in the keyMap. This value starts as null and if it is null when initKeyMap is called, it will automatically be set to true. Since initKeyMap is called by Ext.Component at the proper time, this is not something application code normally handles.

Defaults to:

null

getKeyMapEnabled : Boolean

Returns the value of keyMapEnabled

Returns

Boolean

setKeyMapEnabled (keyMapEnabled)

Sets the value of keyMapEnabled

Parameters

keyMapEnabled :  Boolean

layout : Object / String
bindable bind

Configuration for this Container's layout. Example:

<Container
    layout={{
        type: "hbox",
        align: "middle"
    }}
>
    <Panel
        html="hello"
        flex={1}
        bodyStyle={{
            background: "#000",
            color: "#fff"
        }}
    />
    <Panel
        html="world"
        flex={2}
        bodyStyle={{
            background: "#f00",
            color: "#fff"
        }}
    />
</Container>

Defaults to:

auto

getLayout : Object / String

Returns the value of layout

Returns

Object / String

setLayout (layout)

Sets the value of layout

Parameters

layout :  Object / String

left : Number / String
bindable bind

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

getLeft : Number / String

Returns the value of left

Returns

Number / String

setLeft (left)

Sets the value of left

Parameters

left :  Number / String

legend : Ext.chart.legend.Legend / Ext.chart.legend.SpriteLegend / Boolean
bindable bind

The legend config for the chart. If specified, a legend block will be shown next to the chart. Each legend item displays the title of the series, the color of the series and allows to toggle the visibility of the series (at least one series should remain visible).

Sencha Charts support two types of legends: DOM based and sprite based.

The sprite based legend can be shown in chart preview and is a part of the downloaded chart image. The sprite based legend is always displayed in full and takes as much space as necessary, the legend items are split into columns to use the available space efficiently. The sprite based legend is styled via a Ext.chart.theme.Base.

The DOM based legend supports RTL. It occupies a fixed width or height and scrolls when the content overflows. The DOM based legend is styled via CSS rules.

By default the DOM legend is used. The type can be explicitly specified:

legend: {
    type: 'sprite', // 'dom' is another possible value
    docked: 'top'
}

If the legend config is set to true, the DOM legend will be used docked to the bottom.

Defaults to:

null

setLegend (legend)

Sets the value of legend

Parameters

legend :  Ext.chart.legend.Legend / Ext.chart.legend.SpriteLegend / Boolean

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 DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

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

margin : Number / String
bindable bind

The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'

Defaults to:

null

getMargin : Number / String

Returns the value of margin

Returns

Number / String

setMargin (margin)

Sets the value of margin

Parameters

margin :  Number / String

masked : Boolean / Object / Ext.Mask / Ext.LoadMask
bindable bind

A configuration to allow you to mask this container.

If the value is a boolean, a plain mask will be displayed without a message.

<Container masked>
    Hello World
</Container>

If the value is a string, it will be used as the message config for an Ext.LoadMask.

<Container masked="Please wait...">
    Hello World
</Container>

For more precise control over the mask, you add a <LoadMask/> as a child of the container. Please refer to the Ext.LoadMask component to see the props it supports.

<Container>
    <LoadMask message="Please wait..."/>
</Container>

There are also two convenient methods, mask and unmask, to allow you to mask and unmask this container at any time.

Defaults to:

null

getMasked : Boolean / Object / Ext.Mask / Ext.LoadMask

Returns the value of masked

Returns

Boolean / Object / Ext.Mask / Ext.LoadMask

setMasked (masked)

Sets the value of masked

Parameters

masked :  Boolean / Object / Ext.Mask / Ext.LoadMask

maxHeight : Number / String
bindable bind

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

getMaxHeight : Number / String

Returns the value of maxHeight

Returns

Number / String

setMaxHeight (maxHeight)

Sets the value of maxHeight

Parameters

maxHeight :  Number / String

maxWidth : Number / String
bindable bind

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

getMaxWidth : Number / String

Returns the value of maxWidth

Returns

Number / String

setMaxWidth (maxWidth)

Sets the value of maxWidth

Parameters

maxWidth :  Number / String

minButtonWidth : Number

Minimum width of all footer toolbar buttons in pixels. If set, this will be used as the default value for the Ext.Button#minWidth config of each Button added to the footer toolbar via the fbar or buttons configurations. It will be ignored for buttons that have a minWidth configured some other way, e.g. in their own config object or via the defaults of their parent container.

Defaults to:

null

Available since: 6.5.0

minHeight : Number / String
bindable bind

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

getMinHeight : Number / String

Returns the value of minHeight

Returns

Number / String

setMinHeight (minHeight)

Sets the value of minHeight

Parameters

minHeight :  Number / String

minWidth : Number / String
bindable bind

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

getMinWidth : Number / String

Returns the value of minWidth

Returns

Number / String

setMinWidth (minWidth)

Sets the value of minWidth

Parameters

minWidth :  Number / String

modal : Boolean
bindable bind

true to make this Component modal. This will create a mask underneath the Component that covers its parent and does not allow the user to interact with any other Components until this Component is dismissed.

Defaults to:

null

getModal : Boolean

Returns the value of modal

Returns

Boolean

setModal (modal)

Sets the value of modal

Parameters

modal :  Boolean

name : String

Name for the widget to be used with Ext.Container#lookupName et al.

Defaults to:

null

padding : Number / String
bindable bind

The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'

Defaults to:

null

getPadding : Number / String

Returns the value of padding

Returns

Number / String

setPadding (padding)

Sets the value of padding

Parameters

padding :  Number / String

plugins : Object / String / Object[] / String[]
bindable bind

An object or array of objects that will provide custom functionality for this component. If a string is provided or a string is one of the elements of the array, that string is treated as the type alias. For example, "listpaging" is the type alias for Ext.plugin.ListPaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an init() method that accepts a reference to the owning component.

When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

Example code

A plugin by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: 'listpaging'
 });

Multiple plugins by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

Single plugin by class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         type: 'listpaging',
         autoPaging: true
     }
 });

Multiple plugins by type and class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: [{
         xclass: 'Ext.plugin.PullRefresh',
         pullRefreshText: 'Pull to refresh...'
     }, {
         type: 'listpaging',
         autoPaging: true
     }]
 });

getPlugins : Object / String / Object[] / String[]

Returns the value of plugins

Returns

Object / String / Object[] / String[]

setPlugins (plugins)

Sets the value of plugins

Parameters

plugins :  Object / String / Object[] / String[]

record : Ext.data.Model
bindable bind

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Defaults to:

null

getRecord : Ext.data.Model

Returns the value of record

Returns

Ext.data.Model

setRecord (record)

Sets the value of record

Parameters

record :  Ext.data.Model

renderTo : Ext.dom.Element

Optional element to render this Component to. Not required if this component is an item of a Container of a Container.

Defaults to:

null

resizeHandler : Function
bindable bind

The resize function that can be configured to have a behavior, e.g. resize draw surfaces based on new draw container dimensions. The resizeHandler function takes a single parameter - the size object with width and height properties.

Note: since resize events trigger renderFrame calls automatically, return false from the resize function, if it also calls renderFrame, to prevent double rendering.

Defaults to:

null

getResizeHandler : Function

Returns the value of resizeHandler

Returns

Function

setResizeHandler (resizeHandler)

Sets the value of resizeHandler

Parameters

resizeHandler :  Function

right : Number / String
bindable bind

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

getRight : Number / String

Returns the value of right

Returns

Number / String

setRight (right)

Sets the value of right

Parameters

right :  Number / String

scrollable : Boolean / String / Object
bindable bind

Configuration options to make this Component scrollable. Acceptable values are:

  • true to enable auto scrolling.
  • false (or null) to disable scrolling - this is the default.
  • x or horizontal to enable horizontal scrolling only
  • y or vertical to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);

Defaults to:

null

getScrollable : Boolean / String / Object

Returns the value of scrollable

Returns

Boolean / String / Object

setScrollable (scrollable)

Sets the value of scrollable

Parameters

scrollable :  Boolean / String / Object

series : Ext.chart.series.Series / Array
bindable bind

Array of Ext.chart.series.Series instances or config objects. For example:

series: [{
    type: 'column',
    axis: 'left',
    listeners: {
        'afterrender': function() {
            console.log('afterrender');
        }
    },
    xField: 'category',
    yField: 'data1'
}]

Defaults to:

[]

getSeries : Ext.chart.series.Series / Array

Returns the value of series

Returns

Ext.chart.series.Series / Array

setSeries (series)

Sets the value of series

Parameters

series :  Ext.chart.series.Series / Array

showAnimation : String / Mixed
bindable bind

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

getShowAnimation : String / Mixed

Returns the value of showAnimation

Returns

String / Mixed

setShowAnimation (showAnimation)

Sets the value of showAnimation

Parameters

showAnimation :  String / Mixed

sprites : Object[]
bindable bind

Defines a set of sprites to be added to the drawContainer surface.

For example:

 sprites: [{
      type: 'circle',
      fillStyle: '#79BB3F',
      r: 100,
      x: 100,
      y: 100
 }]

Defaults to:

null

getSprites : Object[]

Returns the value of sprites

Returns

Object[]

setSprites (sprites)

Sets the value of sprites

Parameters

sprites :  Object[]

store : Ext.data.Store / String / Object
bindable bind

The data source to which the chart is bound. Acceptable values for this property are:

  • any Ext.data.Store class / subclass
  • an ID of a store
  • a Ext.data.Store config object. When passing a config you can specify the store type by alias. Passing a config object with a store type will dynamically create a new store of that type when the chart is instantiated.

For example:

Ext.define('MyApp.store.Customer', {
    extend: 'Ext.data.Store',
    alias: 'store.customerstore',

    fields: ['name', 'value']
});


Ext.create({
    xtype: 'cartesian',
    renderTo: document.body,
    height: 400,
    width: 400,
    store: {
        type: 'customerstore',
        data: [{
            name: 'metric one',
            value: 10
        }]
    },
    axes: [{
        type: 'numeric',
        position: 'left',
        title: {
            text: 'Sample Values',
            fontSize: 15
        },
        fields: 'value'
    }, {
        type: 'category',
        position: 'bottom',
        title: {
            text: 'Sample Values',
            fontSize: 15
        },
        fields: 'name'
    }],
    series: {
        type: 'bar',
        xField: 'name',
        yField: 'value'
    }
});

Defaults to:

'ext-empty-store'

getStore : Ext.data.Store / String / Object

Returns the value of store

Returns

Ext.data.Store / String / Object

setStore (store)

Sets the value of store

Parameters

store :  Ext.data.Store / String / Object

style : Object
bindable bind

The style for the chart component.

getStyle : Object

Returns the value of style

Returns

Object

setStyle (style)

Sets the value of style

Parameters

style :  Object

tabIndex : Number
bindable bind

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

setTabIndex ( newTabIndex )

Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.

Parameters

newTabIndex :  Number

new tabIndex to set

theme : String
bindable bind

The name of the theme to be used. A theme defines the colors and styles used by the series, axes, markers and other chart components. Please see the documentation for the Ext.chart.theme.Base class for more information. Possible theme values are:

  • 'green', 'sky', 'red', 'purple', 'blue', 'yellow'
  • 'category1' to 'category6'
  • and the above theme names with the '-gradients' suffix, e.g. 'green-gradients'

IMPORTANT: You should require the themes you use; for example, to use:

theme: 'blue'

the Ext.chart.theme.Blue class should be required:

requires: 'Ext.chart.theme.Blue'

To require all chart themes:

requires: 'Ext.chart.theme.*'

Defaults to:

"default"

getTheme : String

Returns the value of theme

Returns

String

setTheme (theme)

Sets the value of theme

Parameters

theme :  String

tooltip : ToolTip

The ToolTip for this component.

<Button text="Basic Tip">
    <ToolTip>A simple tooltip</ToolTip>
</Button>

Defaults to:

null

top : Number / String
bindable bind

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

getTop : Number / String

Returns the value of top

Returns

Number / String

setTop (top)

Sets the value of top

Parameters

top :  Number / String

touchAction : Object

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

Keys in this object are touch action names, and values are false to disable a touch action or true to enable it. Accepted keys are:

  • panX
  • panY
  • pinchZoom
  • doubleTapZoom

All touch actions are enabled (true) by default, so it is usually only necessary to specify which touch actions to disable. For example, the following disables only horizontal scrolling and pinch-to-zoom on the component's main element:

touchAction: {
    panX: false,
    pinchZoom: false
}

Touch actions can be specified on reference elements using the reference element name, for example:

// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
    panY: false
    body: {
        doubleTapZoom: false
    }
}

The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:

Ext.create('Ext.Widget', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

null

tpl : Function / String / String[]
bindable bind

A string, array of strings, or a function that returns JSX.

tpl = data =>

{data.first_name} {data.last_name}

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Defaults to:

null

getTpl : Function / String / String[]

Returns the value of tpl

Returns

Function / String / String[]

setTpl (tpl)

Sets the value of tpl

Parameters

tpl :  Function / String / String[]

tplWriteMode : String
bindable bind

The Ext.(X)Template method to use when updating the content area of the Component.

Valid modes are:

  • append
  • insertAfter
  • insertBefore
  • insertFirst
  • overwrite

Defaults to:

'overwrite'

getTplWriteMode : String

Returns the value of tplWriteMode

Returns

String

setTplWriteMode (tplWriteMode)

Sets the value of tplWriteMode

Parameters

tplWriteMode :  String

ui : String / String[]

The ui or uis to be used on this Component

When a ui is configured, CSS class names are added to the element, created by appending the ui name(s) to each classCls and/or baseCls.

Defaults to:

null

userCls : String / String[]

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

For example:

 items: [{
     xtype: 'button',
     userCls: 'my-button'
 ...
 }]

Defaults to:

null

weight : Number

This value controls this item's order in a weighted Container (see parent).

Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.

Defaults to:

null

weighted : Boolean

If set to true, then child items may be specified as a object, with each property name specifying an itemId, and the property value being the child item configuration object.

When using this scheme, each child item may contain a weight configuration value which affects its order in this container. Lower weights are towards the start, higher weights towards the end.

Defaults to:

false

width : Number / String
bindable bind

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

getWidth : Number / String

Returns the value of width

Returns

Number / String

setWidth (width)

Sets the value of width

Parameters

width :  Number / String

xtype : String

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom Ext.Component by specifying the alias config option with a prefix of widget. For example:

Ext.define('PressMeButton', {
    extend: 'Ext.button.Button',
    alias: 'widget.pressmebutton',
    text: 'Press Me'
});

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

Defaults to:

"component"

zIndex : Number
bindable bind

The z-index to give this Component when it is rendered.

Not valid for floated Components. The Z ordering of floated Components is managed by ordering of the DOM elements.

Defaults to:

null

getZIndex : Number

Returns the value of zIndex

Returns

Number

setZIndex (zIndex)

Sets the value of zIndex

Parameters

zIndex :  Number

properties

Instance Properties

factoryConfig : Object

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

focusClsEl : Ext.dom.Element

The element that will have the focusCls applied when component's focusEl is focused.

focusEl : Ext.dom.Element

The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.

Defaults to:

'el'

isObservable : Boolean

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

Defaults to:

true

methods

Instance Methods

addListener ( 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 arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these 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: '<h1 class="myTitle">BODY TITLE</h1>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();

addPlugin ( plugin )

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

 list.addPlugin({
     type: 'pullrefresh',
     pullRefreshText: 'Pull to refresh...'
 });

Available since: 6.2.0

Parameters

plugin :  Object/String/Ext.plugin.Abstract

The plugin or config object or alias to add.

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

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.

findPlugin ( type ) : Ext.plugin.Abstract

Retrieves plugin by its type alias. For example:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

 list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');

Note: See also getPlugin.

Available since: 6.2.0

Parameters

type :  String

The Plugin's type as specified by the class's alias configuration.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

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

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.

focus ( [selectText] ) : Boolean

Try to focus this component.

If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.

Parameters

selectText :  Boolean/Number[] (optional)

If applicable, true to also select all the text in this component, or an array consisting of start and end (defaults to start) position of selection.

Returns

:Boolean

true if focus target was found and focusing was attempted, false if no focusing attempt was made.

getInherited ( [inner] ) : Object

This method returns an object containing the inherited properties for this instance.

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

Pass true to return inheritedStateInner instead of the normal inheritedState object. This is only needed internally and should not be passed by user code.

Defaults to: false

Returns

:Object

The inheritedState object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

This method returns the value of a config property that may be inherited from some ancestor.

In some cases, a config may be explicitly set on a component with the intent of only being presented to its children while that component should act upon the inherited value (see referenceHolder for example). In these cases the skipThis parameter should be specified as true.

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

Pass true if the property should be ignored if found on this instance. In other words, true means the property must be inherited and not explicitly set on this instance.

Defaults to: false

Returns

:Mixed

The value of the requested property.

getParent Ext.Component

Returns the parent of this component, if it has one.

Returns

:Ext.Component

The parent of this component.

getPlugin ( id ) : Ext.plugin.Abstract

Retrieves a plugin by its id.

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         xclass: 'Ext.plugin.PullRefresh',
         id: 'foo'
     }
 });

 list.getPlugin('foo').setPullRefreshText('Pull to refresh...');

Note: See also findPlugin.

Available since: 6.2.0

Parameters

id :  String

The id of the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

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

hasParent Boolean

Returns true if this component has a parent.

Returns

:Boolean

true if this component has a parent.

is Boolean
template tpl

Selector processing function for use by nextSibling,previousibling, nextNode,and previousNode, to filter candidate nodes.

The base implementation returns true. Classes which mix in Traversable may implement their own implementations. @link{Ext.Widget} does this to implement Ext.ComponentQuery based filterability.

Returns

:Boolean

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

isAncestor ( possibleDescendant )

Determines whether this Component is an ancestor of the passed Component. This will return true if the passed Component is anywhere within the subtree beneath this Component.

Parameters

possibleDescendant :  Ext.Component

The Component to test for presence within this Component's subtree.

isDescendantOf ( ancestor ) : Boolean

Determines whether this component is the descendant of a passed component.

Parameters

ancestor :  Ext.Component

A Component which may contain this Component.

Returns

:Boolean

true if the component is the descendant of the passed component, otherwise false.

isFocusable ( [deep] ) : Boolean

Determine if this Focusable can receive focus at this time.

Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see Container for more information.

Parameters

deep :  Boolean (optional)

Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.

Defaults to: false

Returns

:Boolean

True if component is focusable, false if not.

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

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.

nextNode ( [selector] ) : Ext.Component

Returns the next node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with nextSibling.

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following nodes.

Returns

:Ext.Component

The next node (or the next node which matches the selector). Returns null if there is no matching node.

nextSibling ( [selector] ) : Ext.Component

Returns the next sibling of this Component.

Optionally selects the next sibling which matches the passed Ext.ComponentQuery selector.

May also be referred to as next()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with nextNode

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following items.

Returns

:Ext.Component

The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.

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 arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these 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: '<h1 class="myTitle">BODY TITLE</h1>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.

previousNode ( [selector] ) : Ext.Component

Returns the previous node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding nodes.

Returns

:Ext.Component

The previous node (or the previous node which matches the selector). Returns null if there is no matching node.

previousSibling ( [selector] ) : Ext.Component

Returns the previous sibling of this Component.

Optionally selects the previous sibling which matches the passed Ext.ComponentQuery selector.

May also be referred to as prev()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding items.

Returns

:Ext.Component

The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

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

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

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.

removePlugin ( plugin, [destroy] ) : Ext.plugin.Abstract

Removes and (optionally) destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

destroy :  Boolean (optional)

Pass true to not call destroy() on the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

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.

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.

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

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.

up ( [selector], [limit] ) : Ext.Container

Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.

Example:

var owningTabPanel = grid.up('tabpanel');

Parameters

selector :  String (optional)

The simple selector to test.

limit :  String/Number/Ext.Component (optional)

This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

Returns

:Ext.Container

The matching ancestor Container (or undefined if no match was found).

Static Methods

override ( members ) : Ext.Base
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

events

activate ( newActiveItem, this, oldActiveItem, eOpts )

Fires whenever item within the Container is activated.

Parameters

newActiveItem :  Object

The new active item within the container.

this :  Ext.Container

The Container instance.

oldActiveItem :  Object

The old active item within the container.

eOpts : Object

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

activeItemchange ( sender, value, oldValue, eOpts )

This event fires when activeItem changes.

Parameters

sender :  Ext.Container

The instance firing this event.

value :  Object/String/Number

The current value of activeItem.

oldValue :  Object/String/Number

The previous value of activeItem.

eOpts : Object

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

add ( this, item, index, eOpts )

Fires whenever item added to the Container.

Parameters

this :  Ext.Container

The Container instance.

item :  Object

The item added to the Container.

index :  Number

The index of the item within the Container.

eOpts : Object

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

added ( this, container, index, eOpts )

Fires after a Component had been added to a Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Parent Container

index :  Number

The index of the item within the Container.

eOpts : Object

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

beforeactiveItemchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when activeItem changes.

Parameters

sender :  Ext.Container

The instance firing this event.

value :  Object/String/Number

The current value of activeItem.

oldValue :  Object/String/Number

The previous value of activeItem.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforebottomchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforecenteredchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforedisabledchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforedockedchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforeheightchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforehiddenchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforehide ( this, eOpts )

Fires before the Component is hidden. Hide may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

beforeleftchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforemaxHeightchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforemaxWidthchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforeminHeightchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforeminWidthchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforerefresh ( this, eOpts )

Fires before a refresh to the chart data is called. If the beforerefresh handler returns false the refresh action will be canceled.

Parameters

this :  Ext.chart.AbstractChart

eOpts : Object

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

beforerightchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforescrollablechange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforeshow ( this, eOpts )

Fires before the Component is shown. Show may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

beforetopchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

beforewidthchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

blur ( this, event, eOpts )

Fires when this Component's focusEl loses focus.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The blur event.

eOpts : Object

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

bodyresize ( size, eOpts )

Fires when the size of the draw container body changes.

Parameters

size :  Object

The object containing 'width' and 'height' of the draw container's body.

eOpts : Object

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

bottomchange ( sender, value, oldValue, eOpts )

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

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

centeredchange ( sender, value, oldValue, eOpts )

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

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

deactivate ( oldActiveItem, this, newActiveItem, eOpts )

Fires whenever item within the Container is deactivated.

Parameters

oldActiveItem :  Object

The old active item within the container.

this :  Ext.Container

The Container instance.

newActiveItem :  Object

The new active item within the container.

eOpts : Object

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

destroy

Fires when the component is destroyed

disabledchange ( sender, value, oldValue, eOpts )

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

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

dockedchange ( sender, value, oldValue, eOpts )

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

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

erased ( this, eOpts )

Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

focus ( this, event, eOpts )

Fires when this Component's focusEl receives focus.

Parameters

this :  Ext.Component/Ext.Widget

event :  Ext.event.Event

The focus event.

eOpts : Object

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

focusenter ( this, event, eOpts )

Fires when focus enters this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusenter event.

eOpts : Object

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

focusleave ( this, event, eOpts )

Fires when focus leaves this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusleave event.

eOpts : Object

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

fullscreen ( this, eOpts )

Fires whenever a Component with the fullscreen config is instantiated

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

heightchange ( sender, value, oldValue, eOpts )

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

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

hiddenchange ( sender, value, oldValue, eOpts )

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

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

hide ( this, eOpts )

Fires whenever the Component is hidden

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

initialize ( this, eOpts )

Fires when the component has been initialized

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

itemclick ( chart, 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

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

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

itemdblclick ( chart, 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

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

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

itemhighlight ( chart, newHighlightItem, oldHighlightItem, eOpts )

Fires when a new chart item is highlighted or dehighlighted. The newHighlightItem and oldHighlightItem objects will have the same type as the object returned by the getItemForPoint method.

Parameters

chart :  Ext.chart.AbstractChart

newHighlightItem :  Object

oldHighlightItem :  Object

eOpts : Object

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

itemmousedown ( chart, 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

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

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

itemmousemove ( chart, 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

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

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

itemmouseout ( chart, 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

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

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

itemmouseover ( chart, 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

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

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

itemmouseup ( chart, 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

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

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

itemtap ( chart, 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

chart :  Ext.chart.AbstractChart

item :  Object

event :  Event

eOpts : Object

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

layout ( this, eOpts )
private pri

Fires after the final layout is done. (Two layouts may be required to fully render a chart. Typically for the initial render and every time thickness of the chart's axes changes.)

Parameters

this :  Ext.chart.AbstractChart

eOpts : Object

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

leftchange ( sender, value, oldValue, eOpts )

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

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

maxHeightchange ( sender, value, oldValue, eOpts )

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

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

maxWidthchange ( sender, value, oldValue, eOpts )

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

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

minHeightchange ( sender, value, oldValue, eOpts )

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

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

minWidthchange ( sender, value, oldValue, eOpts )

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

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

move ( this, item, toIndex, fromIndex, eOpts )

Fires whenever item moved within the Container.

Parameters

this :  Ext.Container

The Container instance.

item :  Object

The item moved within the Container.

toIndex :  Number

The new index of the item.

fromIndex :  Number

The old index of the item.

eOpts : Object

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

moved ( this, container, toIndex, fromIndex, eOpts )

Fires when a component si moved within its Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

toIndex :  Number

The new index of the item.

fromIndex :  Number

The old index of the item.

eOpts : Object

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

painted ( element, eOpts )

Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.

Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly add at least one listener to it, for performance reasons.

Parameters

element :  Ext.dom.Element

The component's outer element (this.element)

eOpts : Object

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

positionedchange ( this, positioned, eOpts )

Fires whenever there is a change in the positioned status of a component

Parameters

this :  Ext.Component

The component instance

positioned :  Boolean

The component's new positioned state. This becomes true is a component is positioned using the cfg-top, cfg-right, cfg-bottom or cfg-left configs.

eOpts : Object

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

redraw ( this, eOpts )

Fires after each redraw call.

Parameters

this :  Ext.chart.AbstractChart

eOpts : Object

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

refresh ( this, eOpts )

Fires after the chart data has been refreshed.

Parameters

this :  Ext.chart.AbstractChart

eOpts : Object

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

remove ( this, item, index, eOpts )

Fires whenever item removed from the Container.

Parameters

this :  Ext.Container

The Container instance.

item :  Object

The item removed from the Container.

index :  Number

The index of the item that was removed.

eOpts : Object

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

removed ( this, container, index, eOpts )

Fires when a component is removed from a Container

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

index :  Number

The index of the item that was removed.

eOpts : Object

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

resize ( component, width, height, oldWidth, oldHeight, eOpts )

Fires asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:

Parameters

component :  Ext.Component

This Component.

width :  String/Number

The new width.

height :  String/Number

The new height.

oldWidth :  String/Number

The previous width.

oldHeight :  String/Number

The previous height.

eOpts : Object

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

rightchange ( sender, value, oldValue, eOpts )

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

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

scrollablechange ( sender, value, oldValue, eOpts )

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

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

show ( this, eOpts )

Fires whenever the Component is shown

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

spriteclick ( sprite, event, eOpts )

Fires when a click event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritedblclick ( sprite, event, eOpts )

Fires when a double click event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemousedown ( sprite, event, eOpts )

Fires when a mousedown event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemousemove ( sprite, event, eOpts )

Fires when the mouse is moved on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemouseout ( sprite, event, eOpts )

Fires when the mouse exits a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemouseover ( sprite, event, eOpts )

Fires when the mouse enters a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemouseup ( sprite, event, eOpts )

Fires when a mouseup event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritetap ( sprite, event, eOpts )

Fires when a tap event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

storechange ( chart, newStore, oldStore, eOpts )

Fires when the store of the chart changes.

Parameters

chart :  Ext.chart.AbstractChart

newStore :  Ext.data.Store

oldStore :  Ext.data.Store

eOpts : Object

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

topchange ( sender, value, oldValue, eOpts )

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

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

widthchange ( sender, value, oldValue, eOpts )

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

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

ExtReact 6.6.0