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.

Sencha Test 2.0.0

Show private classes

top

Command Line Syntax Required Flags Image Comparison Cloud-based Browser Farm Options Setting up a Result Archive Server Starting the Archive Server Archive Server Connection Options Expected Output Running Multiple Scenarios as a Single Build Result Merging Archive Server Configuration STC Command

CLI and the Archive Server

In order to provide integration with continuous integration (CI) servers like Jenkins and Teamcity, Sencha Test allows you to execute tests for an existing scenario from the command-line. The command-line tool doesn't support launching of local browsers, which means a browser farm and browser pool must be configured for the target scenario.

Let's walk through executing a test via CLI.

Command Line Syntax

The basic command-line syntax for executing a test from the command line is as follows:

stc run -o output -p pool -s scenario

Required Flags

Here are the optional flags that may be passed along via your command line execution:

-o <output> - Output format. Supported values are text, teamcity and junit

-p <pool> - Name of the pool from whence tests will be executed. This must be a pool associated with a browser farm

-s <scenario> - Path to the scenario to be executed. If unspecified, defaults to the current directory.

In the following example to be run from a Windows command line, we are executing tests for:

The scenario located at tests\unit_tests
In the browser pool called My WebDriver Pool

Providing output in TeamCity format

  stc run -o teamcity -p "My WebDriver Pool" -s tests\unit_tests

Image Comparison

To perform image comparisons from screenshots, Sencha Test will use an existing run as the reference (baseline) against which each image will be compared. If a baseline for comparison is not present, all comparisons will pass, and the resulting archive directory can then be specified as the baseline for future comparisons.

To use a specific result archive as baseline, it has to be copied or renamed to ${workspace.dir}/reports/baseline. Alternatively, the -b switch can be used to specify any arbitrary result archive directory.

-b <baseline> - Path to the result archive directory to be used as baseline for image comparisons

By default, Sencha Studio will assign a dynamically generated build number to each test execution. To specify the build number for a given test run, the -n switch can be used.

-n <build_number> - Build number for the test execution

By specifying the baseline directory and the build number, it's possible to control all the directory and file names associated with the test execution. This way, one can easily archive test results and fetch arbitrary baselines in a CI system.

Cloud-based Browser Farm Options

In order to execute tests in a cloud-based browser farm such as SauceLabs or BrowserStack, you can specify credentials, callback addresses while controlling the automatic launch of the provider's tunnel. Here are the options that may be applied:

-u <username> - Username for the browser farm

-k <key> - Access key for the browser farm

--notunnel - If specified, disables the automatic launch and teardown of the tunnel to the specified cloud provider. When this switch is used, a tunnel for the specified username must be already running, either in the local machine or in a dedicated host in the same network.

Note: The auto-connecting tunnel feature will not be available in the early access or beta releases. All tunnels will need to be manually created until auto-connection is available.

-c <callback_address> - Callback address - host or IP by which the farm browsers can dial back to Sencha Test's proxy. If unspecified, defaults to localhost. This switch is particularly useful when a dedicated tunnel is being used. In such case, it's likely to be the local machine's LAN ip address.

In the following example to be run from a Linux command line, we are executing tests for:

Tests found within tests\unit-tests
In the pool named SauceLabs pool
Providing output in Jenkins format
Using the credentials username:xxxxx-xxxx-xxxx-xxxx-xxxxx will be used
A SauceConnect tunnel will not be launched automatically. This means the user is responsible for starting one manually.
All browsers will attempt to connect to http://192.168.1.42

Example:

stc run -o junit -p "SauceLabs pool" -s tests\unit_tests -u user -k *x-x-x-x-x* --notunnel -c *192.168.1.42*

Setting up a Result Archive Server

Sencha Test provides a component called "result archive server". This is the area in which test results can be stored for later review via the Sencha Test Studio GUI.

To set up an archive server, a configuration file called storage.json has to be created. This file must contain one or more storage area definitions.

A storage area is defined as a property whose name is the key that users need to know in order to store results. The value is an object containing the physical path where its archives will be stored relative to the server root directory.

