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


top

PivotGrid Ext.pivot.Grid premium

Summary

The pivot grid helps you analyze your data.

Calculations can be done either in your browser using a Ext.pivot.matrix.Local matrix or remotely on the server using a Ext.pivot.matrix.Remote matrix.

Example usage:

 {
     xtype:  'pivotgrid',
     matrix: {
         type: 'local',
         store: 'yourStoreId',    // or a store instance
         rowGrandTotalsPosition: 'first',
         leftAxis: [{
             dataIndex: 'country',
             direction: 'DESC',
             header: 'Countries',
             width: 150
         }],
         topAxis: [{
             dataIndex: 'year',
             direction: 'ASC'
         }],
         aggregate: [{
             dataIndex: 'value',
             header: 'Total',
             aggregator: 'sum',
             width: 120
         }]
     }
 }

The modern pivot grid could be styled using data binding as following:

ViewModel on rows

Let's have a look at this example:

 {
     xtype: 'pivotgrid',
     itemConfig: {
         viewModel: {
             type: 'pivot-row-model'
         },
         bind: {
             userCls: '{rowStyle}'
             // or you can define a template
             //userCls: '{record.isRowGroupHeader:pick("","pivotRowHeader")}'
         }
     }
     // ... more configs
 }

In the ViewModel we would declare a formula that will use the record data. The record has all values that are displayed for that row and the following additional fields:

  • isRowGroupHeader
  • isRowGroupTotal
  • isRowGrandTotal
  • leftAxisKey: This is either the grand total key or a key that identifies the left axis item

All these properties can help us style the entire row without knowing anything about the generated columns.

In some case we may want to style positive and negative values generated in the pivot grid. This can be done as following.

 {
     xtype: 'pivotgrid',
     itemConfig: {
         viewModel: {
             type: 'default'
         }
     },
     topAxisCellConfig: {
         bind: {
             userCls: '{value:sign("pivotCellNegative","pivotCellPositive")}'
         }
     }
     // ... more configs
 }

The following data is available for use in the bind template:

  • column

    • isColGroupTotal: this tells us that the column for that specific cell is a group total
    • isColGrandTotal: this tells us that the column for that specific cell is a grand total
  • value: cell value

Note: In such cases you cannot use formulas because the column and value are generated dynamically and can't be replaced in formulas.

It is also possible to style a specific dimension from left axis or aggregate:

 {
     xtype: 'pivotgrid',
     itemConfig: {
         viewModel: {
             type: 'default'
         }
     },
     matrix: {
         aggregate: [{
             dataIndex:  'value',
             aggregator: 'sum',
             align:      'right',

             cellConfig: {
                 bind: {
                     userCls: '{value:sign("pivotCellNegative","pivotCellPositive")}'
                 }
             }
         },{
             dataIndex:  'value',
             aggregator: 'count'
         }],
         leftAxis: [{
             dataIndex:  'person',
             // This is used only when `viewLayoutType` is `outline`
             cellConfig: {
                 bind: {
                     userCls: '{record.isRowGroupHeader::pick("","pivotRowHeader")}'
                 }
             }
         },{
             dataIndex:  'country'
         }]
         // ... more configs
     }
 }

ViewModel on cells

This scenario allows you to define formulas to use in cell binding. Be careful that this means that each cell will have an own ViewModel and this may decrease the pivot grid performance. Use it only if necessary.

 {
     xtype: 'pivotgrid',
     leftAxisCellConfig: {
         viewModel: {
             type: 'default'
         },
         bind: {
             userCls: '{record.isRowGroupHeader::pick("","pivotRowHeader")}'
         }
     },
     topAxisCellConfig: {
         viewModel: {
             type: 'pivot-cell-model' // to be able to define your own formulas
         },
         bind: {
             userCls: '{value:sign("pivotCellNegative","pivotCellPositive")}'
             //userCls: '{column.isColGrandTotal:pick(null,"pivotCellGrandTotal")}'
             //userCls: '{cellCls}
         }
     }
     // ... more configs
 }

This approach lets you use record, column and value in both bind templates and formulas.

If multiple aggregate dimensions are available and you want to style one of them you can define the binding on that dimension like this:

 {
     xtype: 'pivotgrid',
     matrix: {
         aggregate: [{
             dataIndex:  'value',
             aggregator: 'sum',
             align:      'right',

             cellConfig: {
                 viewModel: {
                     type: 'pivot-cell-model'
                 },
                 bind: {
                     userCls: '{value:sign("pivotCellNegative","pivotCellPositive")}'
                     //userCls: '{column.isColGrandTotal:pick(null,"pivotCellGrandTotal")}'
                     //userCls: '{cellCls}
                 }
             }
         },{
             dataIndex:  'value',
             aggregator: 'count'
         }]
         // ... more configs
     }
 }

Children

The following Components (and their sub-components) may be included as children of PivotGrid:
String
Object
GridColumn
No members found using the current filters

props

Required Props

matrix : Ext.pivot.matrix.Base
required req

This is the pivot matrix used by the pivot grid. All axis and aggregate dimensions should be defined here.

Example usage:

 {
     xtype:  'pivotgrid',
     matrix: {
         type: 'local',
         store: 'yourStoreId'    // or a store instance
         rowGrandTotalsPosition: 'first',
         leftAxis: [{
             dataIndex: 'country',
             direction: 'DESC',
             header: 'Countries'
             width: 150
         }],
         topAxis: [{
             dataIndex: 'year',
             direction: 'ASC'
         }],
         aggregate: [{
             dataIndex: 'value',
             header: 'Total',
             aggregator: 'sum',
             width: 120
         }]
     }
 }

store : Ext.data.Store / Object
immutable imm required req

Can be either a Store instance or a configuration object that will be turned into a Store. The Store is used to populate the set of items that will be rendered in the DataView. See the DataView intro documentation for more information about the relationship between Store and DataView.

Optional Props

activeChildTabIndex : Number
immutable imm

DOM tabIndex attribute to set on the active Focusable child of this container when using the "Roaming tabindex" technique.

Defaults to:

0

activeItem : Object / String / Number

The item from the cfg-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

allowFocusingDisabledChildren : Boolean
immutable imm

Set this to true to enable focusing disabled child items via keyboard.

Defaults to:

false

alwaysOnTop : Boolean / Number

A flag indicating that this component should be above its floated siblings.

This may be a positive number to prioritize the ordering of multiple visible always on top components.

This may be set to a negative number to prioritize a component to the bottom of the z-index stack.

Defaults to:

false

Available since: 6.2.0

ariaAttributes : Object

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.

ariaDescribedBy : String
immutable imm

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

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

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.

associatedData : Boolean / Object
immutable imm

Set this config to false to limit rendering data to just the record's data or to an object to describe the desired associated data. This data is used to satisfy the itemTpl. The default of true will gather all associated data that is currently loaded. This can be expensive. If only a small amount of the available data is needed, this config can speed up the rendering process.

For example, if an OrderItem needs the Item data but not its parent Order, this config can be set like so:

 associatedData: {
     item: true
 }

Given the above, only the item association (to the Item record) will be gathered into the render data.

For more details, see getData.

Defaults to:

true

Available since: 6.5.0

autoDestroy : Boolean

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

Defaults to:

true

autoSize : Boolean

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

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

border : Boolean

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

bottom : Number / String

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

bufferSize : Number

The amount of items we render additionally besides the ones currently visible. We try to prevent the rendering of items while scrolling until the next time you stop scrolling. If you scroll close to the end of the buffer, we start rendering individual items to always have the minimumBufferSize prepared.

Defaults to:

20

centered : Boolean

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:

false

cls : String / String[]

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

clsGrandTotal : String
immutable imm

CSS class assigned to the grand totals.

Defaults to:

true

clsGroupTotal : String
immutable imm

CSS class assigned to the group totals.

Defaults to:

true

columnLines : Boolean

Configure as true to display lines between grid cells.

Defaults to:

null

columnMenu : Object

This is a config object which is used by columns in this grid to create their header menus.

The default column menu contains the following items.

  • A "Sort Ascending" menu item
  • A "Sort Descending" menu item
  • A Columns menu item with each of the columns in a sub-menu of check items that is used to hide or show each column.
  • A "Group by this field" menu item to enable grouping.
  • A "Show in groups" check menu item to enable/disable grouping.

These items have weight of -100, -90 and -80 respectively to place them at the start of the menu.

This can be configured as null to prevent columns from showing a column menu.

constrainAlign : String / Ext.util.Region / Ext.dom.Element

