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

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.

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 Cmd 6.x

Guides
API
top
{
    /**
     * The relative path to the appliaction's markup file (html, jsp, asp, etc.)
     */
    "indexHtmlPath": "index.html",

    /**
     * List of all JavaScript assets in the right execution order.
     *
     * Each item is an object with the following format:
     *
     *      {
     *          // Path to file. If the file is local this must be a relative path from
     *          // this app.json file.
     *          //
     *          "path": "path/to/script.js",   // REQUIRED
     *
     *          // Set to true on one file to indicate that it should become the container
     *          // for the concatenated classes.
     *          //
     *          "bundle": false,    // OPTIONAL
     *
     *          // Set to true to include this file in the concatenated classes.
     *          //
     *          "includeInBundle": false,  // OPTIONAL
     *
     *          // Specify as true if this file is remote and should not be copied into the
     *          // build folder. Defaults to false for a local file which will be copied.
     *          //
     *          "remote": false,    // OPTIONAL
     *
     *          // If not specified, this file will only be loaded once, and cached inside
     *          // localStorage until this value is changed. You can specify:
     *          //
     *          //   - "delta" to enable over-the-air delta update for this file
     *          //   - "full" means full update will be made when this file changes
     *          //
     *          "update": "",        // OPTIONAL
     *
     *          // A value of true indicates that is a development mode only dependency.
     *          // These files will not be copied into the build directory or referenced
     *          // in the generate app.json manifest for the micro loader.
     *          //
     *          "bootstrap": false   // OPTIONAL
     *      }
     *
     * To use ext-all-debug.js instead of explicitly loading all framework files at
     * dev time, add the following entry to this js list :
     *
     *      {
     *          "path": "${ext.dir}/build/ext-all-debug.js"
     *      }
     *
     * Note: when using ext-all-debug.js, you also need to disable the loadOrder portion
     * of the bootstrap manifest.  See the "bootstrap" property for details.
     *
     */
    "js": [
        {
            "path": "app.js",
            "bundle": true
        }
    ],

    /**
     * List of all CSS assets in the right inclusion order.
     *
     * Each item is an object with the following format:
     *
     *      {
     *          // Path to file. If the file is local this must be a relative path from
     *          // this app.json file.
     *          //
     *          "path": "path/to/stylesheet.css",   // REQUIRED
     *
     *          // Specify as true if this file is remote and should not be copied into the
     *          // build folder. Defaults to false for a local file which will be copied.
     *          //
     *          "remote": false,    // OPTIONAL
     *
     *          // If not specified, this file will only be loaded once, and cached inside
     *          // localStorage until this value is changed. You can specify:
     *          //
     *          //   - "delta" to enable over-the-air delta update for this file
     *          //   - "full" means full update will be made when this file changes
     *          //
     *          "update": ""      // OPTIONAL
     *      }
     */
    "css": [
        {
            // this entry uses an ant variable that is the calculated
            // value of the generated output css file for the app,
            // defined in .sencha/app/defaults.properties
            "path": "${build.out.css.path}",
            "bundle": true
        }
    ],

    /**
     * This option is used to configure the dynamic loader. At present these options
     * are supported.
     *
     *      "loader": {
     *          // This property controls how the loader manages caching for requests:
     *          //
     *          //   - true: allows requests to receive cached responses
     *          //   - false: disable cached responses by adding a random "cache buster"
     *          //   - other: a string (such as the build.timestamp shown here) to allow
     *          //     requests to be cached for this build.
     *          //
     *          "cache": "${build.timestamp}",
     *
     *          // When "cache" is not true, this value is the request parameter used
     *          // to control caching.
     *          //
     *          "cacheParam": "_dc"
     *      },
     *
     */


    /**
     *  "compressor": {
     *      "type": "closure",
     *      "languageIn": "ECMASCRIPT5"
     *  }
     *
     */
    "compressor": null,

    /**
     * override objects for setting build environment specific
     * settings.
     */
    "production": {
        "compressor": {
            "type": "yui"
        },
        "cache": {
            "enable": true
        }
    },

    "testing": {
    },

    "development": {
    },


    /**
     *  Controls the output structure of bootstrap artifacts.  May be specified by a string:
     *
     *      "bootstrap": "${app.dir}"
     *
     *  to adjust the base path for all bootstrap objects, or expanded into object form:
     *
     *      "bootstrap": {
     *          "base": "${app.dir},
     *          "manifest": "bootstrap.json",
     *          "microloader": "bootstrap.js",
     *          "css": "bootstrap.css"
     *      }
     *
     *  To disable "loadOrder" metadata when using a framwork build file such as
     *  ext-all-debug.js, use the expanded form of the manifest property:
     *
     *      "bootstrap": {
     *          "manifest": {
     *              "path": "bootstrap.json",
     *              "exclude": "loadOrder"
     *          }
     *      }
     *
     */
    "bootstrap":{
        "base": "${app.dir}"
    },

    /**
     *  Controls the output directory for build resources.  May be set with
     *  either a string:
     *
     *      output: ""
     *
     *  or an object containing values for various types of
     *  build artifacts:
     *
     *      "output": {
     *          "base": "${workspace.build.dir}/${build.environment}/${app.name}",
     *          "page": {
     *              "path": "../index.html",
     *              "enable": false
     *          },
     *          "css": "${app.output.resources}/${app.name}-all.css",
     *          "js": {
     *              "path": "app.js",
     *              "enable": true,
     *              "optimize": {
     *                  "defines": true,
     *                  "callParent": true,
     *                  "requires": true,
     *               }
     *          },
     *          "microloader": {
     *              "path": "microloader.js",
     *              "embed": true,
     *              "enable": true
     *          },
     *          "manifest": {
     *              "path": "app.json",
     *              "embed": false,
     *              "enable": "${app.output.microloader.enable}"
     *          },
     *          "resources": "resources",
     *          "slicer": {
     *              "path": "${app.output.resources}/images",
     *              "enable": false
     *          },
     *          // Setting the "enable" property of this object to a Truthy value will cause a Application Cache
     *          // manifest file to be generated based on this files appCache object. This file will then be injected
     *          // into the index.html file of the built application
     *          "appCache":{
     *              "enable": false"
     *          }
     *      }
     */
    "output": {
        "base": "${workspace.build.dir}/${build.environment}/${app.name}",
        "appCache": {
            "enable": false
        },
        "microloader": {
            "enable": true
        }
    },

    /**
    * Controls for localStorage caching
    *   "cache": {
    *       // This property controls whether localStorage caching of this manifest file is on or off.
    *       // if disabled no deltas will be generated during a build and full updates will be disabled
    *       "enable": false,
    *
    *       // This property allows for global toggle of deltas.
    *       // If set to a string the value will be used as the path to where deltas will be generated relative to you build.
    *       // If set to a Truthy Value the default path ok "deltas" will be used
    *       // If set to a Falsey value or if this property is not present deltas will be disabled and not generated.
    *       //
    *       "deltas": "deltas"
    *   }
    */
    "cache": {
        "enable": false,
        "deltas": "deltas"
    },

    /**
     * This sets the default output folder for cordova packagers builds
     *
     *      // Cordova Packager Config options
     *      "config": {
     *
     *          // 'name' This is the name of your cordova application. This will default to your Sencha App name.
     *          // This is only used once during Cordova app creation and cannot be changed after.
     *          "name": "AppNameForCordova",
     *
     *          // 'id' This will be your package name for Android and your Bundle Identifier for iOS
     *          // This is only used once during Cordova app creation and cannot be changed after
     *          "id": "com.domain.AppName",
     *
     *          // 'platform' can be a platform or a space seperated list of platform (ios android)
     *          // platform supported on mac: ios, amazon-fireos, android, blackberry10, firefoxos
     *          // platform supported on win: wp7, wp8, windows8, amazon-fireos, android, blackberry10, firefoxos
     *          "platform": "ios"
     *
     *          // 'verbose' This boolean will determine if all cordova commands will have verbose output or not.
     *          // to properly see this run sencha command with the '-info' flag like the following
     *          // sencha -info app run [buildname]
     *
     *          // 'path' The path this builds cordova project should be created in.
     *          // This defaults to your {app.dir}/cordova
     *
     *          // 'target' This is the target for emulator/simulator commands.
     *          // On Android is the name of your Android Virtual Device
     *          // For iOS it is one of the following:
     *          // "iPhone (Retina 3.5-inch)"
     *          // "iPhone (Retina 4-inch)"
     *          // "iPhone"
     *          // "iPad"
     *          // "iPad (Retina)"
     *
     */
    "cordova": {
        "config": {
            "name": "${app.name}",
            "id": "com.domain.${app.name}",
            "verbose": false,
            "target": "",
            "path": "${app.dir}/cordova"
        },
        "js": [
            {
                "path": "cordova.js",
                "remote": true,
                "priority": 1000
            }
        ],
        "microloader": "${app.config.dir}/Microloader.js",
        "output": {
            "base": "${app.cordova.config.path}/www",
            "page": "index.html",
            "manifest": "${build.id}.json",
            "appCache": {
                "enable": false
            }
        },
        "cache": {
            "enable": false
        }
    },

    /**
     * This sets the default output folder for phonegap packagers builds
     *
     *      // Phonegap Packager Config options
     *      "config": {
     *
     *          // 'name' This is the name of your phonegap application. This will default to your Sencha App name.
     *          // This is only used once during Phonegap app creation and cannot be changed after.
     *          "name": "AppNameForCordova",
     *
     *          // 'id' This will be your package name for Android and your Bundle Identifier for iOS
     *          // This is only used once during Phonegap app creation and cannot be changed after
     *          "id": "com.domain.AppName",
     *
     *          // 'platform' a single platform to build, run or emulate
     *          // platform supported locally: android, ios, wp8, Blackberry 10
     *          // platform supported remotely: android, ios, wp8
     *          //"platform": "ios"
     *
     *          // 'remote' This boolean will determine if the build should be run on Phonegap's remove server 'http://build.phonegap.com'
     *          // setting remote to true will attempt to build on the cloud.
     *          // To properly use this one must set the following properties in there local.properties file (if this file does not exist create it in your app root)
     *          // phonegap.remote.username=myname@domain.com
     *          // phonegap.remote.password=mys3cr3tp@ssw0rd
     *
     *          // 'verbose' This boolean will determine if all phonegap commands will have verbose output or not.
     *          // to properly see this run sencha command with the '-info' flag like the following
     *          // sencha -info app run [buildname]
     *
     *          // 'path' The path this builds phonegap project should be created in.
     *          // This is only used once during Phonegap app creation if changed this will result in a new phonegap application being generated
     *          // This defaults to your {app.dir}/phonegap
     *
     */
    "phonegap": {
        "config": {
            "name": "${app.name}",
            "id": "com.domain.${app.name}",
            "remote": false,
            "verbose": false,
            "path": "${app.dir}/phonegap"
        },
        "js": [
            {
                "path": "cordova.js",
                "remote": true,
                "priority": 1000
            }
        ],
        "microloader": "${app.config.dir}/Microloader.js",
        "output": {
            "base": "${app.phonegap.config.path}/www",
            "page": "index.html",
            "manifest": "${build.id}.json",
            "appCache": {
                "enable": false
            }
        },
        "cache": {
            "enable": false
        }
    },

    /**
     * Additional resources used during theme slicing operations
     */
    "slicer": {
        "js": [
            {
                "path": "${app.dir}/sass/example/custom.js",
                "isWidgetManifest": true
            }
        ],
        "output": {
            "appCache": {
                "enable": false
            }
        },
        "cache": {
            "enable": false
        }
    },

    /**
     *
     */
    "fashion": {
        "inliner": {
            "enable": false
        }
    }

    /**
     * The manager config object is used by the sencha app publish command to deploy this application to sencha web application manager
     * "manager": {
     *     // the space id for this application
     *     "id": 12345,
     *     // name of app in space deployments
     *     "name": "${app.name}",
     *     // space host
     *     "host": "https://api.space.sencha.com/json.rpc",
     *     // can be a zip file path, or a folder to be zipped and deployd to sencha space
     *     "file": "${app.output.base}",
     *     // These may be specified here, but are best specified in your user
     *     // ~/.sencha/cmd/sencha.cfg file
     *     "apiKey": "",
     *     "secret": ""
     * }
     */
}

Sencha Cmd 6.x

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation