<ext-tree/> Ext.grid.Tree

columns : Ext.grid.column.Column[]

required req

<ext-tree columns="value" />

let element = document.body.querySelector('ext-tree');
element.columns = 'value';
let columns = element.columns;

An array of column definition objects which define all columns that appear in this grid. Each column definition provides the header text for the column, and a definition of where the data for that column comes from.

This can also be a configuration object for a {Ext.grid.header.Container HeaderContainer} which may override certain default configurations if necessary. For example, the special layout may be overridden to use a simpler layout, or one can set default values shared by all columns:

 columns: {
     items: [
         {
             text: "Column A"
             dataIndex: "field_A",
             width: 200
         },{
             text: "Column B",
             dataIndex: "field_B",
             width: 150
         },
         ...
     ]
 }

Defaults to:

null

store : Ext.data.Store / Object

required req

<ext-tree store="{ }" />

let element = document.body.querySelector('ext-tree');
element.store = { };
let store = element.store;

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.

Defaults to:

undefined

activeChildTabIndex : Number

immutable imm

<ext-tree activeChildTabIndex="10" />

let element = document.body.querySelector('ext-tree');
element.activeChildTabIndex = 10;
let activeChildTabIndex = element.activeChildTabIndex;

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

<ext-tree activeItem="value" />

let element = document.body.querySelector('ext-tree');
element.activeItem = 'value';
let activeItem = element.activeItem;

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

alignSelf : String

<ext-tree alignSelf="value" />

let element = document.body.querySelector('ext-tree');
element.alignSelf = 'value';
let alignSelf = element.alignSelf;

Specifies the self alignment of this widget in a box layout

Defaults to:

null

allowFocusingDisabledChildren : Boolean

immutable imm

<ext-tree allowFocusingDisabledChildren="true" />

let element = document.body.querySelector('ext-tree');
element.allowFocusingDisabledChildren = true;
let allowFocusingDisabledChildren = element.allowFocusingDisabledChildren;

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

Defaults to:

false

alwaysOnTop : Boolean / Number

<ext-tree alwaysOnTop="true" />

let element = document.body.querySelector('ext-tree');
element.alwaysOnTop = true;
let alwaysOnTop = element.alwaysOnTop;

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

<ext-tree ariaAttributes="{ }" />

let element = document.body.querySelector('ext-tree');
element.ariaAttributes = { };
let ariaAttributes = element.ariaAttributes;

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

immutable imm

<ext-tree ariaDescribedBy="value" />

let element = document.body.querySelector('ext-tree');
element.ariaDescribedBy = 'value';
let ariaDescribedBy = element.ariaDescribedBy;

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

<ext-tree ariaLabel="value" />

let element = document.body.querySelector('ext-tree');
element.ariaLabel = 'value';
let ariaLabel = element.ariaLabel;

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

<ext-tree ariaLabelledBy="value" />

let element = document.body.querySelector('ext-tree');
element.ariaLabelledBy = 'value';
let ariaLabelledBy = element.ariaLabelledBy;

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.

ariaRole : String

readonly ro

<ext-tree ariaRole="value" />

let element = document.body.querySelector('ext-tree');
let ariaRole = element.ariaRole;

ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set.

associatedData : Boolean / Object

<ext-tree associatedData="true" />

let element = document.body.querySelector('ext-tree');
element.associatedData = true;
let associatedData = element.associatedData;

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

<ext-tree autoDestroy="true" />

let element = document.body.querySelector('ext-tree');
element.autoDestroy = true;
let autoDestroy = element.autoDestroy;

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

Defaults to:

true

autoSize : Boolean

<ext-tree autoSize="true" />

let element = document.body.querySelector('ext-tree');
element.autoSize = true;
let autoSize = element.autoSize;

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:

null

axisLock : Boolean

<ext-tree axisLock="true" />

let element = document.body.querySelector('ext-tree');
element.axisLock = true;
let axisLock = element.axisLock;

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

<ext-tree bind="value" />

let element = document.body.querySelector('ext-tree');
element.bind = 'value';
let bind = element.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[]

<ext-tree bodyCls="value" />

let element = document.body.querySelector('ext-tree');
element.bodyCls = 'value';
let bodyCls = element.bodyCls;

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

Defaults to:

null

Available since: 7.0

border : Boolean

<ext-tree border="true" />

let element = document.body.querySelector('ext-tree');
element.border = true;
let border = element.border;

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

<ext-tree bottom="value" />

let element = document.body.querySelector('ext-tree');
element.bottom = 'value';
let bottom = element.bottom;

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

<ext-tree bufferSize="10" />

let element = document.body.querySelector('ext-tree');
element.bufferSize = 10;
let bufferSize = element.bufferSize;

The number of items an infinite list will render beyond those immediately visible.

To prevent the rendering of items while scrolling, these extra items are rendered out of view. When the scroller approaches within minimumBufferSize of the end of the rendered range, the extra items trailing the scroll will be repositioned (and reconfigured) ahead of the scroll.

Defaults to:

20

centered : Boolean

<ext-tree centered="true" />

let element = document.body.querySelector('ext-tree');
element.centered = true;
let centered = element.centered;

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

classCls

readonly ro

<ext-tree classCls="value" />

let element = document.body.querySelector('ext-tree');
element.classCls = 'value';
let classCls = element.classCls;

A CSS class to apply to the main element that will be inherited down the class hierarchy. Subclasses may override this property on their prototype to add their own CSS class in addition to the CSS classes inherited from ancestor classes via the prototype chain. For example

Ext.define('Foo', {
    extend: 'Ext.Widget',
    classCls: 'foo'
});

Ext.define('Bar', {
    extend: 'Foo',
    classCls: 'bar'
});

var bar = new Bar();

console.log(bar.element.className); // outputs 'foo bar'

Defaults to:

Ext.baseCSSPrefix + 'grid'

cls : String / String[]

<ext-tree cls="value" />

