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 and inheritance. This is done using the checkboxes at the top of the page. Note that filtering out private members also filters the API class navigation tree.

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 Web Application Manager 6.0.0


Secure File API

Sencha Web Application Client provides an encrypted file system where applications can store files. These files are isolated from all other applications in the user's organization. Files stored in one application cannot be read by or written to from another application.


To make reading and writing files easy, Sencha Web Application Client exposes a simple key/value store for files. This API is optimized for the common file operations of read, write, and list.

Each SecureFiles collection essentially represents a named "bucket" of files; to create or fetch a collection, we use the API:

Sample Code
Ext.onSpaceReady().then(function() {

    var collection ='secrets');


Once we have a collection, we simply get/set values to read/write contents. Collection methods return promises, so we run code the typical way:

Sample Code
collection.get('users.txt').then(function(contents) {
    // do something with the contents

collection.set({ name:'groups.txt', type:'text/plain'}, 'Placeholder!').then(function(file) {
    // done!

Note the file parameter to the promise callback in the .set snippet. That's an instance of, an object that Sencha Web Application Client uses to encapsulate file metadata. It's got a few properties like .type for the MIME type, .created for the creation date, and so forth, but for the most part, we treat it as a simple container object with shortcut methods to give us access to functionality like loading contents, viewing the file, and so forth.

For example, we can query our collection to get a list of the files available, and then conditionally load the contents of the ones in which we are interested:

Sample Code
var myFiles = [{
    name: "foo.txt"
}, {
    name: "bar.txt"

// fetch every file
collection.query().then(function(files) {
    // create a list of the names we're interested in
    var myFileNames = {

    files.forEach(function(file) {
        // is this file interesting, i.e., is it in myFiles?
        var pos = myFileNames.indexOf(;
        if (pos > -1) {
            // retrieve the contents
            file.getContents().then(function(contents) {
                // store the contents in the original array
                myFiles[pos].contents = contents;

The query method does more than simply list files; it can also filter them. For one example:

Sample Code
var aWeekAgo = new Date((new Date).getTime() - (1000 * 60 * 60 * 24 * 7));

// retrieve all text files created within the past week
collection.query({ createdAfter: aWeekAgo, type: 'text/plain'}).then(function(files) {
    // do something with them

Sencha Web Application Client makes it easy to launch the file viewer for a particular file; just pass the file name:

Sample Code
collection.view('legal.txt').then(function() {
    // viewer launched!

Finally, Sencha Web Application Client has built in support for uploading files to a form processor:

Sample Code
collection.query('avatar.jpg').then(function(avatarFile) {
        url: "", // form processor URL
        fileFieldName: "imgfile"              // name of the form field to use
    }).then(function(response) {
        // inspect the response

Those are the basics, but there is a lot more. See for more details on the API.

SecureFiles Example

For a more realistic demonstration of the APIs, we also provide the SecureFiles example application in our github repository:

In the SecureFiles example we use our camera API to fetch files from the phone's library and store them in the application's encrypted filesystem. The images are then retrieved and displayed in a list.

First, we need to create a collection where we want to store all of the photos. Think of collections as folders, an application can have as many folders as it needs. If a collection does not exist it's automatically created:

Sample Code
Ext.onSpaceReady().then(function() {

    photos ='photos');


Next, to fetch a photo from the user's library, we use the API:

Sample Code
var result ={
        quality: 75,
        width: 200,
        height: 200,
        source: 'library',
        encoding: 'jpeg',
        destination: 'data'

In the above code we create a 200x200 pixel thumbnail of the selected image before storing it. By specifying the destination as 'data', we instruct the capture call to return the image data as a base-64 encoded string.

When the promise returns, we can store the image by calling a set on the photos collection:

Sample Code
result.then(function(image) {
    log("user chose image");
    photos.set(new Date().getTime()+".jpg", image).then(function() {
        log("image saved");

Next, to display all of the photos in the collection, we use

Sample Code
photos.keys().then(function(fileNames) {
    log("image count: " + fileNames.length);
    if(fileNames.length == 0) {
        div.innerHTML = "No Images";
    for(var i =0, l = fileNames.length; i<l; i++) {
        photos.get(fileNames[i]).then(function(content) {
            var img = document.createElement("img");
            img.src = "data:image/jpeg;base64," + content;

In this code, we loop over each of the image file names and fetch the contents of each photo. Once we have the contents of the photo we create a data URI and assign it to the source of an image.

For complete source code, see

Sencha Web Application Manager 6.0.0

Ext JS
Sencha Test
Sencha Themer
IDE Plugins
Sencha Inspector
Sencha Fiddle

Sencha Test

2.0.0 EA 1.0.3



Sencha Themer

Sencha Themer


5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle