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





Simple class that represents a Request that will be made by any Ext.data.proxy.Server subclass. All this class does is standardize the representation of a Request as used by any ServerProxy subclass, it does not contain any actual logic or perform the request itself.

No members found using the current filters


Optional Configs

action : String

The name of the action this Request represents. Usually one of 'create', 'read', 'update' or 'destroy'.

getAction : String

Returns the value of action



setAction (action)

Sets the value of action


action :  String

binary : Boolean

True to request binary data from the server. This feature requires the use of a binary reader such as Ext.data.amf.Reader

Defaults to:


getBinary : Boolean

Returns the value of binary



setBinary (binary)

Sets the value of binary


binary :  Boolean

callbackKey : String

Some requests (like JsonP) want to send an additional key that contains the name of the callback function.

getCallbackKey : String

Returns the value of callbackKey



setCallbackKey (callbackKey)

Sets the value of callbackKey


callbackKey :  String

disableCaching : Boolean

Whether or not to disable caching for this request.

Defaults to:


getDisableCaching : Boolean

Returns the value of disableCaching



setDisableCaching (disableCaching)

Sets the value of disableCaching


disableCaching :  Boolean

headers : Object

Some requests (like XMLHttpRequests) want to send additional server headers. This configuration can be set for those types of requests.

getHeaders : Object

Returns the value of headers



setHeaders (headers)

Sets the value of headers


headers :  Object

jsonData : Object

This is used by some write actions to attach data to the request without encoding it as a parameter.

getJsonData : Object

Returns the value of jsonData



setJsonData (jsonData)

Sets the value of jsonData


jsonData :  Object

method : String

The HTTP method to use on this Request. Should be one of 'GET', 'POST', 'PUT' or 'DELETE'.

Defaults to:


getMethod : String

Returns the value of method



setMethod (method)

Sets the value of method


method :  String

operation : Ext.data.operation.Operation

The operation this request belongs to.

setOperation (operation)

Sets the value of operation


operation :  Ext.data.operation.Operation

params : Object

HTTP request params. The Proxy and its Writer have access to and can modify this object.

getParams : Object

Returns the value of params



setParams (params)

Sets the value of params


params :  Object

password : String

Most oData feeds require basic HTTP authentication. This configuration allows you to specify the password.

getPassword : String

Returns the value of password



setPassword (password)

Sets the value of password


password :  String

proxy : Ext.data.proxy.Proxy

The proxy this request belongs to.

getProxy : Ext.data.proxy.Proxy

Returns the value of proxy



setProxy (proxy)

Sets the value of proxy


proxy :  Ext.data.proxy.Proxy

url : String

The url to access on this Request.

getUrl : String

Returns the value of url



setUrl (url)

Sets the value of url


url :  String

username : String

Most oData feeds require basic HTTP authentication. This configuration allows you to specify the username.

getUsername : String

Returns the value of username



setUsername (username)

Sets the value of username


username :  String

withCredentials : Boolean

This field is necessary when using cross-origin resource sharing.

Defaults to:


getWithCredentials : Boolean

Returns the value of withCredentials



setWithCredentials (withCredentials)

Sets the value of withCredentials


withCredentials :  Boolean

xmlData : Object

This is used by some write actions to attach data to the request without encoding it as a parameter, but instead sending it as XML.

getXmlData : Object

Returns the value of xmlData



setXmlData (xmlData)

Sets the value of xmlData


xmlData :  Object



Instance Methods

constructor ( [config] )

Creates the Request object.


config :  Object (optional)

Config object.

getParam ( key ) : Object

Gets a single param from the params.


key :  String

The key for the param.



The value for the param. undefined if it does not exist.

setParam ( key, value )

Sets a single param value in the params.


key :  String

The key to set.

value :  Object

The value to set.

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