Ext.grid.column.Date xtype: datecolumn

dataIndex : String

bindable bind required req

The name of the field in the grid's Ext.data.Stores Ext.data.Model definition from which to draw the column's value.

Defaults to:

null

activeChildTabIndex : Number

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

Defaults to:

0

activeItem : Ext.Component / Object / String / Number

bindable bind

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 passed a string, it will be assumed to be a Ext.ComponentQuery selector. A number will reference an index or a Ext.Component instance may be passed as well. An object config will be created as a new component.

Defaults to:

0

align : String

bindable bind

Sets the alignment of the header and rendered columns. Possible values are: 'left', 'center', and 'right'.

Defaults to:

'left'

alignSelf : String

bindable bind

Specifies the self alignment of this widget in a box layout

Defaults to:

null

allowFocusingDisabledChildren : Boolean

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

Defaults to:

false

alwaysOnTop : Boolean / Number

bindable bind

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

bindable bind

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

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

Defaults to:

null

ariaDescribedBy : String

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

ariaLabel : String

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

ariaLabelledBy : String

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

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

autoDestroy : Boolean

bindable bind

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

Defaults to:

true

autoSize : Boolean

bindable bind

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

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

Applications that experience performance issues in the affected versions of Safari may need to turn off autoSizing globally for all Ext.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 items 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.

Ext.create({
    xtype: 'container',
    renderTo: Ext.getBody(),
    height: 200,
    width: 200,
    style: 'background: green',
    items: [{
        xtype: 'component',
        style: 'background: yellow',
        height: '50%',
        width: '50%'
    }]
});

All browsers except for Safari render the previous example correctly, but Safari does not assign a height to the component. To make percentage-sized items 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

bindable bind

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

bind : Object / String

bindable bind

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

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

To dynamically add bindings:

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

To remove bindings:

 panel.setBind({
     title: null
 });

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

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

Defaults to:

null

bodyCls : String / String[]

bindable bind

The CSS class to add to this container's body element.

Defaults to:

null

Available since: 7.0

border : Boolean

bindable bind

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

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

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

Using style:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    style: 'border: 1px solid blue;'
    // ...
});

Using CSS:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    cls: 'my-component'
    // ...
});

And your CSS file:

.my-component {
    border: 1px solid red;
}

Defaults to:

null

bottom : Number / String

bindable bind

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

Defaults to:

null

cell : Object

bindable bind

The config object used to create Ext.grid.cell.Base for this column. By default, cells use the Ext.grid.cell.Cell xtype. To create a different type of cell, simply provide this config and the desired xtype.

Defaults to:

{
    xtype: 'gridcell'
}

centered : Boolean

bindable bind

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

Defaults to:

false

cls : String / String[]

bindable bind

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

Defaults to:

null

columns : Ext.grid.column.Column[]

bindable bind

The sub columns within this column/header container.

Defaults to:

null

computedWidth : Number

bindable bind readonly ro

The computed width for this column, may come from either width or flex.

Defaults to:

null

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

bindable bind

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

Defaults to:

null

contentEl : Ext.dom.Element / HTMLElement / String

bindable bind

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

Defaults to:

null

control : Object

bindable bind

Enables you to easily control Components inside this Container by listening to their events and taking some action. For example, if we had a container with a nested Disable button, and we wanted to hide the Container when the Disable button is tapped, we could do this:

Ext.create({
    xtype: 'container',
    control: {
       'button[text=Disable]': {
           tap: 'hideMe'
       }
    },

    hideMe: function() {
        this.hide();
    }
});

We used a Ext.ComponentQuery selector to listen to the tap event on any Ext.Button anywhere inside the Container that has the text 'Disable'. Whenever a Component matching that selector fires the tap event our hideMe function is called. hideMe is called with scope: this (e.g. this is the Container instance).

Defaults to:

null

controller : String / Object / Ext.app.ViewController

bindable bind

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

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

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

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

Defaults to:

null

data : Object

bindable bind

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

Note: Data will be appended to any existing data.

Defaults to:

null

defaultColumnUI

bindable bind

A default ui to use for Ext.grid.column.Column in this header.

Defaults to:

null

defaultEditor : Object / Ext.field.Field

bindable bind

An optional config object used to create a default editor for values in this column when no editor is specified. This config is typically defined by derived column classes such as Ext.grid.column.Date to tune the default editor.

This value is augmented by the editorDefaults config.

Defaults to:

{}

defaultFocus : String

bindable bind

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

defaultListenerScope : Boolean

bindable bind

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

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

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

Defaults to:

false

defaults : Object

bindable bind

A set of default configurations to apply to all child Components in this Container. It's often useful to specify defaults when creating more than one items with similar configurations. For example here we can specify that each child is a panel and avoid repeating the xtype declaration for each one:

Ext.create({
    xtype: 'container',
    defaults: {
        xtype: 'panel'
    },
    items: [
        {
            html: 'Panel 1'
        },
        {
            html: 'Panel 2'
        }
    ]
});

Defaults to:

null

defaultToolWeights : Object

bindable bind

The default weight for tools in the header.

Defaults to:

{
    toggle: 10,
    gear: 20,
    prev: 30,
    next: 40,
    left: 50,
    right: 60,
    down: 70,
    up: 80,
    refresh: 90,
    disclosure: 100,
    // was originally defined in ListItem
    plus: 100,
    minus: 110,
    search: 120,
    edit: 125,
    save: 130,
    print: 140,
    expand: 150,
    collapse: 160,
    help: 170,
    pin: 180,
    unpin: 190,
    minimize: 200,
    maximize: 210,
    restore: 220,
    close: 230,
    trash: 240
}

Available since: 6.5.0

defaultType : String

bindable bind

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

Defaults to:

container

defaultWidth : Number

bindable bind

A width to apply if the flex or width configurations have not been specified.

Defaults to:

100

Available since: 6.2.0

depends : String[]

bindable bind

Set this config to the field names that effect this column's rendering. This is important for best performance when using a renderer, a summaryRenderer or a tpl to render the cell's content. This is because such mechanisms can use any field and as such must be refreshed on any field change. When this config is provided, only changes to these fields (or the dataIndex) will cause a refresh.

When not using these mechanisms, only changes to the dataIndex will cause the cell content to be refreshed.

Defaults to:

null

Available since: 6.5.1

disabled : Boolean

bindable bind

Whether or not this component is disabled

Defaults to:

null

displayed : Boolean

bindable bind

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

bindable bind

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

Notes

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

<!doctype html>

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

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

Defaults to:

null

draggable : Boolean / Object / Ext.drag.Source

bindable bind

Set to true to allow this component to be dragged. This can also be the config object for the Ext.drag.Source that will manage the drag.

Defaults to:

null

editable : Boolean

bindable bind

Set this to true to make this column editable. Only applicable if the grid is using an Ext.grid.plugin.Editable plugin.

Defaults to:

null

editor : Object / String

bindable bind

The xtype or config object for a Ext.field.Field to use for editing. This config is used by the Ext.grid.plugin.Editable plugin.

If this config is not set, and editable is set to true, the defaultEditor is used.

Defaults to:

null

editorDefaults : Object

bindable bind

This object holds default config objects for creating the column's editor. The keys of this object are field type values (such as 'date' or 'int'). These keys can also be a comma-separated list of such type names.

These defaults are applied when producing an editor based on the field of store's model identified by the dataIndex.

See ensureEditor.

Defaults to:

{
    "default": {
        xtype: 'textfield',
        autoComplete: false,
        textAlign: undefined
    },
    'bool,boolean': {
        xtype: 'checkboxfield',
        bodyAign: undefined
    },
    date: {
        xtype: 'datefield',
        textAlign: undefined
    },
    'float,number': {
        xtype: 'numberfield',
        textAlign: undefined
    },
    'int,integer': {
        xtype: 'numberfield',
        decimals: 0,
        textAlign: undefined
    }
}

Available since: 7.0

exportRenderer : Boolean / Function / String

bindable bind

During data export via the Ext.grid.plugin.Exporter plugin the data for this column could be formatted in multiple ways:

• using the exportStyle.format
• using the formatter if no exportStyle is defined
• using the exportRenderer

If you want to use the renderer defined on this column then set exportRenderer to true. Beware that this should only happen if the renderer deals only with data on the record or value and it does NOT style the cell or returns an html string.

 {
     xtype: 'numbercolumn',
     dataIndex: 'price',
     text: 'Price',
     renderer: function(value, record, dataIndex, cell, column) {
         return Ext.util.Format.currency(value);
     },
     exportRenderer: true
 }

If you don't want to use the renderer during export but you still want to format the value in a special way then you can provide a function to exportRenderer or a string (which is a function name on the ViewController). The provided function has the same signature as the renderer.

 {
     xtype: 'numbercolumn',
     dataIndex: 'price',
     text: 'Price',
     exportRenderer: function(value, record, dataIndex, cell, column) {
         return Ext.util.Format.currency(value);
     }
 }


 {
     xtype: 'numbercolumn',
     dataIndex: 'price',
     text: 'Price',
     exportRenderer: 'exportAsCurrency' // this is a function on the ViewController
 }

If exportStyle.format, formatter and exportRenderer are all defined on the column then the exportStyle wins and will be used to format the data for this column.

Defaults to:

false

exportStyle : Ext.exporter.file.Style / Ext.exporter.file.Style[]

bindable bind

A style definition that is used during data export via the Ext.grid.plugin.Exporter. This style will be applied to the columns generated in the exported file.

You could define it as a single object that will be used by all exporters:

 {
     xtype: 'numbercolumn',
     dataIndex: 'price',
     exportStyle: {
         format: 'Currency',
         alignment: {
             horizontal: 'Right'
         },
         font: {
             italic: true
         }
     }
 }

You could also define it as an array of objects, each object having a type that specifies by which exporter will be used:

 {
     xtype: 'numbercolumn',
     dataIndex: 'price',
     exportStyle: [{
         type: 'html', // used by the html exporter
         format: 'Currency',
         alignment: {
             horizontal: 'Right'
         },
         font: {
             italic: true
         }
     },{
         type: 'csv', // used by the `csv` exporter
         format: 'General'
     }]
 }

Or you can define it as an array of objects that has:

• one object with no type key that is considered the style to use by all exporters

• objects with the type key defined that are exceptions of the above rule

  {

     xtype: 'numbercolumn',
     dataIndex: 'price',
     exportStyle: [{
         // no type defined means this is the default
         format: 'Currency',
         alignment: {
             horizontal: 'Right'
         },
         font: {
             italic: true
         }
     },{
         type: 'csv', // only the CSV exporter has a special style
         format: 'General'
     }]
  

  }

Defaults to:

null

exportSummaryRenderer : Boolean / Function / String

bindable bind

This config is similar to exportRenderer but is applied to summary records.

Defaults to:

false

filter : Object / Boolean

bindable bind

Defaults to:

null

filterType

bindable bind

A Ext.grid.plugin.filterbar.filters.Base configuration.

This filter type is used by the Ext.grid.plugin.filterbar.FilterBar plugin.

Defaults to:

null

flex : Number / String / Object

bindable bind

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
}

Defaults to:

null

floated : Boolean

bindable bind

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

focusableContainer : Boolean

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

focusCls : String

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

Defaults to:

'x-focused'

formatter : String

bindable bind

This config accepts a format specification as would be used in a Ext.Template formatted token. For example 'round(2)' to round numbers to 2 decimal places or 'date("Y-m-d")' to format a Date.

In previous releases the renderer config had limited abilities to use one of the Ext.util.Format methods but formatter now replaces that usage and can also handle formatting parameters.

When the value begins with "this." (for example, "this.foo(2)"), the implied scope on which "foo" is found is the scope config for the column.

If the scope is not given, or implied using a prefix of "this", then either the getController or the closest ancestor component configured as defaultListenerScope is assumed to be the object with the method.

Defaults to:

null

Available since: 6.2.0

fullscreen : Boolean

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