let element = document.body.querySelector('ext-tree');
element.cls = 'value';
let cls = element.cls;

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

collapseDefaults : Ext.dataview.ListCollapser / Object

<ext-tree collapseDefaults="{ }" />

let element = document.body.querySelector('ext-tree');
element.collapseDefaults = { };
let collapseDefaults = element.collapseDefaults;

This config object supplies default for the collapsible config. When that config is simply true, this is the complete config object for the group collapser.

NOTE: This config cannot be changed after instantiation. Instead, change the collapsible config.

Defaults to:

{
    xclass: 'Ext.dataview.ListCollapser'
}

Available since: 7.0

collapsible : Ext.dataview.ListCollapser / Object / Boolean

<ext-tree collapsible="true" />

let element = document.body.querySelector('ext-tree');
element.collapsible = true;
let collapsible = element.collapsible;

This object configures group collapse. It is only applicable when grouped. Set to false to disable group collapsibility. The default value of true uses the collapseDefaults config for the final collapser configuration object. If this config is an object, it is merged with collapseDefaults giving this object's properties priority over the defaults.

Defaults to:

true

Available since: 7.0

columnLines : Boolean

<ext-tree columnLines="true" />

let element = document.body.querySelector('ext-tree');
element.columnLines = true;
let columnLines = element.columnLines;

Configure as true to display lines between grid cells.

Defaults to:

false

columnMenu : Object

<ext-tree columnMenu="{ }" />

let element = document.body.querySelector('ext-tree');
element.columnMenu = { };
let columnMenu = element.columnMenu;

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.

Defaults to:

{
    xtype: 'menu',
    weighted: true,
    align: 'tl-bl?',
    hideOnParentHide: false,
    // Persists when owning Column is hidden
    items: {
        sortAsc: {
            xtype: 'gridsortascmenuitem',
            group: 'sortDir',
            weight: -100
        },
        // Wants to be the first
        sortDesc: {
            xtype: 'gridsortdescmenuitem',
            group: 'sortDir',
            weight: -90
        },
        // Wants to be the second
        //---------------------------------
        // Columns menu is inserted here
        //---------------------------------
        groupByThis: {
            xtype: 'gridgroupbythismenuitem',
            handler: 'column.onGroupByThis',
            separator: true,
            weight: -50
        },
        showInGroups: {
            xtype: 'gridshowingroupsmenuitem',
            handler: 'column.onToggleShowInGroups',
            weight: -40
        }
    }
}

columnResize : Boolean

<ext-tree columnResize="true" />

let element = document.body.querySelector('ext-tree');
element.columnResize = true;
let columnResize = element.columnResize;

Set to false to disable column resizing within this grid.

Defaults to:

true

columnsMenuItem : <ext-gridcolumnsmenu/>

<ext-tree columnsMenuItem="value" />

let element = document.body.querySelector('ext-tree');
element.columnsMenuItem = 'value';
let columnsMenuItem = element.columnsMenuItem;

The config object for the grid's column hide/show menu

Defaults to:

{
    xtype: 'gridcolumnsmenu',
    weight: -80,
    separator: true
}

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

<ext-tree constrainAlign="value" />

let element = document.body.querySelector('ext-tree');
element.constrainAlign = 'value';
let constrainAlign = element.constrainAlign;

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

containsFocus : Boolean

readonly ro

<ext-tree containsFocus="true" />

let element = document.body.querySelector('ext-tree');
let containsFocus = element.containsFocus;

true if this currently focused element is within this Component's or Container's hierarchy. This property is set separately from hasFocus, and can be true when hasFocus is false.

Examples:

• Text field with input element focused would be: focusable: true, hasFocus: true, containsFocus: true

• Date field with drop-down picker currently focused would be: focusable: true, hasFocus: false, containsFocus: true

• Form Panel with a child input field currently focused would be: focusable: false, hasFocus: false, containsFocus: true

See also hasFocus.

Defaults to:

false

contentEl : Ext.dom.Element / HTMLElement / String

<ext-tree contentEl="value" />

let element = document.body.querySelector('ext-tree');
element.contentEl = 'value';
let contentEl = element.contentEl;

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

controller : String / Object / Ext.app.ViewController

<ext-tree controller="value" />

let element = document.body.querySelector('ext-tree');
element.controller = 'value';
let controller = element.controller;

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

<ext-tree data="{ }" />

let element = document.body.querySelector('ext-tree');
element.data = { };
let data = element.data;

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

defaultBindProperty : String

readonly ro

<ext-tree defaultBindProperty="value" />

let element = document.body.querySelector('ext-tree');
element.defaultBindProperty = 'value';
let defaultBindProperty = element.defaultBindProperty;

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

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

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

Defaults to:

'store'

defaultFocus : String

<ext-tree defaultFocus="value" />

let element = document.body.querySelector('ext-tree');
element.defaultFocus = 'value';
let defaultFocus = element.defaultFocus;

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

<ext-tree defaultListenerScope="true" />

let element = document.body.querySelector('ext-tree');
element.defaultListenerScope = true;
let defaultListenerScope = element.defaultListenerScope;

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

<ext-tree defaults="{ }" />

let element = document.body.querySelector('ext-tree');
element.defaults = { };
let defaults = element.defaults;

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

deferEmptyText : Boolean

<ext-tree deferEmptyText="true" />

let element = document.body.querySelector('ext-tree');
element.deferEmptyText = true;
let deferEmptyText = element.deferEmptyText;

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

Defaults to:

true

deselectOnContainerClick : Boolean

<ext-tree deselectOnContainerClick="true" />

let element = document.body.querySelector('ext-tree');
element.deselectOnContainerClick = true;
let deselectOnContainerClick = element.deselectOnContainerClick;

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

destroyed : Boolean

readonly ro

<ext-tree destroyed="true" />

let element = document.body.querySelector('ext-tree');
element.destroyed = true;
let destroyed = element.destroyed;

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

Defaults to:

false

disableSelection : Boolean

<ext-tree disableSelection="true" />

