Docs Help

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.

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

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

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.

Sencha Test 2.3.0


Standalone Selenium Servers

Download and Setup

Download the latest version of Selenium Server from

Based on your browser needs, download the necessary drivers from the same location. You need a driver per browser.

Firefox needs the new Gecko driver for browser versions greater than 45. Once you have downloaded the drivers successfully,add them to the system path so they are globally available, or place them in the same directory as the Selenium Server .jar file. This will ensure that the server is able to communicate with the browsers.

If you have an existing version of Selenium server, please make sure you upgrade to at least version 3.0 as Gecko driver has some known issues with older versions of Selenium Server.

Starting the Selenium Server

Start the selenium server with chrome driver from the command line.

java -jar selenium-server-standalone.jar

By default, this will start the Selenium Server instance on port 4444. The port can be changed by setting the -port flag:

java -jar selenium-server-standalone-3.11.0.jar -port 5555

Verify Selinun Server is Running

Before you run against the selenium server, verify it's working by loading http://localhost:4444. Then go to the console and select create session. The goal is to verify you can create a session with out errors. If you can start a browser session it's ready to receive commands from Sencha Test.

Defining a Selenium Server Configuration in Sencha Studio

Sencha Test allows easy configuration of a Selenium farm.

  1. Navigate to the "Browsers" tab in Sencha Studio.

    Browsers tab in Sencha Studio

  2. Select Add --> Generic WebDriver and give your WebDriver farm a suitable display name.

    Create Selenium Farm

  3. After adding, the Selenium Server configuration will show up in the list of Browser Farms. Select it, and provide the IP address of the machine (localhost, if same machine) where the Selenium server will be running and enter 4444 for the port value.

    Note: If you want to use browsers in this farm with the event recorder, check the "Enable in event recorder" option, and browsers in the farm will show up for selection when launching the event recorder within a test suite. For a list of supported browsers with the event recorder, see the Event Recorder Browser Support guide.

    Browser farm configuration screen

  4. Press Save.

  5. Right-click on the Selenium farm and select "Add pool...".

    Add browser pool

  6. Give a name for the browser pool and select a location to save the pool configuration file. We recommend that you save the pool configuration file within the workspace.

  7. Click on the pool that you just created.

  8. Select and add browsers using the drop-down list at the bottom of the browser pool screen.

    Adding browsers to the browser pool

  9. Once added, you can select each browser from the grid and define a platform, browser version, etc. After you have made your changes, click Save.

    Note: Make sure you have downloaded the browser drivers as stated above.

    Configuring browsers in the browser pool

Common Errors

  1. I get a timeout error when running Sencha Test against my Selenium standalon server.
    • a. First verify you can create a browser session in the http://localhost:4444. This will let you know it's working.
    • b. Verify you have the correct url entered into sencha test. This means no http:// or http:// in the host input for generic web driver.
    • c. Double check your selenium server standalon configuration has a chrome driver or other driver added to it when starting.

Sencha Test 2.3.0