groupable : Boolean

bindable bind

If the grid is grouped, the menu for this column will offer to "Group by this column" if this is set to true.

If using the Ext.grid.plugin.ViewOptions plugin, this option may be used to disable the option to group by this column.

Defaults to:

true

grouper : Function / String / Object / Ext.util.Grouper

bindable bind

A grouper config object to apply when the standard grouping user interface is is invoked. This option is, for example, available in the column's header menu.

Note that a grouper may also be specified as a function which accepts two records to compare.

A Ext.app.ViewController method can be used like so:

 grouper: 'groupMethodName'

This is different then a sorter in that the grouper method is used to set the groupFn. This string returned by this method is used to determine group membership. To specify both the grpoupFn and the sorterFn:

 grouper: {
     groupFn: 'groupMethodName'
     sorterFn: 'sorterMethodName
 }

Defaults to:

null

Available since: 6.5.0

groupFormatter : String

bindable bind

This config accepts a format specification as would be used in a Ext.Template formatted token. For example 'round(2)' to round numbers to 2 decimal places or 'date("Y-m-d")' to format a Date.

It is used by the Ext.grid.plugin.GroupingPanel plugin when adding groupers to the store. When you drag a column from the grid to the grouping panel then the groupFormatter will be used to create a new store grouper Ext.util.Grouper#formatter.

Note: if summaries are calculated on the server side then the server side grouping should match the client side formatter otherwise the summaries may be wrong.

Defaults to:

false

groupHeaderTpl : String / String[] / Ext.XTemplate

bindable bind

This config allows a column to replace the default template supplied by the grid's groupHeader.tpl.

Defaults to:

null

Available since: 6.5.0

height : Number / String

bindable bind

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

Defaults to:

null

hidden : Boolean

bindable bind

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

Defaults to true for floated Components.

Defaults to:

null

hideable : Boolean

bindable bind

False to prevent the user from hiding this column.

Defaults to:

true

Available since: 6.5.0

hideAnimation : String / Mixed

bindable bind

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

Defaults to:

null

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

bindable bind

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

• 'clip' : Hide using clip.
• 'display' : Hide using display.
• 'offsets' : Hide using positioning offsets.
• 'opacity' : Hide using opacity.
• 'visibility' : Hide using visibility.

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

bindable bind

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

Defaults to:

null

html : String / Ext.dom.Element / HTMLElement

bindable bind

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

Defaults to:

null

id : String

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

ignore : Boolean

bindable bind

Setting to true prevents this column from being used by plugins such as Ext.grid.plugin.ViewOptions or Ext.grid.plugin.Summary. It is intended for special columns such as the row number or checkbox selection.

Defaults to:

false

ignoreExport : Boolean

bindable bind

This flag indicates that this column will be ignored when grid data is exported.

When grid data is exported you may want to export only some columns that are important and not everything. You can set this flag on any column that you want to be ignored during export.

This is used by Ext.grid.plugin.Exporter.

Defaults to:

false

inactiveChildTabIndex : Number

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

innerCls : String

bindable bind

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

itemId : String

bindable bind

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

Defaults to:

undefined

items : Array / Object

bindable bind

The child items to add to this Container. This is usually an array of Component configurations or instances, for example:

Ext.create({
    xtype: 'container',
    items: [{
        xtype: 'panel',
        html: 'This is an item'
    }]
});

This may also be specified as an object, the property names of which are itemIds, and the property values are child Component config objects, for example:

Ext.create({
    xtype: 'tabpanel',
    items: {
        panel1: {
            xtype: 'panel',
            title: 'First panel'
        },
        panel2: {
            xtype: 'panel',
            title: 'Second panel'
        }
    }
});

Defaults to:

null

keyMap : Object

bindable bind

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

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

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

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

Defaults to:

null

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

bindable bind

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

Defaults to:

null

layout : Object / String

bindable bind

Configuration for this Container's layout. Example:

Ext.create({
    xtype: 'container',
    layout: {
        type: 'hbox',
        align: 'middle'
    },
    items: [{
        xtype: 'panel',
        flex: 1,
        bodyStyle: {
            background: "#000",
            color:"#fff"
        }
    }, {
       xtype: 'panel',
       flex: 2,
       bodyStyle: {
           background: "#f00",
           color:"#fff"
       }
    }]
});

Defaults to:

'auto'

left : Number / String

bindable bind

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

Defaults to:

null

listeners : Object

bindable bind

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

DOM events from Ext JS Ext.Component

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

locked : Boolean / String

bindable bind

This config can be used with Locking Grid Determines whether the column is locked or not. Configure as true to lock the column to default locked region Ext.grid.locked.Grid String values contains one of the defined locking regions - "left", "right" or "center"

Defaults to:

null

margin : Number / String

bindable bind

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

Defaults to:

null

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

bindable bind

A configuration to allow you to mask this container.

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

For more precise control over the mask, 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.

Ext.create({
    xtype: 'container',
    fullscreen: true,
    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, method-mask and unmask, to allow you to mask and unmask this container at any time.

Remember, the Ext.Viewport is always a container, so if you want to mask your whole application at anytime, can call:

Ext.Viewport.setMasked({
    xtype: 'loadmask',
    message: 'Hello'
});

Defaults to:

null

maxHeight : Number / String

bindable bind

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

Defaults to:

null

maxWidth : Number / String

bindable bind

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

Defaults to:

null

menu : Ext.menu.Menu / Object

bindable bind

An optional menu configuration object which is merged with the grid's columnMenu to create this column's header menu. This can be set to null to remove the menu from this column. To dynamically change whether the menu should be enabled or not use the menuDisabled config.

The grid's columnMenu provides the sort items, this config can be used to add column-specific menu items or override aspects of the common items.

Defaults to:

{}

Available since: 6.5.0

menuDisabled : Boolean

bindable bind

Set to true to disable this column's menu containing sort/hide options. This can be useful if the menu will be dynamically available since setting menu to null will eliminate the menu making dynamic changes to its availability more expensive.

Defaults to:

false

Available since: 6.5.0

minHeight : Number / String

bindable bind

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

Defaults to:

null

minWidth : Number / String

bindable bind

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

Defaults to:

null

modal : Boolean

bindable bind

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

Defaults to:

null

modelValidation : Boolean

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

name : String

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

Defaults to:

null

nameable : Boolean

Set to true for this component's name property to be tracked by its containing nameHolder.

Defaults to:

false

nameHolder : Boolean

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

Defaults to:

false

padding : Number / String

bindable bind

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

Defaults to:

null

plugins : Array / Ext.enums.Plugin / Object / Ext.plugin.Abstract

bindable bind

This config describes one or more plugin config objects used to create plugin instances for this component.

Plugins are a way to bundle and reuse custom functionality. Plugins should extend Ext.plugin.Abstract but technically the only requirement for a valid plugin is that it contain an init method that accepts a reference to its owner. Once a plugin is created, the owner will call the init method, passing a reference to itself. Each plugin can then call methods or respond to events on its owner as needed to provide its functionality.

This config's value can take several different forms.

The value can be a single string with the plugin's Ext.enums.Plugin:

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

     plugins: 'listpaging'
 });

In the above examples, the string "listpaging" is the type alias for Ext.dataview.plugin.ListPaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

The preferred form for multiple plugins or to configure plugins is the keyed-object form (new in version 6.5):

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

     plugins: {
         pullrefresh: true,
         listpaging: {
             autoPaging: true,
             weight: 10
         }
     }
 });

The object keys are the id's as well as the default type alias. This form allows the value of the plugins to be merged from base class to derived class and finally with the instance configuration. This allows classes to define a set of plugins that derived classes or instantiators can further configure or disable. This merge behavior is a feature of the config.

The plugins config can also be an array of plugin aliases (arrays are not merged so this form does not respect plugins defined by the class author):

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

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

An array can also contain elements that are config objects with a type property holding the type alias:

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

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

Defaults to:

null

publishes : String / String[] / Object

bindable bind

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

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

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

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

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

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

Classes must provide this config as an Object:

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

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

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

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

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

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

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

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

Defaults to:

null

Available since: 5.0.0

record : Ext.data.Model

bindable bind

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

Defaults to:

null

reference : String

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

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

Defaults to:

null

referenceHolder : Boolean

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

relative : Boolean

bindable bind

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

renderer : Function / String

bindable bind

A renderer is a method which can be used to transform data (value, appearance, etc.) before it is rendered.

For example:

 {
     text: 'Some column',
     dataIndex: 'fieldName',

     renderer: function(value, record) {
         if (value === 1) {
             return '1 person';
         }
         return value + ' people';
     }
 }

If a string is supplied, it should be the name of a renderer method from the appropriate Ext.app.ViewController.

This config is only processed if the cell type is the default of Ext.grid.cell.Cell.

Note See Ext.grid.Grid documentation for other, better alternatives to rendering cell content.

Defaults to:

null

Properties

value : Object

The data value for the current cell.

record : Ext.data.Model

The record for the current row.

dataIndex : Number

The dataIndex of the current column.

cell : Ext.grid.cell.Base

The current cell.

column : Ext.grid.column.Column

The current column.

return : String

The HTML string to be rendered. Note: to render HTML into the cell, you will have to configure the column's cell with encodeHtml: false

renderTo : Ext.dom.Element

bindable bind

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

Defaults to:

null

resetFocusPosition : Boolean

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

resizable : Boolean

bindable bind

False to prevent the column from being resizable. Note that this configuration only works when the Ext.grid.plugin.ColumnResizing plugin is enabled on the Ext.grid.Grid.

Defaults to:

true

right : Number / String

bindable bind

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

Defaults to:

null

ripple : Boolean / Object / String

bindable bind

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

Defaults to:

null

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.

scope : Object

bindable bind

The scope to use when calling the renderer or formatter function.

Defaults to:

null

scrollable : Boolean / String / Object

bindable bind

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

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

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

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

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

Defaults to:

null

session : Boolean / Object / Ext.data.Session

bindable bind

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

To create a new session you can specify true:

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

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

Alternatively, a config object can be provided:

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

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

Defaults to:

null

shadow : Boolean

bindable bind

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.

Defaults to:

null

Available since: 6.2.0

shareableName : Boolean

Set to true to allow this component's name to be shared by other items in the same nameHolder. Such items will be returned in an array from lookupName.

Defaults to:

false

shim : Boolean

bindable bind

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

bindable bind

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

Defaults to:

null

sortable : Boolean

bindable bind

False to disable sorting of this column. Whether local/remote sorting is used is specified in Ext.data.Store#remoteSort.

Defaults to:

true

sorter : Function / String / Object / Ext.util.Sorter

bindable bind

A sorter config object to apply when the standard sort user interface is is invoked. This is usually clicking this column header, but there are also menu options to sort ascending or descending.

Note that a sorter may also be specified as a function which accepts two records to compare.

A Ext.app.ViewController method can be used like so:

 sorter: 'sorterMethodName'

Or more explicitly:

 sorter: {
     sorterFn: 'sorterMethodName'
 }

By default sorting is based on the dataIndex but this can be adjusted like so:

 sorter: {
     property: 'otherProperty'
 }

Defaults to:

true

Available since: 6.5.0

stateful : Boolean / Object / String[]

bindable bind

This config specifies the config properties that will be persisted using the Ext.state.Provider. If this config is set to true, the configs specified by statefulDefaults will be assumed.

 stateful: true

Otherwise, this config can be an array of strings of the properties to save:

 stateful: [
     'width',
     'height',
     'collapsed'
 ]

The above is equivalent to:

 stateful: {
     width: true,
     height: true,
     collapsed: true
 }

Note: To be truly stateful, an id or stateId must also be assigned.

A stateful object will save its state when any of these config properties change value.

Defaults to:

false

stateId : String

bindable bind

The unique id for this object to use for state management purposes.

Defaults to:

null

style : String / Object

bindable bind

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

summaries : Object / String[]

bindable bind

This config is used by Ext.grid.plugin.Summaries plugin.