Here is a sample storage area.

{
    "my_storage_key": {
        "path": "/mystoragearea"
    }
}

Note: Users must know the key my_storage_key in order to store test results in your archives under /mystoragearea on the designated server. The key itself can be any value.

These paths may contain multiple directory levels. These paths don't hold any special meaning. They can be reviewed by the server administrator in order to organize the test results archives and/or provide isolation across teams and projects. The keys are free-format strings.

In the following example, storage areas are separated by team. Each team, developers and qa in this case, need to know their key in order to store results in their respective storage areas.

{
    "889jwx093jr8wuwer": {
        "path": "/developers"
    },

    "sccmnn840394843": {
        "path": "/qa"
    }
}

In the next example, teams have isolated storage areas for each of their projects.

{
    "879fnas9d8jf70sd": {
        "path": "/TeamA/project1"
    },

    "mx348r343mr34cj": {
        "path": "/TeamA/project2"
    },

    "sdnaaa090ilss": {
        "path": "/TeamB/project1"
    }
}

Starting the Archive Server

To start the result archive server, create a storage.json file in a dedicated directory and from there, run the following from your CLI:

stc server

You should then see a success message:

Archive server listening on port 1903

Here's an example of how you'd set up your Archive Server on a machine:

mkdir archiveserver
cd archiveserver
vim storage.json #configure storage areas - see examples above
stc server

Archive Server Connection Options

In order to send the result archive to a configured archive result server, you may use the following switches with stc run.

-S <server_address> - Archive server address. If the archive result server host machine IP address is 192.168.1.42, for instance, the value will be http://192.168.1.42:1903 (including the port number).

-K <key> - Key to the storage area. To store results in /TeamA/project2 (example above), the value will be mx348r343mr34cj.

In the following example, we are:

Storing results of tests\unit_tests
With an output type of teamcity
In the pool named My WebDriver Pool
On a server hosted on 192.168.1.42:1903 with port 1903
Using the key of mx348r343mr34cj

Example:

stc run -o teamcity -p "My WebDriver Pool" -s tests\unit_tests -S http://192.168.1.42:1903 -K mx348r343mr34cj

Expected Output

Outputs similar to the ones below are expected after a successful result storage on the server:

Uploading archive to http://localhost:1903
Server response: 200 - Archive received
user:~$
Client: successfully uploaded test result archive

Receiving archive 28ea1080-a2a5-11e5-ac7d-51ab7d509196.zip
Archive 28ea1080-a2a5-11e5-ac7d-51ab7d509196.zip extracted to /home/user/archiveserver/TeamA/project2/foo/orion/28ea1080-a2a5-11e5-ac7d-51ab7d509196
Server: successfully received test result archive

Running Multiple Scenarios as a Single Build

A single test project will often have multiple scenarios. In these cases, you may want to run multiple scenarios as part of a single "build" in your CI system. This allows you to see all of the Scenario results as a single results set in Sencha Studio.

As an example, you may have Scenario A and Scenario B and you want to run both of these whenever code is merged.

Once all of your Scenarios are complete, the Archive Server will merge the results from Scenario A and B and Sencha Studio can then display the aggregated results as one logical build or test run number.

Result Merging

Sencha Test gives you the ability to merge the results of your tests in two different ways.

Archive Server Configuration

In this method, you would need to include an allowOverwrite key to your configuration. For example:

{
    "multiscenario": {
        "path": "/multiscenario",
        "allowOverwrite": true
    }
}

STC Command

You can also add an overwrite flag to your STC command. For example:

stc run -s Dashboard -p embedded -S http://localhost:1903 -K multiscenario -n 6 --overwrite

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

Sencha Test 2.0.0

Contents

CLI and the Archive Server

Command Line Syntax

Required Flags

Image Comparison

Cloud-based Browser Farm Options

Setting up a Result Archive Server

Starting the Archive Server

Archive Server Connection Options

Expected Output

Running Multiple Scenarios as a Single Build

Result Merging

Archive Server Configuration

STC Command

Sencha Test 2.0.0