let element = document.body.querySelector('ext-tree');
element.disableSelection = true;
let disableSelection = element.disableSelection;

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

<ext-tree disabled="true" />

let element = document.body.querySelector('ext-tree');
element.disabled = true;
let disabled = element.disabled;

Whether or not this component is disabled

Defaults to:

null

disclosureProperty : String

<ext-tree disclosureProperty="value" />

let element = document.body.querySelector('ext-tree');
element.disclosureProperty = 'value';
let disclosureProperty = element.disclosureProperty;

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

<ext-tree displayed="true" />

let element = document.body.querySelector('ext-tree');
element.displayed = true;
let displayed = element.displayed;

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

<ext-tree docked="value" />

let element = document.body.querySelector('ext-tree');
element.docked = 'value';
let docked = element.docked;

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

<ext-tree draggable="true" />

let element = document.body.querySelector('ext-tree');
element.draggable = true;
let draggable = element.draggable;

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

emptyItemText : String

<ext-tree emptyItemText="value" />

let element = document.body.querySelector('ext-tree');
element.emptyItemText = 'value';
let emptyItemText = element.emptyItemText;

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

Defaults to:

'\xa0'

emptyText : String / Boolean

<ext-tree emptyText="true" />

let element = document.body.querySelector('ext-tree');
element.emptyText = true;
let emptyText = element.emptyText;

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

Defaults to:

null

emptyTextDefaults : Object / <ext-component/>

<ext-tree emptyTextDefaults="{ }" />

let element = document.body.querySelector('ext-tree');
element.emptyTextDefaults = { };
let emptyTextDefaults = element.emptyTextDefaults;

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

Defaults to:

{
    xtype: 'emptytext'
}

Available since: 6.5.0

emptyTextProperty : String

immutable imm

<ext-tree emptyTextProperty="value" />

let element = document.body.querySelector('ext-tree');
element.emptyTextProperty = 'value';
let emptyTextProperty = element.emptyTextProperty;

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

Defaults to:

'html'

Available since: 6.5.0

enableColumnMove : Boolean

<ext-tree enableColumnMove="true" />

let element = document.body.querySelector('ext-tree');
element.enableColumnMove = true;
let enableColumnMove = element.enableColumnMove;

Set to false to disable column reorder.

Note: if gridviewoptions plugin is enabled on grids gets precedence over enableColumnMove for touch supported device.

Defaults to:

true

factoryConfig : Object

readonly ro

<ext-tree factoryConfig="{ }" />

let element = document.body.querySelector('ext-tree');
element.factoryConfig = { };
let factoryConfig = element.factoryConfig;

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

<ext-tree flex="value" />

let element = document.body.querySelector('ext-tree');
element.flex = 'value';
let flex = element.flex;

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

<ext-tree floated="true" />

let element = document.body.querySelector('ext-tree');
element.floated = true;
let floated = element.floated;

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

floatingCls : String

readonly ro

<ext-tree floatingCls="value" />

let element = document.body.querySelector('ext-tree');
element.floatingCls = 'value';
let floatingCls = element.floatingCls;

The CSS class to add to this component when it is floated at the viewport level.

Defaults to:

Ext.baseCSSPrefix + 'floating'

focusCls : String

immutable imm

<ext-tree focusCls="value" />

let element = document.body.querySelector('ext-tree');
element.focusCls = 'value';
let focusCls = element.focusCls;

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

<ext-tree focusClsEl="value" />

let element = document.body.querySelector('ext-tree');
element.focusClsEl = 'value';
let focusClsEl = element.focusClsEl;

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

focusEl : Ext.dom.Element

readonly ro

<ext-tree focusEl="value" />

let element = document.body.querySelector('ext-tree');
element.focusEl = 'value';
let focusEl = element.focusEl;

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'

focusable : Boolean

readonly ro

<ext-tree focusable="true" />

let element = document.body.querySelector('ext-tree');
element.focusable = true;
let focusable = element.focusable;

true for keyboard interactive Components or Widgets, false otherwise. For Containers, this property reflects interactiveness of the Container itself, not its children. See isFocusable.

Note: It is not enough to set this property to true to make a component keyboard interactive. You also need to make sure that the component's focusEl is reachable via Tab key (tabbable). See also tabIndex.

Defaults to:

true

focusableContainer : Boolean

immutable imm

<ext-tree focusableContainer="true" />

let element = document.body.querySelector('ext-tree');
element.focusableContainer = true;
let focusableContainer = element.focusableContainer;

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

<ext-tree focusableContainerEl="value" />

let element = document.body.querySelector('ext-tree');
element.focusableContainerEl = 'value';
let focusableContainerEl = element.focusableContainerEl;

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

<ext-tree fullscreen="true" />

let element = document.body.querySelector('ext-tree');
element.fullscreen = true;
let fullscreen = element.fullscreen;

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

groupFooter : Object / <ext-itemheader/>

<ext-tree groupFooter="{ }" />

let element = document.body.querySelector('ext-tree');
element.groupFooter = { };
let groupFooter = element.groupFooter;

The counterpart to groupHeader, this config controls the footer that is displayed below each group in a grouped list.

Footers are typically hidden when a group is collapsed but this can be changed using the footer option:

 {
     xtype: 'list',
     collapsible: {
         footer: true  // show footers when collapsed
     }
 }

Defaults to:

null

Available since: 6.5.0

groupHeader : Object / <ext-itemheader/>

<ext-tree groupHeader="{ }" />

let element = document.body.querySelector('ext-tree');
element.groupHeader = { };
let groupHeader = element.groupHeader;

This config is used to configure a header to display above each group in a grouped list. One of the more common uses of this config is to set the tpl.

 groupHeader: {
     tpl: 'Group: {name}'
 }

Defaults to:

{
    xtype: 'rowheader'
}

grouped : Boolean

<ext-tree grouped="true" />

let element = document.body.querySelector('ext-tree');
element.grouped = true;
let grouped = element.grouped;

Set to false turn off all grouping. This setting is only meaningful if the underlying store has a grouper.

Defaults to:

true

hasFocus : Boolean

readonly ro

<ext-tree hasFocus="true" />

let element = document.body.querySelector('ext-tree');
let hasFocus = element.hasFocus;

true if this component's focusEl is focused. See also containsFocus.

Defaults to:

false

hasListeners : Object

readonly ro

<ext-tree hasListeners="{ }" />

let element = document.body.querySelector('ext-tree');
let hasListeners = element.hasListeners;

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

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

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

height : Number / String

<ext-tree height="value" />

let element = document.body.querySelector('ext-tree');
element.height = 'value';
let height = element.height;

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

<ext-tree hidden="true" />

let element = document.body.querySelector('ext-tree');
element.hidden = true;
let hidden = element.hidden;

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

<ext-tree hideAnimation="value" />

let element = document.body.querySelector('ext-tree');
element.hideAnimation = 'value';
let hideAnimation = element.hideAnimation;

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

<ext-tree hideHeaders="true" />

let element = document.body.querySelector('ext-tree');
element.hideHeaders = true;
let hideHeaders = element.hideHeaders;

true to hide the grid column headers.

Defaults to:

false

Available since: 6.0.1

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

<ext-tree hideMode="value" />

let element = document.body.querySelector('ext-tree');
element.hideMode = 'value';
let hideMode = element.hideMode;

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

<ext-tree hideOnMaskTap="true" />

let element = document.body.querySelector('ext-tree');
element.hideOnMaskTap = true;
let hideOnMaskTap = element.hideOnMaskTap;

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

<ext-tree html="value" />

let element = document.body.querySelector('ext-tree');
element.html = 'value';
let html = element.html;

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

<ext-tree id="value" />

let element = document.body.querySelector('ext-tree');
element.id = 'value';
let id = element.id;

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.

inactiveChildTabIndex : Number

immutable imm

<ext-tree inactiveChildTabIndex="10" />

let element = document.body.querySelector('ext-tree');
element.inactiveChildTabIndex = 10;
let inactiveChildTabIndex = element.inactiveChildTabIndex;

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 / <ext-indexbar/>

<ext-tree indexBar="true" />

let element = document.body.querySelector('ext-tree');
element.indexBar = true;
let indexBar = element.indexBar;

Set to true to render an alphabet IndexBar docked on the right. This can also be a config object for the <ext-indexbar/> component.

Defaults to:

null

infinite : Boolean

<ext-tree infinite="true" />

let element = document.body.querySelector('ext-tree');
element.infinite = true;
let infinite = element.infinite;

Set to true to if this list should anticipate too many rows to render to the DOM at one time. When set to true, only a fixed number of rows is rendered at once, depending on the height or maxHeight of the list.

When using this mode in an auto-height situation (where the list should be the height of its items), a maxHeight setting is required. This is due to the fact that the rendered items are absolutely positioned. As such they do not directly contribute to the list's height.

When maxHeight is set, however, an infinite list uses that setting to decide how many items to render and will set an appropriate height on its innermost element, thereby allowing the list to achieve the proper height.

Note that this configuration can not be dynamically changed after the list has instantiated.

Defaults to:

true

inheritUi : Boolean / String

readonly ro

<ext-tree inheritUi="true" />

let element = document.body.querySelector('ext-tree');
element.inheritUi = true;
let inheritUi = element.inheritUi;

Set to true on widgets that should inherit ui from their parent container. This property is typically set on the class body, but can be set on an instance as long as it is set prior to the instance being added to its container. This property is inspected at the moment a widget is added to a container, and any UIs on the container are added to the widget at that time. Inherited UIs are in addition to the widget's own ui, and are updated when the container's UI changes.

Defaults to:

false

inline : Boolean / Object

<ext-tree inline="true" />

let element = document.body.querySelector('ext-tree');
element.inline = true;
let inline = element.inline;

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.

Defaults to:

null

innerCls : String

<ext-tree innerCls="value" />

let element = document.body.querySelector('ext-tree');
element.innerCls = 'value';
let innerCls = element.innerCls;

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

<ext-tree isContainer="true" />

let element = document.body.querySelector('ext-tree');
element.isContainer = true;
let isContainer = element.isContainer;

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

Defaults to:

true

isDataView : Boolean

readonly ro

<ext-tree isDataView="true" />

let element = document.body.querySelector('ext-tree');
element.isDataView = true;
let isDataView = element.isDataView;

true in this class to identify an object this type, or subclass thereof.

Defaults to:

true

isObservable : Boolean

readonly ro

<ext-tree isObservable="true" />

let element = document.body.querySelector('ext-tree');
element.isObservable = true;
let isObservable = element.isObservable;

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

Defaults to:

true

itemButtonMode : Boolean

<ext-tree itemButtonMode="true" />

let element = document.body.querySelector('ext-tree');
element.itemButtonMode = true;
let itemButtonMode = element.itemButtonMode;

True to cause items to act like buttons for interaction styling. in ButtonMode items will maintain pressed state whenever pressed down. they will not remove this state for tap distance cancellation or mouse out.

Defaults to:

false

itemCls : String

<ext-tree itemCls="value" />

let element = document.body.querySelector('ext-tree');
element.itemCls = 'value';
let itemCls = element.itemCls;

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

Defaults to:

null

itemConfig : Object / <ext-gridrow/>

<ext-tree itemConfig="{ }" />

let element = document.body.querySelector('ext-tree');
element.itemConfig = { };
let itemConfig = element.itemConfig;

The object is used to configure the <ext-gridrow/>.

See the body and expandedField configs on the class to easily add extra content to grid rows.

Be aware that if you specify a row body, you must configure the owning grid with variableHeights: true.

Defaults to:

{
    xtype: 'gridrow'
}

itemContentCls : String

<ext-tree itemContentCls="value" />

let element = document.body.querySelector('ext-tree');
element.itemContentCls = 'value';
let itemContentCls = element.itemContentCls;

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