Define here what functions are available for your users to choose from when they want to change the summary type on this column. By default only count is supported but you can add more summary functions.

 {
     xtype: 'column',
     summaries: {
         sum: true,
         average: true,
         count: false
     }
 }

Or like this if you want to bring new functions in:

 {
     xtype: 'column',
     summaries: {
         calculateSomething: true
     }
 }

In such case calculateSomething needs to be defined as a summary function. For this you need to define a summary class like this:

 Ext.define('Ext.data.summary.CalculateSomething', {
     extend: 'Ext.data.summary.Base',
     alias: 'data.summary.calculateSomething',

     text: 'Calculate something',

     calculate: function (records, property, root, begin, end) {
         // do your own calculation here
     }
 });

Defaults to:

{
    count: true
}

summary : String

bindable bind

This config replaces the default mechanism of acquiring a summary result from the summary record. When specified, this string is the name of a summary type:

• Ext.data.summary.Average
• Ext.data.summary.Count
• Ext.data.summary.Max
• Ext.data.summary.Min
• Ext.data.summary.Sum

The summary is based on either the summaryDataIndex or the dataIndex if there is no summaryDataIndex.

This config is only valid when all data is available client-side to calculate summaries.

It is generally best to allow the summary Ext.data.Model to computer summary values (and not use this config). In some cases, however, this config can be useful to isolate summary calculations to only certain grids.

To implement a custom summary for a column, use summaryRenderer.

Defaults to:

null

Available since: 6.5.0

summaryCell : Object

bindable bind

The config object used to create Ext.grid.cell.Base in Ext.grid.SummaryRow for this column.

Defaults to:

null

summaryDataIndex : String

bindable bind

For Ext.grid.SummaryRow this config overrides the normal dataIndex to use from the summary record.

Defaults to:

null

Available since: 6.5.0

summaryFormatter : String

bindable bind

This summaryFormatter is similar to formatter but is called before displaying a value in the SummaryRow. The config is optional, if not specified the default calculated value is shown. The summaryFormatter is called with:

• value: The calculated value.

Note that this configuration only works when the grid has the Ext.grid.plugin.Summary plugin enabled.

Defaults to:

null

summaryRenderer : Function / String

bindable bind

This summaryRenderer is called to render the value to display in a cell of a summary row. If the value of this config is a String, it is the name of the renderer method on the associated controller.

Defaults to:

null

Properties

value : Mixed

The summary value to render. This value is retrieved from the summary record based on the summaryDataIndex or dataIndex, or by applying the summary algorithm to the appropriate records. While this value can be useful, it can also be ignored and the renderer method can use the context information to determine the value to render entirely on its own.

context : Object

The summary context object.

tabIndex : Number

bindable bind

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

text : String

bindable bind

The header text to be used as innerHTML (html tags are accepted) to display in the Grid.

Note: to have a clickable header with no text displayed you can use the default non-breaking space ( ).

Defaults to:

'\xa0'

toFrontOnShow : Boolean

bindable bind

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

Defaults to:

true

toolDefaults : Object

bindable bind

The properties of this object are shallow copied (via applyIf() as opposed to Ext.merge() to each tool declared in the tools config.

Defaults to:

{
    xtype: 'tool',
    zone: 'end'
}

tools : Ext.Tool[] / Object / Object[]

bindable bind

An array of Ext.Tool configs or an object keyed by itemId.

Defaults to:

null

tooltip : String / Object

bindable bind

The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or Ext.tip.ToolTip config object.

The default behavior is to use a shared tip instance. The tooltip configuration is registered with the Ext.tip.Manager. To enable this, your application can set the Ext.app.Application#quickTips config, or an instance of the Ext.tip.Manager may be created manually.

To force a unique tooltip instance to be created, specify autoCreate: true on this configuration.

Configuring this with autoHide: false implies autoCreate: true so that the desired persistent behavior can be obtained with other targets still showing the singleton instance.

Defaults to:

null

top : Number / String

bindable bind

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

Defaults to:

null

touchAction : Object

bindable bind

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