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


Ext.chart.legend.SpriteLegend alias: legend.sprite premium

NPM Package





This class uses Ext.draw.sprite.Sprite to render the chart legend.

The DOM legend is essentially a data view docked inside a draw container, which a chart is. The sprite legend, on the other hand, is not a foreign entity in a draw container, and is rendered in a draw surface with sprites, just like series and axes.

This means that:

  • it is styleable with chart themes
  • it shows up in chart preview and chart download
  • it renders markers exactly as they are in the series
  • it can't be styled with CSS
  • it doesn't scroll, instead the items are grouped into columns, and the legend grows in size as the number of items increases
No members found using the current filters


Optional Configs

background : Object

Set the legend background. This can be a gradient object, image, or color. This config works similarly to the Ext.chart.AbstractChart#background config.

Defaults to:


getBackground : Object

Returns the value of background



setBackground (background)

Sets the value of background


background :  Object

border : Object

The border that goes around legend item sprites. The type of the sprite is determined by this config, while the styling comes from a theme Ext.chart.theme.Base. If both this config and the theme provide values for the same configs, the values from this config are used. The sprite class used a legend border should have the isLegendBorder property set to true on the prototype. The legend border sprite should also have the x, y, width and height attributes that determine it's position and dimensions.

getBorder : Object

Returns the value of border



setBorder (border)

Sets the value of border


border :  Object

chart : Ext.chart.AbstractChart

The chart that the store belongs to.

Defaults to:


getChart : Ext.chart.AbstractChart

Returns the value of chart



setChart (chart)

Sets the value of chart


chart :  Ext.chart.AbstractChart

docked : String

The position of the legend in the chart. Possible values: 'bottom' (default), 'top', 'left', 'right'.

Defaults to:


getDocked : String

Returns the value of docked



setDocked (docked)

Sets the value of docked


docked :  String

hidden : Boolean

Toggles the visibility of the legend.

Defaults to:


getHidden : Boolean

Returns the value of hidden



setHidden (hidden)

Sets the value of hidden


hidden :  Boolean

padding : Number

The padding amount between legend items and legend border.

Defaults to:


getPadding : Number

Returns the value of padding



setPadding (padding)

Sets the value of padding


padding :  Number

store : Ext.chart.legend.store.Store

The Ext.chart.legend.store.Store to bind this legend to.

Defaults to:


setStore (store)

Sets the value of store


store :  Ext.chart.legend.store.Store

toggleable : Boolean

true to allow series items to have their visibility toggled by interaction with the legend items.

Defaults to:


getToggleable : Boolean

Returns the value of toggleable



setToggleable (toggleable)

Sets the value of toggleable


toggleable :  Boolean



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