A specification of the constraint to apply when showBy or alignTo is called to align a floated or positioned component.

Defaults to the parent container for positioned components (components which have their top, right, bottom or left set to move them out of their container's layout flow).

Defaults to the viewport for floated components.

May be a Ext.ComponentQuery selector to find an ancestor component to constrain within.

May be false to specify that constraining is not applied.

You may also specify an element, or a Ext.util.Region

container : Object

This config is used to control the internal Container created to manage this list's items. One common use for this is to apply a userCls to the item container.

 {
     xtype: 'list',
     container: {
         userCls: 'mylist-cls'
     },
     ...
 }

Available since: 6.0.1

contentEl : Ext.dom.Element / HTMLElement / String

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

data : Object

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

Defaults to:

null

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

null

defaults : Object

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

deferEmptyText : Boolean
immutable imm

Set to false to not defer emptyText being applied until the store's first load.

Defaults to:

true

deselectOnContainerClick : Boolean
immutable imm

When set to true, tapping on the DataView's background (i.e. not on an item in the DataView) will deselect any currently selected items.

Defaults to:

true

disableSelection : Boolean
immutable imm

Set to true to disable selection styling. This only affects the presentation of the selection not the internal selection state.

Defaults to:

false

disabled : Boolean

Whether or not this component is disabled

Defaults to:

null

disclosureProperty : String

A property to check on each record to display the disclosure on a per record basis. This property must be false to prevent the disclosure from being displayed on the item.

Defaults to:

'disclosure'

displayed : Boolean

Set to true to call show and false to call hide. Unlike the hidden config, changing this config will potentially involve animations to show or hide the component.

Defaults to:

null

Available since: 6.5.0

docked : String

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

draggable : Boolean / Object / Ext.drag.Source

Configuration options to make this Component draggable

Defaults to:

null

emptyItemText : String
immutable imm

The text to render when the rendering of the item via itemTpl produces no text.

Defaults to:

'\xA0'

emptyText : String / Boolean

The text to display in the view when there is no data to display. Set this to true to display the default message.

emptyTextDefaults : Object / Ext.Component
immutable imm

This component config object is used to create the emptyText component.

Available since: 6.5.0

emptyTextProperty : String
immutable imm

The config to set on the emptyText component to contain the desired text.

Defaults to:

"html"

Available since: 6.5.0

enableColumnSort : Boolean
immutable imm

Set this on false if you don't want to allow column sorting in the pivot grid generated columns.

Defaults to:

true

enableLoadMask : Boolean
immutable imm

Set this on false if you don't want to see the loading mask.

Defaults to:

true

enableTextSelection : Boolean

True to enable text selection inside this view.

Defaults to:

false

factoryConfig : Object
readonly ro

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

flex : Number / String / Object

The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.

You can also update the flex of a component dynamically using the Ext.layout.FlexBox#setItemFlex method.

When supplied as a string or number this option supports the same syntax as CSS flex. For example:

flex: '1 2 auto'

sets flex-grow property to 0, flex-shrink to 2 and flex-basis to 'auto'.

The default flex-shrink value for box layout items is set to 0 in the stylesheet, which is different from the browser's default flex-shrink value of 1. This accommodates the majority use case for applications since where non-flexed components are typically not expected to shrink smaller than their default size.

For convenience when only a single number is supplied it is used as the value for both flex-grow and flex-shrink, for example flex: 3 is the same as flex: '3 3'

An object form is also accepted:

flex: {
    grow: 1,
    shrink: 2,
    basis: 'auto'
}

When the object form is supplied shrink always defaults to 0 regardless of the value of grow.

Although 'auto' is the default value for flex-basis, flex-basis defaults to 0% when flex is supplied as a single numeric or string value (e.g. flex: 1). If this behavior is not desired either explicitly set flex-basis to 'auto' or use the object form to set only grow and/or shrink:

flex: {
    grow: 2
}

floated : Boolean

A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.

A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.

By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent floated component with cfg-relative: true.

Defaults to:

false

Available since: 6.2.0

focusCls : String
immutable imm

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

Defaults to:

'x-focused'

focusClsEl : Ext.dom.Element
readonly ro

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

focusEl : Ext.dom.Element
readonly ro

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'

focusableContainer : Boolean
immutable imm

Enable or disable navigation with arrow keys for this FocusableContainer. This option may be useful with nested FocusableContainers, when only the root container should handle keyboard events.

Defaults to:

false

focusableContainerEl : String / Ext.dom.Element
readonly ro

The name of the element that FocusableContainer should bind its keyboard handler to. Similar to ariaEl, this name is resolved to the Ext.dom.Element instance after rendering.

Defaults to:

"el"

fullscreen : Boolean
immutable imm

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

groupHeaderTpl : String / String[] / Ext.XTemplate

A single string or an array of strings (optionally followed by an object containing template methods) used to create an Ext.XTemplate, or an Ext.XTemplate instance.

A single string:

  groupHeaderTpl: 'Group: {name}'

Using a string array (followed by an options object):

  groupHeaderTpl: [
      'Group: ',
      '<div>{name:this.formatName}</div>',
      {
          formatName: function(name) {
              return Ext.String.trim(name);
          }
      }
  ]

The data object available to the template provides the following properties:

  • name The grouping string of the groupField for the group header. This string is the string produced by grouper's groupFn.
  • value The value of the groupField for the group header being rendered.
  • columnName The column header associated with the field being grouped by if there is a column for the field, falls back to the groupField.
  • groupField The field name being grouped by.
  • html The rendering of the value as handled by the cell (for a grid, otherwise the same as name).
  • children An array containing the child records for the group. This is not available if the store is a Ext.data.BufferedStore.

Available since: 6.5.0

grouped : Boolean

Whether or not to group items in the provided Store with a header for each item.

Defaults to:

null

height : Number / String

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

hidden : Boolean

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

Defaults to true for floated Components.

Defaults to:

null

hideAnimation : String / Mixed

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

hideHeaders : Boolean

true to hide the grid column headers.

Defaults to:

false

Available since: 6.0.1

hideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

A String which specifies how this component's DOM element will be hidden. The accepted values are any of these:

Hiding using display results in having no dimensions as well as resetting scroll positions to 0.

The other modes overcome this but may have different trade-offs in certain circumstances.

Defaults to:

'display'

Available since: 6.5.0

hideOnMaskTap : Boolean

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

html : String / Ext.dom.Element / HTMLElement

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

Defaults to:

null

id : String
immutable imm

The unique id of this component instance.

It should not be necessary to use this configuration except for singleton objects in your application. Components created with an id may be accessed globally using Ext.getCmp.

Instead of using assigned ids, use the itemId config, and Ext.ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query its descendant Components by selector.

Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.

Note: to avoid complications imposed by a unique id also see itemId.

Defaults to an auto-assigned id.

inactiveChildTabIndex : Number
immutable imm

DOM tabIndex attribute to set on inactive Focusable children of this container when using the "Roaming tabindex" technique. This value rarely needs to be changed from its default.

Defaults to:

-1

indexBar : Boolean / Object

Set to true to render an alphabet IndexBar docked on the right. This can also be a config object for the Ext.dataview.IndexBar component.

Defaults to:

false

inline : Boolean / Object

When set to true the items within the DataView will have their display set to inline-block and be arranged horizontally. By default the items will wrap to the width of the DataView. Passing an object with { wrap: false } will turn off this wrapping behavior and overflowed items will need to be scrolled to horizontally.

innerCls : String

A string to add to the immediate parent element of the inner items of this container. That is, items that are not docked, positioned or floated. In some containers, positioned items may be in this same element.

Defaults to:

null

Available since: 6.5.0

isContainer : Boolean
readonly ro

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

Defaults to:

true

isDataView : Boolean
readonly ro

true to identify an object as an instantiated DataView, or subclass thereof.

Defaults to:

true

isObservable : Boolean
readonly ro

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

Defaults to:

true

itemCls : String

An additional CSS class to apply to items within the DataView.

itemConfig : Object / Ext.Component

The object is used to configure the data items created by this data view. The xtype property of this config overrides the container's defaultType.

itemContentCls : String

A class to add to the element that immediate wraps the item content produced by the itemTpl (the "inner-html" element).

Available since: 6.5.0

itemDataMap : Object

This object allows you to map Ext.data.Model fields to specific configs on component items.

The itemDataMap object's keys describe the target objects to receive data from the associated record. These keys are either '#' (for the item itself) or a reference to a component contained in the item.

For each target listed in itemDataMap, the value is another map describing the config name (in the key) and the data field name (as the value).

For example:

 itemDataMap: {
     '#': {
         title: 'fullName'
     },
     text: {
         html: 'name'
     }
 }

The above is equivalent to:

 item.setTitle(item.getRecord().get('fullName'));
 item.lookup('text').setHtml(item.getRecord().get('name'));

For more complex mapping of data to item, you should use the data binding as described in the class documentation.

Available since: 6.5.0

itemHeight : Number

This allows you to set the default item height and is used to roughly calculate the amount of items needed to fill the list. By default items are around 50px high.

Defaults to:

null

itemId : String

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with Ext#getCmp, use itemId with Ext.Container#getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the itemId is scoped locally to the container - avoiding potential conflicts with Ext.ComponentManager which requires a unique id.

Also see id, Ext.Container#query, Ext.Container#down and Ext.Container#child.

itemInnerCls : String

A class to add to the inner element of items.

Available since: 6.5.0

itemTpl : Function / String / String[] /
immutable imm

The tpl to use for each of the items displayed in this DataView. This template produces HTML and can use the follow CSS class names to influence the response to tapping/clicking child elements:

  • x-no-ripple - Disables itemRipple (primarily for theme-material)
  • x-item-no-select - Disables item selection
  • x-item-no-tap - Disables all click or tap processing

For example:

 itemTpl: '<div>' +
              '...' +
              '<div class="x-item-no-select x-fa fa-gear"></div>' +
              '...' +
          '</div>'

Because this template produces HTML from record data it can expose applications to security issues if user-provided data is not properly encoded. For example, in previous releases this template was:

 itemTpl: '<div>{text}</div>'

If the 'text' field contained HTML scripts, these would be evaluated into the application. The itemTpl in version 6.5 is now:

 itemTpl: '<div>{text:htmlEncode}</div>'

Defaults to:

'<div>{text:htmlEncode}</div>

itemsFocusable : Boolean
immutable imm private pri

For use by subclasses, not applications.

By default the dataview items are focusable, and navigable using an Ext.dataview.NavigationModel.

Grid set this to false to make rows non-focusable in favour of cells.

Defaults to:

true

keyMap : Object

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.

keyMapEnabled : Boolean

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

layout : Object / String

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'

left : Number / String

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

leftAxisCellConfig : Object

Cell configuration for columns generated for the left axis dimensions.

Binding could be defined here.

listeners : Object

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

loadingHeight : Number

If specified, gives an explicit height for a floated data view when it is showing the loadingText, if that is specified. This is useful to prevent the view's height from collapsing to zero when the loading mask is applied and there are no other contents in the data view.

loadingText : String / Boolean
immutable imm

A string to display during data load operations. This text will be displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's contents will continue to display normally until the new data is loaded and the contents are replaced.

Defaults to:

'Loading...'

manageBorders : Boolean
immutable imm protected pro

true to enable border management of docked items. When enabled, borders of docked items will collapse where they meet to avoid duplicated borders.

Defaults to:

false

margin : Number / String

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

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

A configuration to allow you to mask this container. You can optionally pass an object block with and xtype of loadmask, and an optional message value to display a loading mask. Please refer to the Ext.LoadMask component to see other configurations.

<Container
    html="Hello World"
    masked={{
        xtype: "loadmask",
        message: "My Message"
    }}
/>

Alternatively, you can just call the setter at any time with true/false to show/hide the mask:

setMasked(true); //show the mask
setMasked(false); //hides the mask

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

Defaults to:

null

maxHeight : Number / String

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

maxItemCache : Number

The number of components to cache when no longer needed (as opposed to calling destroy on them).

Defaults to:

20

maxWidth : Number / String

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

minHeight : Number / String

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

minWidth : Number / String

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

modal : Boolean

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

modelValidation : Boolean
immutable imm

This config enables binding to your Ext.data.Model#validators. This is only processed by form fields (e.g., Ext.field.*) at present, however, this setting is inherited and so can be set on a parent container.

When set to true by a component (or by an ancestor container), the validators of for any {@Ext.data.Model record} fields will be used wherever the value is bound to such data fields.

While this config can be set arbitrarily high in the component hierarchy, doing so can create a lot overhead if most of your form fields do not actually rely on validators in your data model.

Using this setting for a form that is bound to an Ext.data.Model might look like this:

 {
     xtype: 'panel',
     modelValidation: true,
     items: [{
         xtype: 'textfield',
         bind: '{theUser.firstName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.lastName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.phoneNumber}'
     },{
         xtype: 'textfield',
         bind: '{theUser.email}'
     }]
 }

Defaults to:

null

Available since: 6.5.0

multiColumnSort : Boolean

Configure as true to have columns remember their sorted state after other columns have been clicked upon to sort.

As subsequent columns are clicked upon, they become the new primary sort key.

The maximum number of sorters allowed in a Store is configurable via its underlying data collection. See Ext.util.Collection#multiSortLimit

Defaults to:

false

name : String
immutable imm

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

Defaults to:

null

nameHolder : Boolean
immutable imm

When true child components are tracked by their name property and can be retrieved using the lookupName method.

Defaults to:

false

onItemDisclosure : Boolean / Function / String / Object

true to display a disclosure icon on each list item. The list will still fire the disclose event, and the event can be stopped before itemtap. By setting this config to a function, the function passed will be called when the disclosure is tapped. Finally you can specify an object with a 'scope' and 'handler' property defined. This will also be bound to the tap event listener and is useful when you want to change the scope of the handler.

Defaults to:

null

padding : Number / String

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

pinHeaders : Boolean

Whether or not to pin headers on top of item groups while scrolling for an iPhone native list experience.

Defaults to:

true

pinnedHeader : Object
immutable imm

A config object for the pinned header. Only applicable when pinHeaders is true.

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

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

pressedDelay : Number
immutable imm

The amount of delay between the tapstart and adding the pressedCls.

Defaults to:

100

preventSelectionOnDisclose : Boolean

true to prevent the item selection when the user taps a disclose icon.

Defaults to:

true

referenceHolder : Boolean
immutable imm

If true, this container will be marked as being a point in the hierarchy where references to items with a specified reference config will be held. The container will automatically become a referenceHolder if a controller is specified.

See the introductory docs for Ext.container.Container for more information about references & reference holders.

Defaults to:

false

refreshHeightOnUpdate : Boolean

Set this to false if you make many updates to your list (like in an interval), but updates won't affect the item's height. Doing this will increase the performance of these updates.

Defaults to:

true

relative : Boolean

Only valid when a component is cfg-floated

Configure this as true if you require descendant floated components to be positioned relative to this component's coordinate space, not the viewport's coordinate space.

Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.

Defaults to:

false

Available since: 6.2.0

reserveScrollbar : Boolean
immutable imm

only meaningful on platforms which has space-consuming scroll bars

Configure as true to leave space for a scrollbar to appear even if the content does not overflow.

This is useful for trees which may expand and collapse causing visual flickering when scrollbars appear of disappear.

Defaults to:

false

resetFocusPosition : Boolean
immutable imm

When true, FocusableContainer will reset last focused position whenever focus leaves the container. Subsequent tabbing into the container will always focus the first eligible child item.

When false, subsequent tabbing into the container will focus the child item that was last focused before.

Defaults to:

false

restoreFocus : Boolean
readonly ro

By default, using the TAB key to reenter a grid restores focus to the cell which was last focused.

Setting this to false means that TAB from above focuses the first rendered cell and TAB from below focuses the last rendered cell.

Be aware that due to buffered rendering, the last row of a 1,000,000 row grid may not be available to receive immediate focus.

Defaults to:

true

right : Number / String

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

ripple : Boolean / Object / String

Set to truthy, Color or Object value for the ripple.

Available since: 6.5.0

Properties

color : String

The background color of the ripple.

position : Array

Position for the ripple to start at [x,y]. Determines if a Ripple effect should happen whenever this element is pressed.

For example: { ripple: true }

Or:

 {
     ripple: {
         color: 'red'
     }
 }

For complex components, individual elements can suppress ripples by adding the x-no-ripple class to disable rippling for a tree of elements.

rowLines : Boolean

Set this to false to suppress the borders in between the items in this list. By default the presence of borders in between the items is determined by the stylesheet.

Defaults to:

null

scrollDock : String

The dock position of a list's child items relative to the list itself. Can be top or bottom.

Ext.create('Ext.List', {
     fullscreen: true,
     itemTpl: '{firstName}',
     data: [
         { firstName: 'Peter'},
         { firstName: 'Raymond'},
         { firstName: 'Egon'},
         { firstName: 'Winston'}
     ],
     items: [{
          xtype: 'component',
          html: 'Docked!',
          docked: 'top'
     },{
          xtype: 'component',
          html: 'Scroll Docked!',
          scrollDock: 'top'
     }]
 });

Defaults to:

null

scrollToTopOnRefresh : Boolean

Scroll the DataView to the top when the DataView is refreshed.

Defaults to:

true

scrollable : Boolean / String / Object

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:

true

selectable : Object

A configuration object which allows passing of configuration options to create or reconfigure a Ext.dataview.selection.Model.

May contain the following options:

- mode `'single'`, `'multi'` Allow selection of only a single or multiple *records*.
This is only valid when selecting rows.
- deselectable Configure as false to disallow deselecting down to zero selected *records*.
This is only valid when selecting rows.
- drag `true` or `false` to allow drag gestures to swipt a rage of cells or rows.
- columns `true` to enable column selection by clicking on headers. Defaults to `false`
- cells `true` to enable cell selection by clicking or dragging on cells. Defaults to `false`
- rows Set to `false` to disable selecting rows. Defaults to `true`
- checkbox `true` to add a checkbox column to display selected state. `'only'` to indicate
that only clicks on the checkbox affect row selected state.
- extensible `true` to enable the selection to be extended either in the `X` or `Y` axis
or `'x'` or `'y'` to configure

selfAlign : String

Specifies the self alignment of this widget in a box layout

shadow : Boolean

Configure as true for the component to have a drop shadow. 'false' will suppress any default shadow. By default the theme will determine the presence of a shadow.

Available since: 6.2.0

shim : Boolean

Only valid when a component is cfg-floated

Configure as true for the component to use an <iframe> as an underlay to ensure certain non-standard browser plugins are occluded by this component.

Defaults to:

false

Available since: 6.2.0

showAnimation : String / Mixed

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

sortable : Boolean

Configure as false to disable column sorting via clicking the header and via the Sorting menu items.

Defaults to:

true

startColGroupsCollapsed : Boolean
immutable imm

Should the col groups be expanded on first init?

Defaults to:

true

startRowGroupsCollapsed : Boolean
immutable imm

Should the row groups be expanded on first init?

Defaults to:

true

striped : Boolean

Set this to true if you want the items in the list to be zebra striped, alternating their background color.

Defaults to:

true

style : String / Object

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

You can pass either a string syntax:

style: 'background:red'

Or by using an object:

style: {
    background: 'red'
}

When using the object syntax, you can define CSS Properties by using a string:

style: {
    'border-left': '1px solid red'
}

Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.

Defaults to:

null

tabIndex : Number

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

title : String

The title that will be displayed in the TitleBar at the top of this Grid.

Defaults to:

''

toFrontOnShow : Boolean

True to automatically call toFront when a cfg-floated Component is shown.

Defaults to:

true

top : Number / String

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

topAxisCellConfig : Object

Cell configuration for columns generated for the top axis and aggregate dimensions.

Binding could be defined here.

touchAction : Object
immutable imm

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:

true

tpl : String / String[] / Ext.Template / Ext.XTemplate[]

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

tplWriteMode : String

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'

triggerCtEvent : 'tap' / 'singletap'
immutable imm

Determines what type of touch event is recognized as a touch on the container.

Defaults to:

tap

triggerEvent : 'childtap' / 'childsingletap' / 'childdoubletap' / 'childswipe' / 'childtaphold' / 'childlongpress'
immutable imm

Determines what type of touch event causes an item to be selected.

Defaults to:

"childtap"

ui : String / String[]
immutable imm

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:

true

useSimpleItems : Boolean

Set this to true if you just want to have the list create simple items that use the itemTpl. These simple items still support headers, grouping and disclosure functionality but avoid container layouts and deeply nested markup. For many Lists using this configuration will drastically increase the scrolling and render performance.

Defaults to:

true

userCls : String / String[]
immutable imm

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:

true

userSelectable : Boolean / String / Object

Set to true to allow users to select text within this component.

Can also be any valid value for the CSS3 user-select property.

A value of true implies auto, while false implies none.

May also be an object keyed by child element name.

By default, the user cannot click+drag+select text/elements of the UI. Applications may want to enable user selection for specific DOM elements, such as the bodyElement of a component used as a tab panel. The tab and tab text would not be user selectable in this example, but the content area when the tab is selected would.

 userSelectable: {
     element: true,       // optionally allow the element to be user selectable
     bodyElement: true    // optionally allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

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:

0

width : Number / String

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

x : Number

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

xtype : String
immutable imm

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"

y : Number

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

zIndex : Number

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

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

Defaults to:

null

children

columns : GridColumn

One or more GridColumn providing the header text for the column, a column menu, optional column header tools, and a definition of where the data for that column comes from.

Example snippet:

<Grid title="Stock Prices" store={this.store} shadow grouped>
    <Column text="Company" dataIndex="name" width="150"/>
    <Column text="Price" width="85" dataIndex="price" formatter='usMoney'/>
    <Column text="Change" width="100" dataIndex="priceChange" tpl={this.signTpl.bind(this, 'priceChange', '0.00')} cell={{ encodeHtml: false }}/>
    <Column text="% Change" dataIndex="priceChangePct" tpl={this.signTpl.bind(this, 'priceChangePct', '0.00%')} cell={{ encodeHtml: false }}/>
    <Column text="Last Updated" width="125" dataIndex="lastChange" formatter='date("m/d/Y")'/>
</Grid>

NOTE: The Column component or any column sub-component may be used. i.e.: GridColumn

BooleanColumn

CheckColumn

DateColumn

NumberColumn

RowNumberer

Ext.grid.column.Text

TreeColumn

Defaults to:

null

tooltip : String / Object

The ToolTip for this component.

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

Defaults to:

null

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.

child ( [selector] ) : Ext.Component

Retrieves the first direct child of this container which matches the passed selector or component. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.

Parameters

selector :  String/Ext.Component (optional)

An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned.

Returns

:Ext.Component

The matching child Ext.Component (or null if no match was found).

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.

down ( [selector] ) : Ext.Component

Retrieves the first descendant of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.

Parameters

selector :  String/Ext.Component (optional)

An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned.

Returns

:Ext.Component

The matching descendant Ext.Component (or null if no match was 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.

ensureVisible ( [record], [options] )

Scrolls the specified record into view.

Parameters

record :  Number/Ext.data.Model (optional)

The record or the 0-based position to which to scroll. If this parameter is not passed, the options argument must be passed and contain either record or recordIndex.

options :  Object (optional)

An object containing options to modify the operation.

animation :  Boolean (optional)

Pass true to animate the row into view.

focus :  Boolean (optional)

Pass as true to focus the specified row.

highlight :  Boolean (optional)

Pass true to highlight the row with a glow animation when it is in view.

record :  Ext.data.Model (optional)

The record to which to scroll.

recordIndex :  Number (optional)

The 0-based position to which to scroll.

select :  Boolean (optional)

Pass as true to select the specified row.

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.

getGrouped : Boolean

Sets the value of grouped

getHideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

Sets the value of hideMode

getHtml : String / Ext.dom.Element / HTMLElement

Sets the value of html

getId String

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

Returns

:String

id

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.

getItem ( record ) : Ext.dataview.component.(Simple)ListItem

Gets a list item by record.

Parameters

record :  Ext.data.Model

The record

Returns

:Ext.dataview.component.(Simple)ListItem

The list item, if found. null if no matching item exists.

getItemAt ( index ) : Ext.dom.Element/Ext.dataview.component.DataItem

Returns an item at the specified index.

Parameters

index :  Number

Index of the item.

Returns

:Ext.dom.Element/Ext.dataview.component.DataItem

item Item at the specified index.

getItemIndex ( item ) : Number

Returns an index for the specified item.

Parameters

item :  Number

The item to locate.

Returns

:Number

Index for the specified item.

getNamedItems Object

Returns an object holding the descendants of this container keyed by their name. This object should not be held past the scope of the function calling this method. It will not be valid if items are added or removed from this or any sub-container.

The intended usage is shown here (assume there are 3 components with names of "foo", "bar" and "baz" at some level below this container):

 onClick: function () {
     var items = this.getNamedItems();

     // using "items" we can access any descendant by its "name"

     items.foo.getValue() + items.bar.getValue() + items.baz.getValue();
 }

If this component has a name assigned to it, it is not included in this object. That name is understood to belong to the ancestor container configured as the nameHolder.

Available since: 6.5.0

Returns

:Object

An object with each named child. This will be null if this container has no descendants with a name specified.

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.

getReferences Object

Returns an object holding the descendants of this view keyed by their reference. This object should not be held past the scope of the function calling this method. It will not be valid if items are added or removed from this or any sub-container.

The intended usage is shown here (assume there are 3 components with reference values of "foo", "bar" and "baz" at some level below this container):

 onClick: function () {
     var refs = this.getReferences();

     // using "refs" we can access any descendant by its "reference"

     refs.foo.getValue() + refs.bar.getValue() + refs.baz.getValue();
 }

If this component has a reference assigned to it, that is not included in this object. That reference is understood to belong to the ancestor container configured as the referenceHolder.

Available since: 5.0.0

Returns

:Object

An object with each child reference. This will be null if this container has no descendants with a reference specified.

getScrollDockedItems Ext.Component[]

Returns all the items that are docked in the scroller in this list.

Returns

:Ext.Component[]

An array of the scrollDock items

getShim : Boolean

Sets the value of shim

getStriped : Boolean

Sets the value of striped

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

getTitle : String

Sets the value of title

getViewItems Ext.dom.Element[]/Ext.dataview.component.DataItem[]

Returns an array of the current items in the DataView.

Returns

:Ext.dom.Element[]/Ext.dataview.component.DataItem[]

Array of Items.

getX : Number

Sets the value of x

getY : Number

Sets the value of y

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

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

lookup ( ref ) : Ext.Component

Gets a reference to the component with the specified reference value.

The method is a short-hand for the lookupReference method.

Available since: 6.0.1

Parameters

ref :  String

The value of the reference to lookup.

Returns

:Ext.Component

The referenced component or null if it is not found.

lookupName ( name ) : Ext.Component

Gets a reference to the component with the specified name property.

Available since: 6.5.0

Parameters

name :  String

The name of the descendant to lookup.

Returns

:Ext.Component

The component or null if it is not found.

lookupReferences ( ref ) : Ext.Component

Gets a reference to the component with the specified reference value.

The lookup method is a short-hand version of this method.

Available since: 5.0

Parameters

ref :  String

The name of the reference to lookup.

Returns

:Ext.Component

The referenced component or null if it is not found.

mapToItem ( value, [as] ) : HTMLElement/Ext.dom.Element/Ext.Component

Converts the given indexOrRecord to an "item".

An "item" can be either an Ext.dom.Element or an Ext.Component depending on the type of dataview. For convenience the as parameter can be used to convert the returned item to a common type such as Ext.dom.Element or HTMLElement.

Be aware that the Ext.List subclass can optionally render only some records, in which case not all records will have an associated item in the view and this method will return null.

An index value is a view index. These will only match the record's index in the store when no extra items are added to this dataview (so called "non-record" items). These are often unaligned in Ext.List due to group headers as well as infinite mode where not all records are rendered into the view at one time.

Negative index values are treated as relative to the end such that -1 is the last item, -2 is the next-to-last and so on.

For example:

 // Add "foo" class to the last item in the view
 view.mapToItem(-1, 'el').addCls('foo');

 // Add "foo" class to the last data item in the view
 view.mapToItem(view.getStore().last(), 'el').addCls('foo');

To handle a record's index in the store:

 item = view.mapToItem(view.mapToViewIndex(storeIndex));

Available since: 6.5.0

Parameters

value :  Number/Ext.data.Model/Ext.event.Event

The event, view index or Ext.data.Model.

as :  "dom"/"el" (optional)

Pass "dom" to always return an HTMLElement for the item. For component dataviews this is the component's main element. Pass "el" to return the Ext.dom.Element form of the item. For component dataviews this will be the component's main element. For other dataviews the returned instance is produced by Ext.fly() and should not be retained.

Returns

:HTMLElement/Ext.dom.Element/Ext.Component

mapToRecord ( value ) : Ext.data.Model

Converts the given parameter to a Ext.data.Model. Not all items in a dataview correspond to records (such as group headers in Ext.List). In these cases null is returned.

An "item" can be simply an element or a component depending on the type of dataview.

An index value is a view index. These will only match the record's index in the store when no extra items are added to this dataview (so called "non-record" items). These are often unaligned in Ext.List due to group headers as well as infinite mode where not all records are rendered into the view at one time.

Negative index values are treated as relative to the end such that -1 is the last item, -2 is the next-to-last and so on.

Available since: 6.5.0

Parameters

value :  Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component

Returns

:Ext.data.Model

The associated record or null if there is none.

mapToRecordIndex ( value ) : Number

Converts the given parameter to the record's index in the store. Not all items in a dataview correspond to records (such as group headers in Ext.List). In these cases -1 is returned.

An "item" can be simply an element or a component depending on the type of dataview.

An input index value is a view index. These will only match the record's index in the store when no extra items are added to this dataview (so called "non-record" items). These are often unaligned in Ext.List due to group headers as well as infinite mode where not all records are rendered into the view at one time.

Negative index values are treated as relative to the end such that -1 is the last item, -2 is the next-to-last and so on.

Available since: 6.5.0

Parameters

value :  Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model

Returns

:Number

The record's index in the store or -1 if not found.

mapToViewIndex ( value ) : Number

Converts the given parameter to the equivalent record index in the store.

In this method alone, the index parameter is a store index not a view index.

Be aware that the Ext.List subclass can optionally render only some records, in which case not all records will have an associated item in the view and this method will return -1.

Negative index values are treated as relative to the end such that -1 is the last record, -2 is the next-to-last and so on.

An "item" can be simply an element or a component depending on the type of dataview.

The view index will only match the record's index in the store when no extra items are added to this dataview (so called "non-record" items). These are often unaligned in Ext.List due to group headers as well as infinite mode where not all records are rendered into the view at one time.

Available since: 6.5.0

Parameters

value :  Ext.event.Event/Number/HTMLElement/Ext.dom.Element/Ext.Component/Ext.data.Model

Returns

:Number

The view index or -1 if not found.

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.

nextItem ( item, [as] ) : Number/HTMLElement/Ext.dom.Element/Ext.Component

Returns the item following the passed item in the view. For infinite lists, this traversal can encounter unrendered records. In this case, the record index of the unrendered record is returned.

If as is specified, the item is converted to the desired form, if possible. If that conversion cannot be performed, null is returned.

Parameters

item :  Ext.dom.Element/Ext.Component

The item from which to navigate.

as :  "cmp"/"dom"/"el" (optional)

Pass "dom" to always return an HTMLElement for the item. For component dataviews this is the component's main element. Pass "el" to return the Ext.dom.Element form of the item. For component dataviews this will be the component's main element. For other dataviews the returned instance is produced by Ext.fly() and should not be retained. Pass "cmp" to return the Ext.Component reference for the item (if one exists).

Returns

:Number/HTMLElement/Ext.dom.Element/Ext.Component

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.

onNavigate ( e )

This method is called by the navigationModel when navigation events are detected within this DataView.

It may be overridden to control the linkage of navigation events such as taps, clicks or keystrokes detected by the navigationModel to the selectionModel.

callParent if you wish selection to proceed from the passed event.

Parameters

e :  Ext.event.Event

The UI event which caused the navigation.

prepareData ( data, index, record ) : Array/Object

Function which can be overridden to provide custom formatting for each Record that is used by this DataView's template to render each node.

Parameters

data :  Object/Object[]

The raw data object that was used to create the Record.

index :  Number

the index number of the Record being prepared for rendering.

record :  Ext.data.Model

The Record being prepared for rendering.

Returns

:Array/Object

The formatted data in a format expected by the internal template's overwrite() method. (either an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'}))

previousItem ( item, [as] ) : Number/HTMLElement/Ext.dom.Element/Ext.Component

Returns the item preceding the passed item in the view. For infinite lists, this traversal can encounter unrendered records. In this case, the record index of the unrendered record is returned.

If as is specified, the item is converted to the desired form, if possible. If that conversion cannot be performed, null is returned.

Parameters

item :  Ext.dom.Element/Ext.Component

The item from which to navigate.

as :  "cmp"/"dom"/"el" (optional)

Pass "dom" to always return an HTMLElement for the item. For component dataviews this is the component's main element. Pass "el" to return the Ext.dom.Element form of the item. For component dataviews this will be the component's main element. For other dataviews the returned instance is produced by Ext.fly() and should not be retained. Pass "cmp" to return the Ext.Component reference for the item (if one exists).

Returns

:Number/HTMLElement/Ext.dom.Element/Ext.Component

query ( [selector] ) : Ext.Component[]

Retrieves all descendant components which match the passed selector. Executes an Ext.ComponentQuery.query using this container as its root.

Parameters

selector :  String (optional)

Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned.

Returns

:Ext.Component[]

Components which matched the selector

queryBy ( fn, [scope] ) : Ext.Component[]

Retrieves all descendant components which match the passed function. The function should return false for components that are to be excluded from the selection.

Parameters

fn :  Function

The matcher function. It will be called with a single argument, the component being tested.

scope :  Object (optional)

The scope in which to run the function. If not specified, it will default to the active component.

Returns

:Ext.Component[]

Components matched by the passed function

queryById ( id ) : Ext.Component

Finds a component at any level under this container matching the id/itemId. This is a shorthand for calling ct.down('#' + id);

Parameters

id :  String

The id to find

Returns

:Ext.Component

The matching id, null if not found

refresh

Refreshes the view by reloading the data from the store and re-rendering the template.

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.

scrollToRecord ( record, [animate], [overscroll] )

Scrolls the list so that the specified record is at the top. <-- NO. Scroll into view. === TODO: fix scrollTo API

Parameters

record :  Ext.data.Model

Record in the store to scroll to.

animate :  Boolean (optional)

Determines if scrolling is animated.

Defaults to: false

overscroll :  Boolean (optional)

Determines if list can be overscrolled.

Defaults to: true

setActiveItem ( activeItem )

Returns the value of activeItem

setAlwaysOnTop ( alwaysOnTop )

Returns the value of alwaysOnTop

setAriaAttributes ( ariaAttributes )

Returns the value of ariaAttributes

setAutoDestroy ( autoDestroy )

Returns the value of autoDestroy

setAutoSize ( autoSize )

Returns the value of autoSize

setAxisLock ( axisLock )

Returns the value of axisLock

setBorder ( border )

Returns the value of border

setBottom ( bottom )

Returns the value of bottom

setBufferSize ( bufferSize )

Returns the value of bufferSize

setCentered ( centered )

Returns the value of centered

setCls ( cls )

Returns the value of cls

setColumnLines ( columnLines )

Returns the value of columnLines

setColumnMenu ( columnMenu )

Returns the value of columnMenu

setColumns ( columns )

Returns the value of columns

setConstrainAlign ( constrainAlign )

Returns the value of constrainAlign

setContainer ( container )

Returns the value of container

setContentEl ( contentEl )

Returns the value of contentEl

setControl ( control )

Returns the value of control

setData ( data )

Returns the value of data

setDefaultFocus ( defaultFocus )

Returns the value of defaultFocus

setDefaultType ( defaultType )

Returns the value of defaultType

setDefaults ( defaults )

Returns the value of defaults

setDisabled ( disabled )

Returns the value of disabled

setDisclosureProperty ( disclosureProperty )

Returns the value of disclosureProperty

setDisplayed ( displayed )

Returns the value of displayed

setDocked ( docked )

Returns the value of docked

setDraggable ( draggable )

Returns the value of draggable

setEmptyText ( emptyText )

Returns the value of emptyText

setEnableTextSelection ( enableTextSelection )

Returns the value of enableTextSelection

setFlex ( flex )

Returns the value of flex

setFloated ( floated )

Returns the value of floated

setGroupHeaderTpl ( groupHeaderTpl )

Returns the value of groupHeaderTpl

setGrouped ( grouped )

Returns the value of grouped

setHeight ( height )

Returns the value of height

setHidden ( hidden )

Returns the value of hidden

setHideAnimation ( hideAnimation )

Returns the value of hideAnimation

setHideHeaders ( hideHeaders )

Returns the value of hideHeaders

setHideMode ( hideMode )

Returns the value of hideMode

setHideOnMaskTap ( hideOnMaskTap )

Returns the value of hideOnMaskTap

setHtml ( html )

Returns the value of html

setIndexBar ( indexBar )

Returns the value of indexBar

setInline ( inline )

Returns the value of inline

setInnerCls ( innerCls )

Returns the value of innerCls

setItemCls ( itemCls )

Returns the value of itemCls

setItemConfig ( itemConfig )

Returns the value of itemConfig

setItemContentCls ( itemContentCls )

Returns the value of itemContentCls

setItemDataMap ( itemDataMap )

Returns the value of itemDataMap

setItemHeight ( itemHeight )

Returns the value of itemHeight

setItemId ( itemId )

Returns the value of itemId

setItemInnerCls ( itemInnerCls )

Returns the value of itemInnerCls

setItemRipple ( itemRipple )

Returns the value of itemRipple

setItems ( items )

Returns the value of items

setKeyMap ( keyMap )

Returns the value of keyMap

setKeyMapEnabled ( keyMapEnabled )

Returns the value of keyMapEnabled

setLayout ( layout )

Returns the value of layout

setLeft ( left )

Returns the value of left

setLeftAxisCellConfig ( leftAxisCellConfig )

Returns the value of leftAxisCellConfig

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

setLoadingHeight ( loadingHeight )

Returns the value of loadingHeight

setMargin ( margin )

Returns the value of margin

setMasked ( masked )

Returns the value of masked

setMatrix ( matrix )

Returns the value of matrix

setMaxHeight ( maxHeight )

Returns the value of maxHeight

setMaxItemCache ( maxItemCache )

Returns the value of maxItemCache

setMaxWidth ( maxWidth )

Returns the value of maxWidth

setMinHeight ( minHeight )

Returns the value of minHeight

setMinWidth ( minWidth )

Returns the value of minWidth

setModal ( modal )

Returns the value of modal

setMultiColumnSort ( multiColumnSort )

Returns the value of multiColumnSort

setOnItemDisclosure ( onItemDisclosure )

Returns the value of onItemDisclosure

setPadding ( padding )

Returns the value of padding

setPinHeaders ( pinHeaders )

Returns the value of pinHeaders

setPlugins ( plugins )

Returns the value of plugins

setPreventSelectionOnDisclose ( preventSelectionOnDisclose )

Returns the value of preventSelectionOnDisclose

setRefreshHeightOnUpdate ( refreshHeightOnUpdate )

Returns the value of refreshHeightOnUpdate

setRelative ( relative )

Returns the value of relative

setRight ( right )

Returns the value of right

setRipple ( ripple )

Returns the value of ripple

setRowLines ( rowLines )

Returns the value of rowLines

setScrollDock ( scrollDock )

Returns the value of scrollDock

setScrollToTopOnRefresh ( scrollToTopOnRefresh )

Returns the value of scrollToTopOnRefresh

setScrollable ( scrollable )

Returns the value of scrollable

setSelectable ( selectable )

Returns the value of selectable

setSelfAlign ( selfAlign )

Returns the value of selfAlign

setShadow ( shadow )

Returns the value of shadow

setShim ( shim )

Returns the value of shim

setShowAnimation ( showAnimation )

Returns the value of showAnimation

setSortable ( sortable )

Returns the value of sortable

setStriped ( striped )

Returns the value of striped

setStyle ( style )

Returns the value of style

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

setTitle ( title )

Returns the value of title

setToFrontOnShow ( toFrontOnShow )

Returns the value of toFrontOnShow

setTooltip ( tooltip )

Returns the value of tooltip

setTop ( top )

Returns the value of top

setTopAxisCellConfig ( topAxisCellConfig )

Returns the value of topAxisCellConfig

setTpl ( tpl )

Returns the value of tpl

setTplWriteMode ( tplWriteMode )

Returns the value of tplWriteMode

setUseSimpleItems ( useSimpleItems )

Returns the value of useSimpleItems

setUserSelectable ( userSelectable )

Returns the value of userSelectable

setWeight ( weight )

Returns the value of weight

setWidth ( width )

Returns the value of width

setX ( x )

Returns the value of x

setY ( y )

Returns the value of y

setZIndex ( zIndex )

Returns the value of zIndex

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

visitPostOrder ( selector, fn, [scope], [extraArgs] )

Traverses the tree rooted at this node in post-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node after being called on its children).

This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.

If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.

Parameters

selector :  Object

A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.

fn :  Function

The function to call. Return false to aborl the traverse.

node :  Object

The node being visited.

scope :  Object (optional)

The context (this reference) in which the function is executed.

extraArgs :  Array (optional)

A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.

visitPreOrder ( selector, fn, [scope], [extraArgs] )

Traverses the tree rooted at this node in pre-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node before being called on its children).

This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.

If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.

Parameters

selector :  Object

A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.

fn :  Function

The function to call. Return false to aborl the traverse.

node :  Object

The node being visited.

scope :  Object (optional)

The context (this reference) in which the function is executed.

extraArgs :  Array (optional)

A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.

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