Defaults to:

null

Available since: 6.5.0

itemDataMap : Object

<ext-tree itemDataMap="{ }" />

let element = document.body.querySelector('ext-tree');
element.itemDataMap = { };
let itemDataMap = element.itemDataMap;

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.

Defaults to:

null

Available since: 6.5.0

itemId : String

<ext-tree itemId="value" />

let element = document.body.querySelector('ext-tree');
element.itemId = 'value';
let itemId = element.itemId;

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

itemInnerCls : String

<ext-tree itemInnerCls="value" />

let element = document.body.querySelector('ext-tree');
element.itemInnerCls = 'value';
let itemInnerCls = element.itemInnerCls;

A class to add to the inner element of items.

Defaults to:

null

Available since: 6.5.0

itemRipple : Boolean / Object

<ext-tree itemRipple="true" />

let element = document.body.querySelector('ext-tree');
element.itemRipple = true;
let itemRipple = element.itemRipple;

Defaults to:

null

Available since: 6.5.0

Properties

color : String

The background color of the ripple. Default ripple Ext.Widget#ripple settings for each item in the data view

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

itemTpl : String / String[] / Ext.XTemplate

<ext-tree itemTpl="value" />

let element = document.body.querySelector('ext-tree');
element.itemTpl = 'value';
let itemTpl = element.itemTpl;

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

keyMap : Object

<ext-tree keyMap="{ }" />

let element = document.body.querySelector('ext-tree');
element.keyMap = { };
let keyMap = element.keyMap;

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

<ext-tree keyMapEnabled="true" />

let element = document.body.querySelector('ext-tree');
element.keyMapEnabled = true;
let keyMapEnabled = element.keyMapEnabled;

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

lastKeyMapEvent : Ext.event.Event

readonly ro

<ext-tree lastKeyMapEvent="value" />

let element = document.body.querySelector('ext-tree');
element.lastKeyMapEvent = 'value';
let lastKeyMapEvent = element.lastKeyMapEvent;

The last key event processed is cached on the component for use in subsequent event handlers.

Available since: 6.6.0

layout : Object / String

<ext-tree layout="value" />

let element = document.body.querySelector('ext-tree');
element.layout = 'value';
let layout = element.layout;

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

<ext-tree left="value" />

let element = document.body.querySelector('ext-tree');
element.left = 'value';
let left = element.left;

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

<ext-tree listeners="{ }" />

let element = document.body.querySelector('ext-tree');
element.listeners = { };
let listeners = element.listeners;

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

loadingHeight : Number

<ext-tree loadingHeight="10" />

let element = document.body.querySelector('ext-tree');
element.loadingHeight = 10;
let loadingHeight = element.loadingHeight;

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.

Defaults to:

null

loadingText : String / Boolean

<ext-tree loadingText="true" />

let element = document.body.querySelector('ext-tree');
element.loadingText = true;
let loadingText = element.loadingText;

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.

Note: For virtual stores, the load mask will be shown frequently as the user scrolls. To inhibit that, set loadingText to the empty string.

Defaults to:

'Loading...'

margin : Number / String

<ext-tree margin="value" />

let element = document.body.querySelector('ext-tree');
element.margin = 'value';
let margin = element.margin;

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

markDirty : Boolean

<ext-tree markDirty="true" />

let element = document.body.querySelector('ext-tree');
element.markDirty = true;
let markDirty = element.markDirty;

true to mark items as dirty when the underlying record has been modified.

By default there is no special styling for dirty items in data views and <ext-list/>. When this config is set to true each item's element will have a CSS class name of x-mark-dirty added to it. When the underlying record for an item has been modified the item will have the x-dirty CSS class.

<ext-grid/> style "dirty" cells using a red triangle icon in the corner of the cell. See $gridcell-dirty-icon

Defaults to:

false

Available since: 6.5.1

masked : Boolean / String / Object / <ext-mask/> / <ext-loadmask/>

<ext-tree masked="true" />

let element = document.body.querySelector('ext-tree');
element.masked = true;
let masked = element.masked;

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

<ext-tree maxHeight="value" />

let element = document.body.querySelector('ext-tree');
element.maxHeight = 'value';
let maxHeight = element.maxHeight;

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

<ext-tree maxItemCache="10" />

let element = document.body.querySelector('ext-tree');
element.maxItemCache = 10;
let maxItemCache = element.maxItemCache;

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

Defaults to:

20

maxWidth : Number / String

<ext-tree maxWidth="value" />

let element = document.body.querySelector('ext-tree');
element.maxWidth = 'value';
let maxWidth = element.maxWidth;

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

<ext-tree minHeight="value" />

let element = document.body.querySelector('ext-tree');
element.minHeight = 'value';
let minHeight = element.minHeight;

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

<ext-tree minWidth="value" />

let element = document.body.querySelector('ext-tree');
element.minWidth = 'value';
let minWidth = element.minWidth;

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

minimumBufferDistance : Number

<ext-tree minimumBufferDistance="10" />

let element = document.body.querySelector('ext-tree');
element.minimumBufferDistance = 10;
let minimumBufferDistance = element.minimumBufferDistance;

The minimum number of items beyond the visible area of an infinite list to allow before repositioning items on the opposite side to balance the visible area inside the rendered range.

Defaults to:

5

modal : Boolean

<ext-tree modal="true" />

let element = document.body.querySelector('ext-tree');
element.modal = true;
let modal = element.modal;

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

<ext-tree modelValidation="true" />

let element = document.body.querySelector('ext-tree');
element.modelValidation = true;
let modelValidation = element.modelValidation;

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

<ext-tree multiColumnSort="true" />

let element = document.body.querySelector('ext-tree');
element.multiColumnSort = true;
let multiColumnSort = element.multiColumnSort;

Configure as true to have columns retain 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.

Clicking on an already sorted column which is not the primary sort key does not toggle its direction. Analogous to bringing a window to the top by clicking it, this makes that column's field the primary sort key. Subsequent clicks then toggle it.

