Docs Help

Terms, Icons, and Labels Access Levels Member Types Member Syntax Member Flags Class Icons Member Icons Navigation and Features Class Member Quick-Nav Menu Getter and Setter Methods History Bar Search and Filters API Doc Class Metadata Expanding and Collapsing Examples and Class Members Desktop -vs- Mobile View Viewing the Class Source

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.

Member Types

Config - The configuration options for a class.
Property - Set once a class is instantiated. *See Read Only below.
Method - Actions that can be performed by a class. Methods should be read as instance methods and can only be called from a instance of a given class. Static methods that can be called directly from the class itself will have a static label next to the method name. *See Static below.
Event - Events are specific to the framework event system allowing for classes to programmatically raise an event to be handled by one or more event handler methods. DOM events, while handled by the framework event system, are not specifically described within the API documentation. *For DOM events refer to the event reference page from MDN.
Theme Variable - Variables used by the visual theme engine employed by the framework.
Theme Mixin - Functions used by the visual theme engine employed by the framework and may use values set in various Theme Variables.

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

Ext.container.Container

view source

lookupComponent ( item ) : Ext.Component

protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item : Object

The config object being added.

Returns

Ext.Component

The component to be added.

Let's look at each part of the member row:

Expand/Collapse - On the left-hand size of the member row is a control used to expand and collapse each member row to show / hide member details.
Member Name - The name of the class member (lookupComponent in this example)
Method Param - Any required or optional params used by a method (or passed to an event handler method) will be listed next to the method name within parenthesis (( item ) in this example)
Return type - The class instance or javascript object returned by the method or property (Ext.Component in this case). This may be omitted for methods that do not return anything other than undefined or may display as multiple possible values separated by a forward slash / signifying that what is returned may depend on the results of the method call (i.e. a method may return a Component if a get method calls is successful or false if unsuccessful which would be displayed as Ext.Component/Boolean).
Flags - Any flags applicable to the member will be displayed next (PROTECTED in this example - see the Flags section below)
Member Origin - On the right-hand side of the member row is the class where the member was initially described (Ext.container.Container in this example). The source class will be displayed as a blue link if the member originates from the current class and gray if it is inherited from an ancestor or mixed-in class.
Member Source - On the right-hand side below the member origin class is a link to view the member's source (view source in the example)
Params List - Each param for a class method will be listed using the same name found above in parenthesis, the type of class or object expected, and a description of the param (item : Object in the example).
Returns - If a class returns a value other than undefined a "Returns" section will note the type of class or object returned and a description (Ext.Component in the example)
Since (not shown in the example) - Some members will show which version of the product the member was first introduced (i.e. Available since 3.4.0 - not pictured in the example) just after the member description
Default (not shown in the example) - Configs often show the default config value to be applied to a class instance if not overridden (i.e. Defaults to: false)

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Required - Required config when instantiating a class
Bindable - The config has a setter which allows this config to be set via ViewModel binding
Read Only - The property may be read, but cannot be used to configure / re-configure a class instance at runtime
Singleton - Singleton classes are instantiated immediately once defined and may not be instantiated manually
Static - A static method or property is a method or property belonging to the class itself, not an instance of the class
Chainable - Refers to methods that return the class instance back when called.
This enables chained method calls like: classInstance.method1().method2().etc();
Deprecated - A class or member that is scheduled for removal in a future framework version and is provided in the current version for backwards compatibility.
Deprecated classes and members will have a message directing you to the preferred class / method going forward.
Removed - A removed class or member that exists in documentation only as a reference for users upgrading between framework versions
Template - A method defined within a base class designed to be overridden by subclasses
Abstract - A class or member may be be defined as abstract. Abstract classes and members establish a class structure and provide limited, if any, code. Class-specific code will be furnished via overrides in subclasses.
Preventable - Events marked preventable will not fire if false is returned from an event handler

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Alternate Name - One or more additional class name synonymns (in Ext JS 6.0.0 the Ext.button.Button class has an alternate class name of Ext.Button). Alternate class names are commonly maintained for backward compatibility.
Hierarchy - The hierararchy view lists the inheritance chain of the current class up through its ancestor classes up to the root base class.
Mixins - A list of classes that are mixed into the current class
Inherited Mixins - A list of classes that are mixed into an ancestor of the current class
Requires - All classes required to be defined for the class to be instantiated
Uses - A list of classes potentially used by the class at some point in its lifecycle, but not necessarily requried for the class to initially be instantiated
Subclasses - Classes that extend the current class

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Global navigation will be located in a menu on the left-hand side accessible via the hamburger menu icon. The menu houses the following (on most pages):
- The name of the current product (as a link to the product landing page)
- The Sencha icon used to navigate back to the documentation home page
- The product menu drop-down button
- Tabs of navigation trees for the API docs and guides
Current context navigation and tools is located on the right-hand side accessible via the gear icon. The context menu houses teh following:
- The global search input field
- (API doc) A "Filters" tab with the member filter, expand / collapse all examples button, expand / collapse all member rows button, the access level filter checkboxes, and the counts of each member
- (API doc) A "Related Classes" tab containing the menu of metadata related to the current class
- (Guides) The table of contents for the guide

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext JS 6.2.0 - Modern Toolkit

Show private classes

top

Guide applies to: modern

Differences Between Ext JS 6.0.2 and Ext JS 6.2.0 Modern Toolkit

While we believe these guides are extremely helpful to developers planning to upgrade their applications, please be aware that the content is generated from documentation and may not always perfectly describe the actual code changes in the release. Incorrect changes may be indicated due to comment updates, formatting omissions, etc..

If you see anything suspicious or inaccurate in this report, please report the problem on the Forums or to Sencha Support.

Added

Ext.calendar.*
Ext.chart.legend.*
Ext.d3.*
Ext.drag.*
Ext.exporter.data.*
Ext.exporter.file.*
Ext.field.trigger.*
Ext.form.FieldContainer
Ext.Glyph
Ext.google.data.*
Ext.google.ux.Client
Ext.grid.cell.Check
Ext.grid.cell.Expander
Ext.grid.cell.RowNumberer
Ext.grid.cell.Summary
Ext.grid.cell.Tree
Ext.grid.column.Check
Ext.grid.column.RowNumberer
Ext.grid.column.Selection
Ext.grid.column.Tree
Ext.grid.plugin.Exporter
Ext.grid.plugin.RowExpander
Ext.grid.RowBody
Ext.grid.RowHeader
Ext.grid.Tree
Ext.mixin.Dirty
Ext.mixin.Keyboard
Ext.mixin.Pluggable
Ext.pivot.*
Ext.sparkline.*
Ext.tip.*
Ext.util.Color
Ext.ux.Gauge

Removed

Ext.BingMap
Ext.ProgressIndicator
Ext.scroll.DomScroller
Ext.scroll.Indicator
Ext.scroll.TouchScroller

Modified

Ext

Added Methods
- fireEvent
Modified Methods
- clone
  - Added cloneDom param

Ext.app.Application

Added Configs
- quickTips

Ext.Array

Modified Methods
- findBy
  - Modified fn param
    - Modified index property
      - type is Number (was String)

Ext.Base

Added Properties
- clearPropertiesOnDestroy

Ext.Button

Added Vars
- $button-alt-ui
- $button-disabled-color
- $button-disabled-icon-color
- $button-flat-ui
- $button-plain-ui
- $button-pressed-shadow
- $button-segmented-ui
- $button-shadow
Modified Vars
- $button-font-size-big
  - value is null (was $button-font-size)
- $button-icon-font-size
  - value is $button-icon-size (was $button-line-height)
- $button-icon-font-size-big
  - value is $button-icon-size-big (was $button-line-height-big)
- $button-icon-size
  - value is $button-line-height (was 1em)
- $button-icon-size-big
  - value is $button-line-height-big (was 1em)
- $button-line-height
  - value is 1.2308em (was 1.23em)
- $button-padding
  - value is .2308em .6em (was .23em .6em)
- $button-pressed-color
  - value is $button-color (was button-color($button-pressed-background-color))
- $button-pressed-icon-color
  - value is $button-pressed-color (was button-color($button-pressed-background-color))

Ext.carousel.Carousel

Added Vars
- $carousel-dark-ui
- $carousel-light-ui
Modified Vars
- $carousel-track-size
  - value is 2em (was 1.5em)

Ext.chart.AbstractChart

Modified Methods
- getLegendStore
  - Modified return
    - type is Ext.chart.legend.store.Store (was Ext.data.Store)

Ext.chart.axis.segmenter.Time

Modified Configs
- step
  - Added unit property
  - Added step property

Ext.chart.axis.sprite.Axis

Added Configs
- labelOffset

Ext.chart.axis.Time

Modified Configs
- dateFormat
  - type is String (was String/Boolean)

Ext.chart.interactions.PanZoom

Added Configs
- zoomOnPan

Ext.chart.series.Area

Added Configs
- renderer

Ext.chart.series.Series

Added Methods
- getSprites
Modified Configs
- store
  - access is public (was protected)
- surface
  - type is Ext.draw.Surface (was Object)
Modified Methods
- provideLegendInfo
  - Modified target param
    - Added mark property
    - Removed markColor property

Ext.chart.theme.Base

Added Configs
- legend

Ext.Component

Added Configs
- axisLock
- hideOnMaskTap
- modal
- tooltip
Added Methods
- center
Added Events
- beforehide
- beforeshow
- positionedchange
Modified Methods
- showBy
  - Added options param
Removed Configs
- disabledCls
- floatingCls
- hiddenCls

Ext.data.AbstractStore

Modified Methods
- getFilters
  - Modified autoCreate param
    - access is public (was private)
- getSorters
  - Modified autoCreate param
    - access is public (was private)

Ext.data.Batch

Modified Methods
- start
  - Modified index param
    - access is public (was private)

Ext.data.field.Date

Added Configs
- useStrict

Ext.data.Model

Added Configs
- hasOne
Added Properties
- crudState
- crudStateWas

Ext.data.NodeInterface

Added Configs
- glyph
Added Methods
- onRegisterTreeNode
- onUnregisterTreeNode
Modified Methods
- copy
  - Added session param
- updateInfo
  - Added return

Ext.data.TreeStore

Modified Methods
- collect
  - Modified options param
    - Added allowNull property
    - Added filtered property
    - Added collapsed property

Ext.dataview.component.Container

Added Events
- mouseout
- mouseover

Ext.dataview.DataView

Added Events
- itemmouseenter
- itemmouseleave
Removed Configs
- baseCls
- pressedCls
- selectedCls

Ext.dataview.element.Container

Added Events
- mouseout
- mouseover

Ext.dataview.IndexBar

Added Vars
- $indexbar-background-color
- $indexbar-border-radius
- $indexbar-border-radius-big
- $indexbar-color
- $indexbar-font-family
- $indexbar-font-size
- $indexbar-font-size-big
- $indexbar-font-weight
- $indexbar-height
- $indexbar-height-big
- $indexbar-horizontal-height
- $indexbar-horizontal-height-big
- $indexbar-horizontal-margin
- $indexbar-horizontal-margin-big
- $indexbar-horizontal-padding
- $indexbar-horizontal-padding-big
- $indexbar-horizontal-width
- $indexbar-horizontal-width-big
- $indexbar-margin
- $indexbar-margin-big
- $indexbar-opacity
- $indexbar-padding
- $indexbar-padding-big
- $indexbar-pressed-background-color
- $indexbar-pressed-color
- $indexbar-pressed-opacity
- $indexbar-width
- $indexbar-width-big
Removed Vars
- $index-bar-bg-color
- $index-bar-color
- $index-bar-width

Ext.dataview.List

Added Configs
- pinnedHeader
- rowLines
- scrollDock
Modified Configs
- onItemDisclosure
  - type is Boolean/Function/String/Object (was Boolean/Function/Object)
- useComponents
  - access is public (was private)
Removed Configs
- baseCls
Removed Vars
- $list-group-header-background-color
- $list-group-header-border-color
- $list-group-header-color
- $list-group-header-font-family
- $list-group-header-font-size
- $list-group-header-font-size-big
- $list-group-header-font-weight
- $list-group-header-line-height
- $list-group-header-line-height-big
- $list-group-header-padding
- $list-group-header-padding-big
- $list-item-background-color
- $list-item-border-color
- $list-item-color
- $list-item-font-family
- $list-item-font-size
- $list-item-font-size-big
- $list-item-font-weight
- $list-item-line-height
- $list-item-line-height-big
- $list-item-padding
- $list-item-padding-big
- $list-item-pressed-background-color
- $list-item-selected-background-color

Ext.dataview.NestedList

Modified Configs
- backButton
  - value is { hidden: true } (was { ui: 'back', hidden: true })

Ext.Date

Added Properties
- DAYS_IN_WEEK
- firstDayOfWeek
- MAX_DAYS_IN_MONTH
- MONTHS_IN_YEAR
- weekendDays
Added Methods
- isWeekend
- localToUtc
- utc
- utcToLocal

Ext.Decorator

Modified Configs
- component
  - value is { xtype: 'component' } (was {})

Ext.direct.PollingProvider

Added Configs
- timeout

Ext.direct.Provider

Added Configs
- headers
Modified Events
- exception
  - Added provider param
  - Added e param

Ext.dom.Element

Added Methods
- addClsOnClick
- addClsOnFocus
- addClsOnOver
- getTouchAction
- monitorMouseLeave
- setTouchAction
Added Static-methods
- fromPagePoint
- fromPoint

Ext.dom.Underlay

Added Methods
- beforeShow

Ext.draw.Container

Added Methods
- handleResize

Ext.draw.Point

Modified Methods
- rotate
  - Modified center param
    - optional is true

Ext.draw.sprite.Instancing

Added Configs
- instances
Added Methods
- add

Ext.event.Event

Added Properties
- pointerType
Added Methods
- claimGesture
- startDrag

Ext.Factory

Modified Methods
- create
  - Modified defaultType param
    - type is String/Object (was String)

Ext.field.Checkbox

Added Vars
- $checkboxfield-checkbox-margin
- $checkboxfield-checkbox-margin-big
- $checkboxfield-checkbox-size-big
- $checkboxfield-checked-checkbox-color
- $checkboxfield-disabled-checkbox-color
Modified Configs
- component
  - value is { xtype: 'checkboxinput' } (was { xtype: 'input', type: 'checkbox', useMask: true, cls: 'x-input-checkbox' })
Modified Vars
- $checkboxfield-checkbox-font-size
  - value is $checkboxfield-checkbox-size (was 1.24rem)
- $checkboxfield-checkbox-font-size-big
  - value is $checkboxfield-checkbox-size-big (was 1.2rem)
- $checkboxfield-checkbox-icon
  - value is $fa-var-square-o (was $fa-var-square-o $checkboxfield-checkbox-font-size $font-icon-font-family)
- $checkboxfield-checkbox-size
  - value is px-to-rem(16px, 13px) (was 1em)
- $checkboxfield-checked-checkbox-icon
  - value is $fa-var-check-square-o (was $fa-var-check-square-o $checkboxfield-checkbox-font-size $font-icon-font-family)

Ext.field.Field

Added Configs
- bodyAlign
- labelTextAlign
Added Vars
- $field-disabled-background-color
- $field-disabled-label-background-color
- $field-disabled-label-color
- $field-disabled-opacity
- $field-focused-background-color
- $field-focused-label-background-color
- $field-focused-label-color
- $field-invalid-background-color
- $field-invalid-label-background-color
- $field-invalid-label-color
- $field-required-indicator-font-family
- $field-required-indicator-font-size
- $field-required-indicator-font-weight
- $field-required-indicator-line-height
- $field-required-indicator-margin
- $field-required-indicator-margin-big
- $field-vertical-spacing
- $field-vertical-spacing-big
Modified Configs
- labelAlign
  - type is 'top'/'left'/'bottom'/'right' (was String)
Modified Vars
- $field-background-color
  - value is null (was #fff)
- $field-label-background-color
  - value is null (was $neutral-light-color)
- $field-label-font-size-big
  - value is null (was $field-label-font-size)
- $field-label-line-height
  - value is px-to-em(16px, 13px) (was 1.23em)
- $field-label-line-height-big
  - value is px-to-em(24px, 15px) (was 1.6em)
- $field-label-padding
  - value is px-to-em(3px 6px 3px 0, 13px) (was .23em .6em)
- $field-label-padding-big
  - value is px-to-em(3px 6px 3px 0, 15px) (was .2em .6em)
Removed Configs
- baseCls
- requiredCls
Removed Vars
- $field-border-color
- $field-label-border-color

Ext.field.Input

Added Configs
- isFocused
Removed Configs
- baseCls
- focusCls
Removed Events
- clearicontap

Ext.field.Radio

Added Vars
- $radiofield-checkbox-margin
- $radiofield-checkbox-margin-big
- $radiofield-checkbox-size-big
- $radiofield-checked-checkbox-color
- $radiofield-disabled-checkbox-color
Modified Vars
- $radiofield-checkbox-color
  - value is null (was $checkboxfield-checkbox-color)
- $radiofield-checkbox-font-size
  - value is $radiofield-checkbox-size (was $checkboxfield-checkbox-font-size)
- $radiofield-checkbox-font-size-big
  - value is $radiofield-checkbox-size-big (was $checkboxfield-checkbox-font-size-big)
- $radiofield-checkbox-icon
  - value is $fa-var-circle-o (was $fa-var-circle-o $radiofield-checkbox-font-size $font-icon-font-family)
- $radiofield-checkbox-size
  - value is null (was $checkboxfield-checkbox-size)
- $radiofield-checked-checkbox-icon
  - value is $fa-var-dot-circle-o (was $fa-var-dot-circle-o $radiofield-checkbox-font-size $font-icon-font-family)

Ext.field.Spinner

Modified Configs
- component
  - value is { readOnly: true } (was { disabled: true })

Ext.field.Text

Added Configs
- labelAlign
- textAlign
- triggers
Added Vars
- $textfield-disabled-input-background-color
- $textfield-disabled-input-border-color
- $textfield-disabled-input-color
- $textfield-focused-input-background-color
- $textfield-focused-input-border-color
- $textfield-focused-input-border-style
- $textfield-focused-input-border-width
- $textfield-focused-input-color
- $textfield-input-border-color
- $textfield-input-border-style
- $textfield-input-border-width
- $textfield-input-color
- $textfield-invalid-input-background-color
- $textfield-invalid-input-border-color
- $textfield-invalid-input-border-style
- $textfield-invalid-input-border-width
- $textfield-invalid-input-color
- $textfield-placeholder-color
Modified Vars
- $textfield-input-background-color
  - value is $background-color (was #fff)
- $textfield-input-font-size-big
  - value is null (was $textfield-input-font-size)
- $textfield-input-line-height
  - value is px-to-em(16px, 13px) (was 1.23em)
- $textfield-input-line-height-big
  - value is px-to-em(24px, 15px) (was 1.6em)
- $textfield-input-padding
  - value is px-to-em(3px 6px, 13px) (was .23em .4em)
- $textfield-input-padding-big
  - value is px-to-em(3px 6px, 15px) (was .2em .4em)
Removed Vars
- $textfield-clear-icon
- $textfield-clear-icon-color
- $textfield-clear-icon-font-size
- $textfield-clear-icon-font-size-big
- $textfield-clear-icon-size

Ext.field.Toggle

Added Vars
- $toggleslider-disabled-fill-background-color
- $toggleslider-disabled-fill-border-color
- $toggleslider-disabled-opacity
- $toggleslider-fill-background-color
- $toggleslider-fill-border-color
- $toggleslider-thumb-inset
- $toggleslider-track-background-color
- $toggleslider-track-border-color
- $toggleslider-track-border-radius
- $toggleslider-track-border-radius-big
- $toggleslider-track-border-style
- $toggleslider-track-border-width
- $toggleslider-track-height
- $toggleslider-track-height-big
- $toggleslider-width
- $toggleslider-width-big
Modified Events
- change
  - Added this param
  - Modified newValue param
    - type is Number (was Boolean)
  - Modified oldValue param
    - type is Number (was Boolean)
  - Removed me param
Removed Configs
- maxValueCls
- minValueCls

Ext.form.FieldSet

Added Vars
- $fieldset-border-style
Modified Vars
- $fieldset-border-radius
  - value is null (was .4em)

Ext.form.Panel

Modified Vars
- $formpanel-body-background-color
  - value is $background-color (was $neutral-highlight-color)
Removed Configs
- baseCls

Ext.grid.cell.Base

Added Configs
- cellCls
- innerStyle

Ext.grid.cell.Text

Added Configs
- zeroValue

Ext.grid.cell.Widget

Added Configs
- forceWidth

Ext.grid.column.Column

Added Configs
- defaultWidth
- exportStyle
- formatter
- ignoreExport
- summaryFormatter
Added Vars
- $gridcolumn-background-color
- $gridcolumn-border-color
- $gridcolumn-border-style
- $gridcolumn-border-width
- $gridcolumn-color
- $gridcolumn-font-family
- $gridcolumn-font-size
- $gridcolumn-font-size-big
- $gridcolumn-font-weight
- $gridcolumn-line-height
- $gridcolumn-line-height-big
- $gridcolumn-padding
- $gridcolumn-padding-big
- $gridcolumn-resizer-background-color
- $gridcolumn-sort-asc-icon
- $gridcolumn-sort-desc-icon
- $gridcolumn-sort-icon-color
- $gridcolumn-sort-icon-font-size
- $gridcolumn-sort-icon-font-size-big
- $gridcolumn-sort-icon-margin
- $gridcolumn-sort-icon-margin-big
- $gridcolumn-sort-icon-size
- $gridcolumn-sort-icon-size-big
- $gridcolumn-sorted-background-color
- $resizer-background-color
Removed Vars
- $grid-column-background-color
- $grid-column-border-color
- $grid-column-color
- $grid-column-font-family
- $grid-column-font-size
- $grid-column-font-size-big
- $grid-column-font-weight
- $grid-column-line-height
- $grid-column-line-height-big
- $grid-column-padding
- $grid-column-padding-big
- $grid-column-sort-asc-icon
- $grid-column-sort-desc-icon
- $grid-column-sort-icon-color
- $grid-column-sort-icon-font-size
- $grid-column-sort-icon-spacing
- $grid-column-sorted-background-color

Ext.grid.Grid

Added Vars
- $grid-resize-marker-background-color
- $grid-resize-marker-width
Removed Configs
- baseCls
Removed Vars
- $grid-cell-background-color
- $grid-cell-border-color
- $grid-cell-color
- $grid-cell-font-family
- $grid-cell-font-size
- $grid-cell-font-size-big
- $grid-cell-font-weight
- $grid-cell-line-height
- $grid-cell-line-height-big
- $grid-cell-padding
- $grid-cell-padding-big
- $grid-cell-pressed-background-color
- $grid-cell-selected-background-color
- $grid-column-resize-marker-background-color
- $grid-group-header-background-color
- $grid-group-header-border-color
- $grid-group-header-color
- $grid-group-header-font-family
- $grid-group-header-font-size
- $grid-group-header-font-size-big
- $grid-group-header-font-weight
- $grid-group-header-line-height
- $grid-group-header-line-height-big
- $grid-group-header-padding
- $grid-group-header-padding-big
- $grid-summary-row-cell-background-color
- $grid-summary-row-cell-border-color
- $grid-summary-row-cell-color
- $grid-summary-row-cell-font-family
- $grid-summary-row-cell-font-size
- $grid-summary-row-cell-font-size-big
- $grid-summary-row-cell-font-weight
- $grid-summary-row-cell-line-height
- $grid-summary-row-cell-line-height-big
- $grid-summary-row-cell-padding
- $grid-summary-row-cell-padding-big

Ext.grid.HeaderContainer

Added Configs
- defaultColumnUI

Ext.grid.plugin.Editable

Modified Configs
- defaultFormConfig
  - value is { xtype: 'formpanel', scrollable: true, items: { xtype: 'fieldset' } } (was { xtype: 'formpanel', modal: true, scrollable: true, items: { xtype: 'fieldset' } })

Ext.grid.plugin.MultiSelection

Modified Configs
- selectionColumn
  - value is { width: 60, xtype: 'selectioncolumn', align: 'center', cell: { xtype: 'checkcell' }, ignore: true, hidden: true } (was { width: 60, xtype: 'column', cls: 'x-grid-multiselection-column', cell: { cls: 'x-grid-multiselection-cell' }, ignore: true, hidden: true })

Ext.grid.plugin.ViewOptions

Modified Configs

columnList

value is { xtype: 'nestedlist', title: 'Columns', listConfig: { plugins: [

{
    type: 'sortablelist',
    handleSelector: '.x-column-options-sortablehandle'
}

], mode: 'MULTI', infinite: true, itemTpl: [

'<div class="x-column-options-itemwrap<tpl if="hidden"> {hiddenCls}</tpl>',
'<tpl if="grouped"> {groupedCls}</tpl>">',
'<div class="x-column-options-sortablehandle x-font-icon"></div>',
'<tpl if="header">',
'<div class="x-column-options-folder x-font-icon"></div>',
'<tpl else>',
'<div class="x-column-options-leaf x-font-icon"></div>',
'</tpl>',
'<div class="x-column-options-text">{text}</div>',
'<tpl if="groupable && dataIndex">',
'<div class="x-column-options-groupindicator x-font-icon"></div>',
'</tpl>',
'<div class="x-column-options-visibleindicator x-font-icon"></div>',
'</div>'

], triggerEvent: null, bufferSize: 1, minimumBufferSize: 1 }, store: { type: 'tree', fields: [

'id',
'text',
'dataIndex',
'header',
'hidden',
'hiddenCls',
'grouped',
'groupedCls',
'groupable'

], root: {

text: 'Columns'

} }, clearSelectionOnListChange: false } (was { xtype: 'nestedlist', title: 'Column', listConfig: { plugins: [

{
    type: 'sortablelist',
    handleSelector: '.x-column-options-sortablehandle'
}

], mode: 'MULTI', infinite: true, itemTpl: [

'<div class="x-column-options-itemwrap<tpl if="hidden"> {hiddenCls}</tpl>',
'<tpl if="grouped"> {groupedCls}</tpl>">',
'<div class="x-column-options-sortablehandle"></div>',
'<tpl if="header">',
'<div class="x-column-options-folder"></div>',
'<tpl else>',
'<div class="x-column-options-leaf"></div>',
'</tpl>',
'<div class="x-column-options-text">{text}</div>',
'<tpl if="groupable && dataIndex">',
'<div class="x-column-options-groupindicator"></div>',
'</tpl>',
'<div class="x-column-options-visibleindicator"></div>',
'</div>'

], triggerEvent: null, bufferSize: 1, minimumBufferSize: 1 }, store: { type: 'tree', fields: [

'id',
'text',
'dataIndex',
'header',
'hidden',
'hiddenCls',
'grouped',
'groupedCls',
'groupable'

], root: {

text: 'Columns'

} }, clearSelectionOnListChange: false })

sheet
- value is { baseCls: 'x-gridviewoptions', xtype: 'sheet', items: [ {
```
docked: 'top',
xtype: 'titlebar',
title: 'Customize',
items: {
    xtype: 'button',
    text: 'Done',
    ui: 'action',
    align: 'right',
    role: 'donebutton'
}
```
  } ], hidden: true, hideOnMaskTap: true, enter: 'right', exit: 'right', modal: true, translatable: { translationMethod: 'csstransform' }, right: 0, layout: 'fit', stretchY: true } (was { baseCls: 'x-grid-viewoptions', xtype: 'sheet', items: [ {
```
docked: 'top',
xtype: 'titlebar',
title: 'Customize',
items: {
    xtype: 'button',
    text: 'Done',
    ui: 'action',
    align: 'right',
    role: 'donebutton'
}
```
  } ], hideOnMaskTap: false, enter: 'right', exit: 'right', modal: false, translatable: { translationMethod: 'csstransform' }, right: 0, layout: 'fit', stretchY: true })

Removed Properties
- sheetVisible

Ext.layout.Box

Added Configs
- vertical

Ext.MessageBox

Added Configs
- buttonToolbar
Removed Configs
- zIndex

Ext.mixin.Observable

Modified Methods
- addListener
  - Modified options param
    - Added capture property
- on
  - Modified options param
    - Added capture property

Ext.Number

Added Methods
- roundToNearest

Ext.Panel

Added Configs
- anchor
- closable
- closeAction
- closeToolText
Added Vars
- $panel-anchor-height
- $panel-anchor-width
- $panel-body-padding
- $panel-body-padding-big
- $panel-header-shadow
- $panel-header-z-index
Modified Vars
- $panel-body-background-color
  - value is $background-color (was #fff)

Ext.panel.Tool

Added Vars
- $panel-tool-menu-icon

Ext.picker.Picker

Added Vars
- $picker-title-border-color
- $picker-title-border-style
- $picker-title-border-width

Ext.picker.Slot

Modified Configs
- scrollable
  - value is { x: false, y: true, scrollbars: false } (was { x: false, indicators: false, momentumEasing: { minVelocity: 2 }, slotSnapEasing: { duration: 100 } })

Ext.plugin.Abstract

Added Configs
- id
Added Methods
- detachCmp
Modified Properties
- isPlugin
  - readonly is true

Ext.plugin.PullRefresh

Removed Configs
- scrollerAutoRefresh

Ext.Progress

Added Vars
- $progress-border-style
- $progress-min-height
- $progress-min-height-big
- $progress-text-back-color
- $progress-text-font-size-big
- $progress-text-front-color
- $progress-text-line-height
- $progress-text-line-height-big
Modified Vars
- $progress-background-color
  - value is $neutral-highlight-color (was #eee)
- $progress-bar-background-gradient
  - value is null (was 'none')
- $progress-border-color
  - value is null (was $base-color)
- $progress-border-width
  - value is null (was 1px)
- $progress-text-font-size
  - value is px-to-rem(13px, 13px) (was $font-size)
Removed Vars
- $include-progress-default-ui
- $progress-height
- $progress-text-color-back
- $progress-text-color-front

Ext.SegmentedButton

Added Configs
- vertical
Modified Configs
- defaultUI
  - value is 'segmented' (was null)
- layout
  - value is { type: 'box', vertical: false, align: 'stretch' } (was { type: 'hbox', align: 'stretch' })
Removed Configs
- baseCls

Ext.Sheet

Modified Vars
- $sheet-background-color
  - value is $background-color (was #fff)
Removed Configs
- baseCls

Ext.slider.Slider

Added Configs
- thumbDefaults
- valueIsArray
Modified Methods
- updateValue
  - Removed newValue param
  - Removed oldValue param
Removed Configs
- thumbConfig

Ext.slider.Thumb

Added Configs
- fillCls
- fillTrack
Modified Configs
- draggable
  - value is { direction: 'horizontal', translatable: { // use cssposition instead of csstransform so that themes can use transform // scale to style the pressed state of the thumb (material) translationMethod: 'cssposition' } } (was { direction: 'horizontal' })
Removed Configs
- pressedCls

Ext.supports

Added Properties
- Selectors2
- ViewportUnits

Ext.tab.Bar

Added Vars
- $tabbar-background-gradient
- $tabbar-border-color
- $tabbar-border-style
- $tabbar-border-width
- $tabbar-box-shadow
- $tabbar-color
- $tabbar-font-family
- $tabbar-font-size
- $tabbar-font-size-big
- $tabbar-font-weight
- $tabbar-horizontal-spacing
- $tabbar-horizontal-spacing-big
- $tabbar-line-height
- $tabbar-line-height-big
- $tabbar-min-height
- $tabbar-min-height-big
- $tabbar-title-color
- $tabbar-title-font-family
- $tabbar-title-font-size
- $tabbar-title-font-size-big
- $tabbar-title-font-weight
- $tabbar-vertical-spacing
- $tabbar-vertical-spacing-big
Modified Vars
- $tabbar-padding
  - value is null (was .46rem .5rem)
- $tabbar-padding-big
  - value is null (was .4rem .67rem)
Removed Vars
- $tabbar-tab-spacing
- $tabbar-tab-spacing-big

Ext.tab.Tab

Added Vars
- $active-icon-color
- $tab-active-box-shadow
- $tab-active-icon-color
- $tab-badge-font-size-big
- $tab-badge-line-height-big
- $tab-badge-padding-big
- $tab-icon-color
Modified Vars
- $tab-icon-font-size
  - value is $tab-icon-size (was $tab-line-height)
- $tab-icon-font-size-big
  - value is $tab-icon-size-big (was $tab-line-height-big)
- $tab-icon-size
  - value is $tab-line-height (was 1em)
- $tab-icon-size-big
  - value is $tab-line-height-big (was 1em)

Ext.TitleBar

Added Configs
- defaultButtonUI
Modified Configs
- layout
  - value is { type: 'hbox', align: 'center' } (was { type: 'hbox' })
Removed Configs
- baseCls

Ext.Toast

Modified Configs
- modal
  - access is public (was private)

Ext.Toolbar

Added Vars
- $toolbar-box-shadow
- $toolbar-color
- $toolbar-font-family
- $toolbar-font-size
- $toolbar-font-size-big
- $toolbar-font-weight
- $toolbar-line-height
- $toolbar-line-height-big
- $toolbar-min-height
- $toolbar-min-height-big
- $toolbar-title-padding
- $toolbar-title-padding-big
Modified Vars
- $toolbar-background-color
  - value is $background-color (was #fff)
- $toolbar-border-color
  - type is color/list (was color)
- $toolbar-border-style
  - type is String/list (was Number/list)
- $toolbar-padding
  - value is .4616em .5em (was .46rem .5rem)
- $toolbar-padding-big
  - value is .4em .67em (was .4rem .67rem)
- $toolbar-title-font-size
  - value is $toolbar-font-size (was 1rem)
- $toolbar-title-font-size-big
  - value is $toolbar-font-size-big (was $toolbar-title-font-size)
- $toolbar-title-font-weight
  - value is $toolbar-font-weight (was $font-weight-bold)
Removed Configs
- baseCls

Ext.util.Filter

Added Static-methods
- isEqual
Modified Configs
- serializer
  - access is public (was private)

Ext.util.Format

Added Properties
- currencySpacer
Added Methods
- lessThanElse
- nbsp
- sign
- uri
- uriCmp
- word
Modified Methods
- currency
  - Added currencySpacer param

Ext.util.Positionable

Modified Methods
- getRegion
  - Added contentBox param

Ext.util.Region

Added Methods
- alignTo
- exclude
- getOffsetsTo
- setPosition
Added Static-methods
- getAlignInfo
Modified Methods
- contains
  - Modified region param
    - type is Ext.util.Region/Ext.util.Point (was Ext.util.Region)

Ext.util.TaskRunner

Modified Methods
- start
  - Modified task param
    - Added addCountToArgs property

Ext.ux.ajax.Simlet

Modified Configs
- responseHeaders
  - type is Object/Function (was Object)
- responseText
  - type is String/Function (was Number)
- responseXML
  - type is String/Function (was Number)
- status
  - type is Number/Function (was Number)
- statusText
  - type is String/Function (was String)

Ext.viewport.Default

Removed Configs
- preventPanning

Ext.Widget

Added Configs
- alwaysOnTop
- baseCls
- border
- cls
- flex
- floated
- hidden
- id
- itemId
- relative
- shadow
- shim
- toFrontOnShow
- touchAction
- ui
- x
- y
Added Properties
- classCls
- classClsRoot
Added Methods
- getAlignmentInfo
- isHidden
- isVisible
- lookupTpl
- toFront
- up

Global_CSS

Added Vars
- $css-variable-selector
- $enable-border-radius
- $enable-default-uis
- $enable-floated-shadows
- $enable-missing-images
- $enable-status-bar-padding
- $shadow-blur-radius
- $shadow-color
- $shadow-width
- $shadow-x-offset
- $shadow-y-offset
- enable-css-variables
Modified Vars
- $alert-color
  - value is #c30 (was red)
- $base-background-gradient
  - value is if($enable-highlights, matte, null) (was if($include-highlights, matte, null))
- $font-size
  - value is pxToRootPct(13px) (was 81.25%)
- $font-size-big
  - value is pxToRootPct(15px) (was 93.75%)
- $include-highlights
  - value is true
Removed Vars
- $include-border-radius
- $include-not-found-images

Summary

885 Classes
1,757 Class Configs
725 Class Properties
45 Class Static Properties
3,196 Class Methods
164 Class Static Methods
395 Class Events
557 Class Vars

Contents

Terms, Icons, and Labels

Access Levels

Member Types

Member Syntax

Member Flags

Class Icons

Member Icons

Navigation and Features

Class Member Quick-Nav Menu

Getter and Setter Methods

History Bar

Search and Filters

API Doc Class Metadata

Expanding and Collapsing Examples and Class Members

Desktop -vs- Mobile View

Viewing the Class Source

Ext JS 6.2.0 - Modern Toolkit

Differences Between Ext JS 6.0.2 and Ext JS 6.2.0 Modern Toolkit

Added

Removed

Modified

Ext

Ext.app.Application

Ext.Array

Ext.Base

Ext.Button

Ext.carousel.Carousel

Ext.chart.AbstractChart

Ext.chart.axis.segmenter.Time

Ext.chart.axis.sprite.Axis

Ext.chart.axis.Time

Ext.chart.interactions.PanZoom

Ext.chart.series.Area

Ext.chart.series.Series

Ext.chart.theme.Base

Ext.Component

Ext.data.AbstractStore

Ext.data.Batch

Ext.data.field.Date

Ext.data.Model

Ext.data.NodeInterface

Ext.data.TreeStore

Ext.dataview.component.Container

Ext.dataview.DataView

Ext.dataview.element.Container

Ext.dataview.IndexBar

Ext.dataview.List

Ext.dataview.NestedList

Ext.Date

Ext.Decorator

Ext.direct.PollingProvider

Ext.direct.Provider

Ext.dom.Element

Ext.dom.Underlay

Ext.draw.Container

Ext.draw.Point

Ext.draw.sprite.Instancing

Ext.event.Event

Ext.Factory

Ext.field.Checkbox

Ext.field.Field

Ext.field.Input

Ext.field.Radio

Ext.field.Spinner

Ext.field.Text

Ext.field.Toggle

Ext.form.FieldSet

Ext.form.Panel

Ext.grid.cell.Base

Ext.grid.cell.Text

Ext.grid.cell.Widget

Ext.grid.column.Column

Ext.grid.Grid

Ext.grid.HeaderContainer

Ext.grid.plugin.Editable

Ext.grid.plugin.MultiSelection

Ext.grid.plugin.ViewOptions

Ext.layout.Box

Ext.MessageBox