onActivate : function ( 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.

onActiveItemChange : function ( 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.

onAdded : function ( 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.

onBeforeActiveItemChange : function ( 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.

onBeforeBottomChange : function ( 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.

onBeforeCenteredChange : function ( 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.

onBeforeDisabledChange : function ( 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.

onBeforeDockedChange : function ( 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.

onBeforeflexChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when flex changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String/Object

The current value of flex.

oldValue :  Number/String/Object

The previous value of flex.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

onBeforeHeightChange : function ( 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.

onBeforeHiddenChange : function ( 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.

onBeforeHide : function ( 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.

onBeforeLeftChange : function ( 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.

onBeforeMaxHeightChange : function ( 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.

onBeforeMaxWidthChange : function ( 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.

onBeforeMinHeightChange : function ( 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.

onBeforeMinWidthChange : function ( 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.

onBeforeRightChange : function ( 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.

onBeforeScrollableChange : function ( 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.

onBeforeSelectionextEnd : function ( grid, An, extension, eOpts )

An event fired when an extension block is extended using a drag gesture. Only fired when the grid's cfg!selectable is configured with the extensible config.

Parameters

grid :  Ext.grid.Grid

The owning grid.

An :  Ext.dataview.selection.Selection

object which encapsulates a contiguous selection block.

extension :  Object

An object describing the type and size of extension.

type :  String

"rows" or "columns"

start :  Ext.grid.Location

The start (top left) cell of the extension area.

end :  Ext.grid.Location

The end (bottom right) cell of the extension area.

columns :  Number (optional)

The number of columns extended (-ve means on the left side).

rows :  Number (optional)

The number of rows extended (-ve means on the top side).

eOpts : Object

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

onBeforeShow : function ( 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.

onBeforeTopChange : function ( 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.

onBeforeWidthChange : function ( 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.

onBlur : function ( 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.

onBottomChange : function ( 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.

onCenteredChange : function ( 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.

onColumnAdd : function ( this, column, index, eOpts )

Fires whenever a column is added to the Grid.

Parameters

this :  Ext.grid.Grid

The Grid instance.

column :  Ext.grid.column.Column

The added column.

index :  Number

The index of the added column.

eOpts : Object

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

onColumnHide : function ( this, column, eOpts )

Fires whenever a column is hidden in the Grid.

Parameters

this :  Ext.grid.Grid

The Grid instance.

column :  Ext.grid.column.Column

The shown column.

eOpts : Object

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

onColumnMenuCreated : function ( grid, column, menu, eOpts )

Fired when a column first creates its column menu. This is to allow plugins to access and manipulate the column menu.

There will be the two sort items, and a column hide/show item with a child menu of checkboxes. After this, developers may add custom enu items.

Menu items may be configured with a weight config, and those with the lowest weight gravitate to the top.

The sort ascending, sort descending, and hide columns items have weight -3, -2, and -1

Parameters

grid :  Ext.grid.Grid

This Grid

column :  Ext.grid.Column

The column creating the menu

menu :  Ext.menu.Menu

The column's new menu

eOpts : Object

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

onColumnMove : function ( this, column, fromIndex, toIndex, eOpts )

Fires whenever a column is moved in the grid.

Parameters

this :  Ext.grid.Grid

The Grid instance.

column :  Ext.grid.column.Column

The moved column.

fromIndex :  Number

The index the column was moved from.

toIndex :  Number

The index the column was moved to.

eOpts : Object

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

onColumnRemove : function ( this, column, eOpts )

Fires whenever a column is removed from the Grid.

Parameters

this :  Ext.grid.Grid

The Grid instance.

column :  Ext.grid.column.Column

The removed column.

eOpts : Object

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

onColumnResize : function ( this, column, width, eOpts )

Fires whenever a column is resized in the Grid.

Parameters

this :  Ext.grid.Grid

The Grid instance.

column :  Ext.grid.column.Column

The resized column.

width :  Number

The new column width.

eOpts : Object

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

onColumnShow : function ( this, column, eOpts )

Fires whenever a column is shown in the Grid.

Parameters

this :  Ext.grid.Grid

The Grid instance.

column :  Ext.grid.column.Column

The shown column.

eOpts : Object

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

onColumnSort : function ( this, column, direction, eOpts )

Fires whenever a column is sorted in the Grid.

Parameters

this :  Ext.grid.Grid

The Grid instance.

column :  Ext.grid.column.Column

The sorted column.

direction :  String

The direction of the sort on this Column. Either 'asc' or 'desc'.

eOpts : Object

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

onDeactivate : function ( 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.

onDeselect : function ( this, records, eOpts )

Fires whenever an item is deselected

Parameters

this :  Ext.dataview.DataView

records :  Ext.data.Model[]

The records being deselected

eOpts : Object

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

onDestroy

Fires when the component is destroyed

onDisabledChange : function ( 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.

onDisclose : function ( this, record, target, index, e, eOpts )
preventable prev

Fires whenever a disclosure is handled

Parameters

this :  Ext.dataview.List

The List instance

record :  Ext.data.Model

The record associated to the item

target :  HTMLElement

The element disclosed

index :  Number

The index of the item disclosed

e :  Ext.EventObject

The event object

eOpts : Object

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

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onDockedChange : function ( 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.

onErased : function ( 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.

onFlexChange : function ( sender, value, oldValue, eOpts )

This event fires when flex changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String/Object

The current value of flex.

oldValue :  Number/String/Object

The previous value of flex.

eOpts : Object

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

onFocus : function ( 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.

onFocusEnter : function ( 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.

onFocusLeave : function ( 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.

onFullscreen : function ( 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.

onHeightChange : function ( 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.

onHiddenChange : function ( 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.

onHide : function ( 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.

onInitialize : function ( 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.

onItemAction : function ( this, index, record, action, eOpts )

Fires whenever a swipe action has been triggered from a list item.

Parameters

this :  Ext.dataview.List

index :  Number

The index of the swipped item.

record :  Ext.data.Model

The record associated to the item.

action :  String

The triggered action key.

eOpts : Object

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

onLeftChange : function ( 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.

onMaxHeightChange : function ( 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.

onMaxWidthChange : function ( 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.

onMinHeightChange : function ( 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.

onMinWidthChange : function ( 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.

onMoved : function ( 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.

onNavigate : function ( this, to, from, eOpts )

Fires whenever the user navigates to a new location.

In regular dataviews, a location encapsulates one view item, and its associated record.

In grids, a location encapsulates one cell, and its associated data field.

Parameters

this :  Ext.dataview.DataView

to :  Ext.dataview.Location

The location navigated to.

from :  Ext.dataview.Location

The location where navigation came from.

eOpts : Object

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

onPainted : function ( 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.

onPivotBeforeReconfigure : function ( matrix, config, eOpts )

Fires before the matrix is reconfigured.

Return false to stop reconfiguring the matrix.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

config :  Object

Object used to reconfigure the matrix

eOpts : Object

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

onPivotBeforeRequest : function ( matrix, params, eOpts )

Available only when using a Ext.pivot.matrix.Remote matrix. Fires before requesting data from the server side. Return false if you don't want to make the Ajax request.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

params :  Object

Params sent by the Ajax request

eOpts : Object

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

onPivotBuildTotals : function ( matrix, totals, eOpts )

Fires before grand total records are created in the pivot store. Push additional objects to the array if you need to create additional grand totals.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

totals :  Array

Array of objects that will be used to create grand total records in the pivot store. Each object should have:

title :  String

Name your grand total

values :  Object

Values used to generate the pivot store record

eOpts : Object

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

onPivotColumnsBuilt : function ( matrix, columns, eOpts )

Fires after the matrix built the columns.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

columns :  Array

The built columns

eOpts : Object

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

onPivotDone : function ( matrix, eOpts )

Fires when the matrix finished processing the records

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

eOpts : Object

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

onPivotGroupCellDoubleTap : function ( params, e, eOpts )

Fires when a double tap is detected on a pivot group cell. The pivot group cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

topKey :  String

Key of the top axis item

topItem :  Ext.pivot.axis.Item

Top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotGroupCellTap : function ( params, e, eOpts )

Fires when a tap is detected on a pivot group cell. The pivot group cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

topKey :  String

Key of the top axis item

topItem :  Ext.pivot.axis.Item

Top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotGroupCellTapHold : function ( params, e, eOpts )

Fires when a tap hold is detected on a pivot group cell. The pivot group cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

topKey :  String

Key of the top axis item

topItem :  Ext.pivot.axis.Item

Top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotGroupCollapse : function ( matrix, type, group, eOpts )

Fires when a pivot group is collapsed. Could be a row or col pivot group.

The same event is fired when all groups are collapsed but no group param is provided.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

type :  String

Either 'row' or 'col'

group :  Ext.pivot.axis.Item

The axis item

eOpts : Object

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

onPivotGroupDoubleTap : function ( params, e, eOpts )

Fires when a double tap is detected on a pivot group element. The pivot group element is the one that belongs to the columns generated for the left axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotGroupExpand : function ( matrix, type, group, eOpts )

Fires when a pivot group is expanded. Could be a row or col pivot group.

The same event is fired when all groups are expanded but no group param is provided.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

type :  String

Either 'row' or 'col'

group :  Ext.pivot.axis.Item

The axis item

eOpts : Object

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

onPivotGroupTap : function ( params, e, eOpts )

Fires when a tap is detected on a pivot group element. The pivot group element is the one that belongs to the columns generated for the left axis dimensions.

Return false if you want to prevent expanding/collapsing that group.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotGroupTapHold : function ( params, e, eOpts )

Fires when a tap hold is detected on a pivot group element. The pivot group element is the one that belongs to the columns generated for the left axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotItemCellDoubleTap : function ( params, e, eOpts )

Fires when a double tap is detected on a pivot item cell. The pivot item cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

topKey :  String

Key of the top axis item

topItem :  Ext.pivot.axis.Item

Top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotItemCellTap : function ( params, e, eOpts )

Fires when a tap is detected on a pivot item cell. The pivot item cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

topKey :  String

Key of the top axis item

topItem :  Ext.pivot.axis.Item

Top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotItemCellTapHold : function ( params, e, eOpts )

Fires when a tap hold is detected on a pivot item cell. The pivot item cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

topKey :  String

Key of the top axis item

topItem :  Ext.pivot.axis.Item

Top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotItemDoubleTap : function ( params, e, eOpts )

Fires when a double tap is detected on a pivot item element. The pivot item element is the one that belongs to the columns generated for the left axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotItemTap : function ( params, e, eOpts )

Fires when a tap is detected on a pivot item element. The pivot item element is the one that belongs to the columns generated for the left axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotItemTapHold : function ( params, e, eOpts )

Fires when a tap hold is detected on a pivot item element. The pivot item element is the one that belongs to the columns generated for the left axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

leftItem :  Ext.pivot.axis.Item

Left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotModelBuilt : function ( matrix, model, eOpts )

Fires after the matrix built the store model.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

model :  Ext.data.Model

The built model

eOpts : Object

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

onPivotProgress : function ( matrix, index, total, eOpts )

Fires during records processing.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

index :  Integer

Current index of record that is processed

total :  Integer

Total number of records to process

eOpts : Object

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

onPivotReconfigure : function ( matrix, config, eOpts )

Fires when the matrix is reconfigured.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

config :  Object

Object used to reconfigure the matrix

eOpts : Object

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

onPivotRecordBuilt : function ( matrix, record, eOpts )

Fires after the matrix built a pivot store record.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

record :  Ext.data.Model

The built record

eOpts : Object

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

onPivotRequestException : function ( matrix, response, eOpts )

Available only when using a Ext.pivot.matrix.Remote matrix. Fires if there was any Ajax exception or the success value in the response was false.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

response :  Object

The Ajax response object

eOpts : Object

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

onPivotStart : function ( matrix, eOpts )

Fires when the matrix starts processing the records.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

eOpts : Object

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

onPivotStoreBuilt : function ( matrix, store, eOpts )

Fires after the matrix built the pivot store.

Parameters

matrix :  Ext.pivot.matrix.Base

Reference to the Matrix object

store :  Ext.data.Store

The built store

eOpts : Object

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

onPivotTotalCellDoubleTap : function ( params, e, eOpts )

Fires when a double tap is detected on a pivot grand total cell. The pivot total cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

topKey :  String

Key of the top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotTotalCellTap : function ( params, e, eOpts )

Fires when a tap is detected on a pivot grand total cell. The pivot total cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

topKey :  String

Key of the top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotTotalCellTapHold : function ( params, e, eOpts )

Fires when a double tap is detected on a pivot grand total cell. The pivot total cell is the one that belongs to the columns generated for the top axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

topKey :  String

Key of the top axis item

dimensionId :  String

Id of the aggregate dimension

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotTotalDoubleTap : function ( params, e, eOpts )

Fires when a double tap is detected on a pivot grand total element. The pivot grand total element is the one that belongs to the columns generated for the left axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotTotalTap : function ( params, e, eOpts )

Fires when a tap is detected on a pivot grand total element. The pivot grand total element is the one that belongs to the columns generated for the left axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPivotTotalTapHold : function ( params, e, eOpts )

Fires when a tap hold is detected on a pivot grand total element. The pivot grand total element is the one that belongs to the columns generated for the left axis dimensions.

Parameters

params :  Object

Object with following configuration

grid :  PivotGrid

Pivot grid instance

cell :  GridCell

The target of the event

leftKey :  String

Key of the left axis item

column :  GridColumn

Column header object

e :  Ext.event.Event

Event object

eOpts : Object

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

onPositionedChange : function ( 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.

onRefresh : function ( this, eOpts )
preventable prev

Fires whenever the DataView is refreshed

Parameters

this :  Ext.dataview.DataView

eOpts : Object

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

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onRemoved : function ( 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.

onResize : function ( 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.

onRightChange : function ( 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.

onScrollableChange : function ( 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.

onSelect : function ( this, records, eOpts )

Fires whenever an item is selected

Parameters

this :  Ext.dataview.DataView

records :  Ext.data.Model[]

The records being selected

eOpts : Object

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

onSelectionExtenderDrag : function ( grid, An, extension, eOpts )

An event fired when an extension block is dragged to encompass a new range. Only fired when the grid's cfg!selectable is configured with the extensible config.

Parameters

grid :  Ext.grid.Grid

The owning grid.

An :  Ext.dataview.selection.Selection

object which encapsulates a contiguous selection block.

extension :  Object

An object describing the type and size of extension.

type :  String

"rows" or "columns"

overCell :  HTMLElement

The grid cell over which the mouse is being dragged.

start :  Ext.grid.Location

The start (top left) cell of the extension area.

end :  Ext.grid.Location

The end (bottom right) cell of the extension area.

columns :  Number (optional)

The number of columns extended (-ve means on the left side).

rows :  Number (optional)

The number of rows extended (-ve means on the top side).

eOpts : Object

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

onShow : function ( 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.

onTopChange : function ( 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.

onWidthChange : function ( 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.

theme variables

$dataview-background-color : color

DataView background-color

Defaults to:

$background-color

$dataview-default-ui : map

Parameters for the "default" DataView UI. Set to null to eliminate the UI from the CSS output.

$dataview-item-alt-background-color : color

background-color for striped DataView Items

Defaults to:

darken($dataitem-background-color, 2)

$dataview-item-background-color : color

DataView Item background-color

Defaults to:

$background-color

$dataview-item-border-color : color

DataView Item border-color

Defaults to:

null

$dataview-item-border-style : String

DataView Item border-style

Defaults to:

null

$dataview-item-border-width : Number

DataView Item border-width

Defaults to:

null

$dataview-item-color : color

DataView Item text color

Defaults to:

$color

$dataview-item-focused-outline-color : color

DataView Item outline-color when focused

Defaults to:

$base-color

$dataview-item-focused-outline-offset : Number

DataView Item outline-offset when focused

Defaults to:

-$dataview-item-focused-outline-width

$dataview-item-focused-outline-style : String

DataView Item outline-style when focused

Defaults to:

solid

$dataview-item-focused-outline-width : Number

DataView Item outline-width when focused

Defaults to:

1px

$dataview-item-font-family : String

DataView Item font-family

Defaults to:

$font-family

$dataview-item-font-size : Number

DataView Item font-size

Defaults to:

$font-size

$dataview-item-font-size-big : Number

DataView Item font-size in the big sizing scheme

Defaults to:

$font-size-big

$dataview-item-font-weight : String / Number

DataView Item font-weight

Defaults to:

$font-weight-normal

$dataview-item-hovered-background-color : color

DataView Item background-color when hovered

Defaults to:

mix(#fff, $base-light-color, 65%)

$dataview-item-hovered-border-color : color

DataView Item border-color when hovered

Defaults to:

null

$dataview-item-hovered-color : color

DataView Item text color when hovered

Defaults to:

null

$dataview-item-line-height : Number

DataView Item line-height

Defaults to:

16px