ExtReact Docs Help


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

Terms, Icons, and Labels

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

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

Access Levels

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

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component

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.


item :  Object

The config object being added.


The component to be added.

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

Member Flags

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

Class Icons

- Indicates a framework class

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

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

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

Member Icons

- Indicates a class member of type config

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

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

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

Class Member Quick-Nav Menu

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

Getter and Setter Methods

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

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

History Bar

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

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

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

Search and Filters

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

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

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

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

API Doc Class Metadata

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

Expanding and Collapsing Examples and Class Members

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

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

Desktop -vs- Mobile View

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

Viewing the Class Source

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

ExtAngular 6.7.0


NPM Package




Abstract class that provides default styles for non-specified things. Should be sub-classed when creating new themes. For example:

Ext.define('Ext.chart.theme.Custom', {
    extend: 'Ext.chart.theme.Base',
    singleton: true,
    alias: 'chart.theme.custom',
    config: {
        baseColor: '#ff9f00'

Theme provided values will not override the values provided in an instance config. However, if a theme provided value is an object, it will be merged with the value from the instance config, unless the theme provided object has a '$default' key set to 'true'.

Certain chart theme configs (e.g. 'fontSize') may use the 'default' value to indicate that they should inherit a value from the corresponding CSS style provided by a framework theme. Additionally, one can use basic binary operators like multiplication, addition and subtraction to derive from the default value, e.g. fontSize: 'default*1.3'.

Important: the theme should not use the 'font' shorthand to specify the font of labels and other text elements of a chart. Instead, individual font properties should be used: 'fontStyle', 'fontVariant', 'fontWeight', 'fontSize' and 'fontFamily'.

No members found using the current filters


Optional Configs

axis : Object

Theme defaults for the axes. Can apply to all axes or only axes with a specific position. For example:

axis: {
  defaults: {
    style: {strokeStyle: 'red'}
  left: {
    title: {fillStyle: 'green'}

The values from the axis.defaults and axis.position configs (where position is a valid axis Ext.chart.axis.Axis#position, e.g. 'bottom') will be applied to corresponding Ext.chart.axis.Axis configs. E.g., the axis.defaults.label config will apply to the Ext.chart.axis.Axis#label config of all axes, where the axis.left.titleMargin config will only apply to the Ext.chart.axis.Axis#titleMargin config of all axes positioned to the left.

getAxis : Object

Returns the value of axis



setAxis (axis)

Sets the value of axis


axis :  Object

baseColor : String / Ext.util.Color

The base color used to generate the Ext.chart.AbstractChart#colors of the theme.

Defaults to:


getBaseColor : String / Ext.util.Color

Returns the value of baseColor


String / Ext.util.Color

setBaseColor (baseColor)

Sets the value of baseColor


baseColor :  String / Ext.util.Color

chart : Object

Theme defaults for the chart. Can apply to all charts or just a specific type of chart. For example:

chart: {
  defaults: {
    background: 'lightgray'
  polar: {
    background: 'green'

The values from the chart.defaults and chart.type configs (where type is a valid chart xtype, e.g. 'Cartesian' or 'Polar') will be applied to corresponding chart configs. E.g., the chart.defaults.background config will set the Ext.chart.AbstractChart#background config of all charts, where the chart.cartesian.flipXY config will only set the Ext.chart.CartesianChart#flipXY config of all cartesian charts.

getChart : Object

Returns the value of chart



setChart (chart)

Sets the value of chart


chart :  Object

colors : Array

Array of colors/gradients to be used by the theme. Defaults to colorDefaults.

Defaults to:


getColors : Array

Returns the value of colors



setColors (colors)

Sets the value of colors


colors :  Array

gradients : Object

The gradient config to be used by series' sprites. E.g.:

  type: 'linear',
  degrees: 90

Please refer to the documentation for the Ext.draw.gradient.Linear and Ext.draw.gradient.Radial gradients for all possible options. The color stops for the gradients will be generated by the theme based on the colors config.

Defaults to:


getGradients : Object

Returns the value of gradients



setGradients (gradients)

Sets the value of gradients


gradients :  Object

legend : Object

Style information for the {Ext.chart.legend.SpriteLegend sprite legend}. If the Ext.chart.legend.Legend legend is used, this config is ignored. For additional details see Ext.chart.AbstractChart#legend.


item : Ext.chart.legend.sprite.Item

border : Object

See Ext.chart.legend.SpriteLegend#border.

getLegend : Object

Returns the value of legend



setLegend (legend)

Sets the value of legend


legend :  Object

series : Object

Theme defaults for the series. Can apply to all series or just a specific type of series. For example:

series: {
  defaults: {
    style: {
      lineWidth: 2
  bar: {
    animation: {
      easing: 'bounceOut',
      duration: 1000

The values from the series.defaults and series.type configs (where type is a valid series Ext.chart.series.Series#type, e.g. 'line') will be applied to corresponding series configs. E.g., the series.defaults.label config will apply to the Ext.chart.series.Series#label config of all series, where the series.line.step config will only apply to the Ext.chart.series.Line#step config of line series.

getSeries : Object

Returns the value of series



setSeries (series)

Sets the value of series


series :  Object

sprites : Object

Default style for the custom chart sprites by type. For example:

sprites: {
  text: {
    fontWeight: 300

These sprite attribute overrides will apply to custom sprites of all charts specified using the Ext.draw.Container#sprites config. The overrides are specified by sprite type, e.g. sprites.text config tells to apply given attributes to all Ext.draw.sprite.Text sprites.

getSprites : Object

Returns the value of sprites



setSprites (sprites)

Sets the value of sprites


sprites :  Object



Static Methods

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

    constructor: function() {
        alert("I'm going to be a cat!");



var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");



The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).


members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.



this class

ExtAngular 6.7.0