Clicking on a primary key column toggles ASC -> DESC -> no sorter.

The column sorting menu items may be used to toggle the direction without affecting the sorter priority.

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

<ext-tree name="value" />

let element = document.body.querySelector('ext-tree');
element.name = 'value';
let name = element.name;

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

Defaults to:

null

nameHolder : Boolean

immutable imm

<ext-tree nameHolder="true" />

let element = document.body.querySelector('ext-tree');
element.nameHolder = true;
let nameHolder = element.nameHolder;

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

Defaults to:

false

nameable : Boolean

immutable imm

<ext-tree nameable="true" />

let element = document.body.querySelector('ext-tree');
element.nameable = true;
let nameable = element.nameable;

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

Defaults to:

false

onItemDisclosure : Boolean / Function / String / Object

<ext-tree onItemDisclosure="true" />

let element = document.body.querySelector('ext-tree');
element.onItemDisclosure = true;
let onItemDisclosure = element.onItemDisclosure;

Set to true to display a disclosure icon on each list item. The list will then fire the disclose event, and the event can be stopped before childtap. By setting this config to a function, the function passed will be called when the disclosure is tapped. This can be either a function object or the name of a Ext.app.ViewController method.

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

<ext-tree padding="value" />

let element = document.body.querySelector('ext-tree');
element.padding = 'value';
let padding = element.padding;

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

pinFooters : Boolean

<ext-tree pinFooters="true" />

let element = document.body.querySelector('ext-tree');
element.pinFooters = true;
let pinFooters = element.pinFooters;

Whether or not to pin footers on bottom of item groups while scrolling.

Defaults to:

false

Available since: 6.5.0

pinHeaders : Boolean

<ext-tree pinHeaders="true" />

let element = document.body.querySelector('ext-tree');
element.pinHeaders = true;
let pinHeaders = element.pinHeaders;

Whether or not to pin headers on top of item groups while scrolling. Only applicable for infinite lists.

Defaults to:

true

pinnedFooter : Object

<ext-tree pinnedFooter="{ }" />

let element = document.body.querySelector('ext-tree');
element.pinnedFooter = { };
let pinnedFooter = element.pinnedFooter;

A config object for the pinned footer. Only applicable when pinFooters and grouped are true.

Defaults to:

null

Available since: 6.5.0

pinnedHeader : Object

<ext-tree pinnedHeader="{ }" />

let element = document.body.querySelector('ext-tree');
element.pinnedHeader = { };
let pinnedHeader = element.pinnedHeader;

A config object for the pinned header. Only applicable when pinHeaders and grouped are true.

Defaults to:

{
    xtype: 'rowheader'
}

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

<ext-tree plugins="{ }" />

let element = document.body.querySelector('ext-tree');
element.plugins = { };
let plugins = element.plugins;

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

pressedDelay : Number

<ext-tree pressedDelay="10" />

let element = document.body.querySelector('ext-tree');
element.pressedDelay = 10;
let pressedDelay = element.pressedDelay;

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

Defaults to:

100

preventSelectionOnDisclose : Boolean

<ext-tree preventSelectionOnDisclose="true" />

let element = document.body.querySelector('ext-tree');
element.preventSelectionOnDisclose = true;
let preventSelectionOnDisclose = element.preventSelectionOnDisclose;

When true item selection is prevented when the user taps a disclose icon.

Defaults to:

true

preventSelectionOnTool : Boolean

<ext-tree preventSelectionOnTool="true" />

let element = document.body.querySelector('ext-tree');
element.preventSelectionOnTool = true;
let preventSelectionOnTool = element.preventSelectionOnTool;

When true item selection is prevented when the user taps on a tool. This can be overridden on specific tools by placing the preventSelection property on the tool:

 tools: [{
     type: 'gear',
     preventSelection: false
 }]

Defaults to:

true

Available since: 6.5.0

publishes : String / String[] / Object

<ext-tree publishes="value" />

let element = document.body.querySelector('ext-tree');
element.publishes = 'value';
let publishes = element.publishes;

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:

{
    selection: 1
}

record : Ext.data.Model

<ext-tree record="value" />

let element = document.body.querySelector('ext-tree');
element.record = 'value';
let record = element.record;

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

immutable imm

<ext-tree reference="value" />

let element = document.body.querySelector('ext-tree');
element.reference = 'value';
let reference = element.reference;

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

immutable imm

<ext-tree referenceHolder="true" />

let element = document.body.querySelector('ext-tree');
element.referenceHolder = true;
let referenceHolder = element.referenceHolder;

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

refreshCounter : Number

readonly ro

<ext-tree refreshCounter="10" />

let element = document.body.querySelector('ext-tree');
let refreshCounter = element.refreshCounter;

The number of refreshes this DataView has had.

Defaults to:

0

relative : Boolean

<ext-tree relative="true" />

let element = document.body.querySelector('ext-tree');
element.relative = true;
let relative = element.relative;

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

rendered : Boolean

readonly ro

<ext-tree rendered="true" />

let element = document.body.querySelector('ext-tree');
let rendered = element.rendered;

The rendered flag is set when a widget is inserted into the document for the first time.

Note that this is a one-way operation. The first time a widget is inserted into the document, this flag is set, and it is never unset.

reserveScrollbar : Boolean

immutable imm

<ext-tree reserveScrollbar="true" />

let element = document.body.querySelector('ext-tree');
element.reserveScrollbar = true;
let reserveScrollbar = element.reserveScrollbar;

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

Defaults to:

false

resetFocusPosition : Boolean

immutable imm

<ext-tree resetFocusPosition="true" />

let element = document.body.querySelector('ext-tree');
element.resetFocusPosition = true;
let resetFocusPosition = element.resetFocusPosition;

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

<ext-tree restoreFocus="true" />

let element = document.body.querySelector('ext-tree');
element.restoreFocus = true;
let restoreFocus = element.restoreFocus;

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

<ext-tree right="value" />

let element = document.body.querySelector('ext-tree');
element.right = 'value';
let right = element.right;

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

<ext-tree ripple="true" />

let element = document.body.querySelector('ext-tree');
element.ripple = true;
let ripple = element.ripple;

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.

rowLines : Boolean

<ext-tree rowLines="true" />

let element = document.body.querySelector('ext-tree');
element.rowLines = true;
let rowLines = element.rowLines;

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

Defaults to:

true

rowNumbers : Boolean / Object

<ext-tree rowNumbers="true" />

let element = document.body.querySelector('ext-tree');
element.rowNumbers = true;
let rowNumbers = element.rowNumbers;

Configure as true to a <ext-rownumberer/> column which gravitates to the start of the grid.

May be a <ext-rownumberer/> configuration object. For instance to set the column title use:

rowNumbers: {
    text: 'Index'
}

Defaults to:

false

scrollDock : 'start' / 'emd'

immutable imm

<ext-tree scrollDock="value" />

let element = document.body.querySelector('ext-tree');
element.scrollDock = 'value';
let scrollDock = element.scrollDock;

This property is placed on the child items added to this container. The value placed on the child items determines the position of that item with respect to the data items.

 Ext.Viewport.add({
     xtype: 'dataview',
     itemTpl: '{firstName}',
     data: [
         { firstName: 'Peter'},
         { firstName: 'Raymond'},
         { firstName: 'Egon'},
         { firstName: 'Winston'}
     ],
     items: [{
          xtype: 'component',
          html: 'Always At End!',
          scrollDock: 'end'
     }]
 });

Note, a value of 'top' is equivalent to 'start' while 'bottom' is equivalent to 'end'. The 'top' and 'bottom' values originated from the <ext-list/> class.

scrollToTopOnRefresh : Boolean

<ext-tree scrollToTopOnRefresh="true" />

let element = document.body.querySelector('ext-tree');
element.scrollToTopOnRefresh = true;
let scrollToTopOnRefresh = element.scrollToTopOnRefresh;

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

Defaults to:

false

scrollable : Boolean / String / Object

<ext-tree scrollable="true" />

let element = document.body.querySelector('ext-tree');
element.scrollable = true;
let scrollable = element.scrollable;

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 : Ext.grid.selection.Model

<ext-tree selectable="value" />

let element = document.body.querySelector('ext-tree');
element.selectable = 'value';
let selectable = element.selectable;

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

The following options control what can be selected:

• cells
• columns
• rows

These options control how selections can be made:

• checkbox
• deselectable
• drag
• extensible
• mode
• reducible

selection : Ext.data.Model

immutable imm readonly ro

<ext-tree selection="value" />

let element = document.body.querySelector('ext-tree');
let selection = element.selection;

The selected record.

session : Boolean / Object / Ext.data.Session

<ext-tree session="true" />

let element = document.body.querySelector('ext-tree');
element.session = true;
let session = element.session;

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

<ext-tree shadow="true" />

let element = document.body.querySelector('ext-tree');
element.shadow = true;
let shadow = element.shadow;

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

immutable imm

<ext-tree shareableName="true" />

let element = document.body.querySelector('ext-tree');
element.shareableName = true;
let shareableName = element.shareableName;

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

<ext-tree shim="true" />

let element = document.body.querySelector('ext-tree');
element.shim = true;
let shim = element.shim;

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

<ext-tree showAnimation="value" />

let element = document.body.querySelector('ext-tree');
element.showAnimation = 'value';
let showAnimation = element.showAnimation;

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

<ext-tree sortable="true" />

let element = document.body.querySelector('ext-tree');
element.sortable = true;
let sortable = element.sortable;

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

Defaults to:

true

stateId : String

<ext-tree stateId="value" />

let element = document.body.querySelector('ext-tree');
element.stateId = 'value';
let stateId = element.stateId;

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

Defaults to:

null

stateful : Boolean / Object / String[]

<ext-tree stateful="true" />

let element = document.body.querySelector('ext-tree');
element.stateful = true;
let stateful = element.stateful;

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

striped : Boolean

<ext-tree striped="true" />

let element = document.body.querySelector('ext-tree');
element.striped = true;
let striped = element.striped;

Set this to true if you want the items in this DataView to be zebra striped. alternating their background color. Only applicable if the stylesheet provides styling for alternate items.

By default the stylesheet does not provide styling for DataView items, but it can be enabled by setting the ui to 'basic'.

Lists and Grids provide default styling for striped items

Defaults to:

true

style : String / Object

<ext-tree style="value" />

let element = document.body.querySelector('ext-tree');
element.style = 'value';
let style = element.style;

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

<ext-tree tabIndex="10" />

let element = document.body.querySelector('ext-tree');
element.tabIndex = 10;
let tabIndex = element.tabIndex;

DOM tabIndex attribute for this component's focusEl.

Defaults to:

0

template : Array

readonly ro

<ext-tree template="value" />

let element = document.body.querySelector('ext-tree');
element.template = 'value';
let template = element.template;

An array of child elements to use as the children of the main element in the element template. Only used if "children" are not specified explicitly in the element template.

Defaults to:

[
    {
        reference: 'bodyElement',
        cls: Ext.baseCSSPrefix + 'body-el',
        uiCls: 'body-el',
        children: [
            {
                // This el is width:100% and flex:1 (for full height)
                reference: 'outerCt',
                className: Ext.baseCSSPrefix + 'list-outer-ct',
                children: [
                    {
                        // This el is just width:100% or explicitly sized of hscroll
                        reference: 'innerCt',
                        className: Ext.baseCSSPrefix + 'list-inner-ct'
                    }
                ]
            }
        ]
    }
]

title : String

<ext-tree title="value" />

let element = document.body.querySelector('ext-tree');
element.title = 'value';
let title = element.title;

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

Defaults to:

''

titleBar : Object

<ext-tree titleBar="{ }" />

let element = document.body.querySelector('ext-tree');
element.titleBar = { };
let titleBar = element.titleBar;

The TitleBar.

Defaults to:

{
    xtype: 'titlebar',
    docked: 'top'
}

toFrontOnShow : Boolean

<ext-tree toFrontOnShow="true" />

let element = document.body.querySelector('ext-tree');
element.toFrontOnShow = true;
let toFrontOnShow = element.toFrontOnShow;

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

Defaults to:

true

tooltip : String / Object

<ext-tree tooltip="value" />

let element = document.body.querySelector('ext-tree');
element.tooltip = 'value';
let tooltip = element.tooltip;

The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or <ext-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

<ext-tree top="value" />

let element = document.body.querySelector('ext-tree');
element.top = 'value';
let top = element.top;

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

<ext-tree touchAction="{ }" />

let element = document.body.querySelector('ext-tree');
element.touchAction = { };
let touchAction = element.touchAction;

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

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

• panX
• panY
• pinchZoom
• doubleTapZoom

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

touchAction: {
    panX: false,
    pinchZoom: false
}

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

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

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

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

Defaults to:

null

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

<ext-tree tpl="value" />

let element = document.body.querySelector('ext-tree');
element.tpl = 'value';
let tpl = element.tpl;

A String, Ext.Template, Ext.XTemplate or an Array of strings to form an Ext.XTemplate. Used in conjunction with the data and tplWriteMode configurations.

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

<ext-tree tplWriteMode="value" />

let element = document.body.querySelector('ext-tree');
element.tplWriteMode = 'value';
let tplWriteMode = element.tplWriteMode;

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'

<ext-tree triggerCtEvent="value" />

let element = document.body.querySelector('ext-tree');
element.triggerCtEvent = 'value';
let triggerCtEvent = element.triggerCtEvent;

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

Defaults to:

'tap'

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

<ext-tree triggerEvent="value" />

let element = document.body.querySelector('ext-tree');
element.triggerEvent = 'value';
let triggerEvent = element.triggerEvent;

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

Defaults to:

'childtap'

twoWayBindable : String / String[] / Object

<ext-tree twoWayBindable="value" />

let element = document.body.querySelector('ext-tree');
element.twoWayBindable = 'value';
let twoWayBindable = element.twoWayBindable;

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

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

Defaults to:

{
    selection: 1
}

ui : String / String[]

<ext-tree ui="value" />

let element = document.body.querySelector('ext-tree');
element.ui = 'value';
let ui = element.ui;

The ui or uis to be used on this Component

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

Defaults to:

null

userCls : String / String[]

<ext-tree userCls="value" />

let element = document.body.querySelector('ext-tree');
element.userCls = 'value';
let userCls = element.userCls;

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

For example:

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

Defaults to:

null

userSelectable : Boolean / String / Object

<ext-tree userSelectable="true" />

let element = document.body.querySelector('ext-tree');
element.userSelectable = true;
let userSelectable = element.userSelectable;

Setting the value to true implies auto, while false implies none. Setting the value to text allows users to select text within this component. The value may also be an object keyed by child element name as seen below.

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

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,       // allow the element to be user selectable
     bodyElement: true    // allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

variableHeights : Boolean

<ext-tree variableHeights="true" />

let element = document.body.querySelector('ext-tree');
element.variableHeights = true;
let variableHeights = element.variableHeights;

Set to true if the items in this list do not all have the same height. This is false by default to avoid measure each row to determine its height.

Defaults to:

false

Available since: 6.5.0

viewModel : String / Object / Ext.app.ViewModel

<ext-tree viewModel="value" />

let element = document.body.querySelector('ext-tree');
element.viewModel = 'value';
let viewModel = element.viewModel;

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

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

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

Defaults to:

null

weight : Number

<ext-tree weight="10" />

let element = document.body.querySelector('ext-tree');
element.weight = 10;
let weight = element.weight;

This value controls this item's order in a weighted <ext-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

<ext-tree width="value" />

let element = document.body.querySelector('ext-tree');
element.width = 'value';
let width = element.width;

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

<ext-tree x="10" />

let element = document.body.querySelector('ext-tree');
element.x = 10;
let x = element.x;

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

<ext-tree xtype="value" />

let element = document.body.querySelector('ext-tree');
element.xtype = 'value';
let xtype = element.xtype;

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/> like so:

Ext.define('PressMeButton', {
    extend: 'Ext.button.Button',
    xtype: '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.

// Explicit creation of contained Components:
var panel = new Ext.Panel({
   // ...
   items: [
      Ext.create('Ext.button.Button', {
         text: 'OK'
      })
   ]
});

// Implicit creation using xtype:
var panel = new Ext.Panel({
   // ...
   items: [{
      xtype: 'button',
      text: 'OK'
   }]
});

In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.

y : Number

<ext-tree y="10" />

let element = document.body.querySelector('ext-tree');
element.y = 10;
let y = element.y;

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

<ext-tree zIndex="10" />

let element = document.body.querySelector('ext-tree');
element.zIndex = 10;
let zIndex = element.zIndex;

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

add ( newItems ) : Ext.Component/Ext.Component[]

let element = document.body.querySelector('ext-tree');
let add = element.add(newItems);

Adds one or more Components to this Container. Example:

var myPanel = Ext.create({
    xtype: 'panel',
    html : 'This will be added to a Container'
});

var items = myContainer.add([myPanel]); // Array returned
var item  = myContainer.add(myPanel);   // One item is returned

Parameters

Returns

addAfterListener

let element = document.body.querySelector('ext-tree');
element.addAfterListener();

Alias for onAfter.

addBeforeListener

let element = document.body.querySelector('ext-tree');
element.addBeforeListener();

Alias for onBefore.

addCls ( cls, [prefix], [suffix] )

let element = document.body.querySelector('ext-tree');
element.addCls(cls, prefix, suffix);

Adds a CSS class (or classes) to this Component's rendered element.

Parameters