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.

Cmd 7.6.0


Closure Compiler Configuration

Sencha Cmd 7.0.0 ships with an upgraded Closure Compiler and enhances developer control over compression options provided through the Closure API.

Compression Level

Google's closure compiler API gives developers fine-grain control over the compression level of source code run through the compiler. With Cmd 7.0.0 you can easily change compression levels to enhance code obfuscation and reduce footprint size to meet your requirements.

To get started, update your app.json to specify the closure compiler as your app's compressor. The below snippet is setting the closure compiler as the production compressor.

     * Settings specific to production builds.
    "production": {
        "output": {
            "appCache": {
                "enable": true,
                "path": "cache.appcache"
        "loader": {
            "cache": "${build.timestamp}"
        "cache": {
            "enable": true
        "compressor": {
            "type": "closure"

The Closure Compiler API provides three different levels of compression: WHITESPACE_ONLY, SIMPLE_OPTIMIZATION, and ADVANCED_OPTIMIZATION. With Cmd 7.0.0 you can use all three levels. If no level is set in your app.json the default will be SIMPLE_OPTIMIZATION. Details about the different compression levels are available in the Closure API.

To specify compression level, update the "compressor" object from the example snippet above to include a "compression" object, setting it's value to one of the following strings:

  • "whitespace" removes comments, line breaks, unecessary space, etc.
  • "simple" default level equals "whitespace" + syntactically valid members (functions, expressions, variables, etc.)
  • "advanced" maximum optimization that uses the "simple" compression and adds to it an assumption-based code removal and reduction algorith.

Example Configuration

    "compressor": {
        "type": "closure",
        "compression": "advanced" // ADD THIS LINE

Note: "advanced" compression settings can result in production code that does not run. Review how the advanced compression mode works by consulting the Closure API.

Additional logging has been added to Cmd 7.0.0 to provide better introspection of the compilation process, compression level, transpilation, etc. when the closure compiler is set as the compressor type.

Warning Level

The Closure API states the following configuration options to control the noise level of warning reporting:

The warning_level indicates the amount of information you want from the compiler about possible problems in your code. The warning_level parameter only has an effect when an output_info parameter with a value of warnings is also supplied. There are three possible warning levels:

QUIET Outputs only syntax error messages and warnings generated by the optimization passes included in the compilation_level for the current compiler run.

DEFAULT In addition to syntax errors and warnings generated by optimization passes, outputs warnings generated by selected code-checking passes.

VERBOSE In addition to syntax errors and warnings generated by optimization passes, outputs warnings generated by all code-checking passes.

The warning_level parameter defaults to a value of DEFAULT.

Sencha Cmd provides the "warningLevel" configuration for the compressor object in your app's app.json.

 "compressor": {
    "type": "closure",
    ""warningLevel": "quiet"" // ADD THIS LINE

Cmd 7.6.0