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.

Architect 4.2


What’s New in Architect 4.2.7

Support for ExtJs 7.1

Architect 4.2.7 supports creating applications with the latest Ext JS 7.1 framework.

Support for Cmd 7.1

Architect can now utilize Cmd 7.1 For details, refer to Cmd 7.1 features.

What’s New in Architect 4.2.6

Support for Ext JS 7.0

Architect 4.2.6 supports creating applications with the latest Ext JS 7.0 framework.

Support for Cmd 7.0

Architect can now utilize Cmd 7.0 For details, refer to Cmd 7.0 features.

What’s New in Architect 4.2.5

Support for Ext JS 6.7

Sencha Architect 4.2.5 support Ext JS 6.7 that contains new features. Architect provides support for building apps with the following components:

  • Grid Filtering - Easily display grid records that meet multiple criterias of text, boolean, date, number filters
  • Locking Grid - Similar to Excel, lock columns in left or right region
  • Multiselect Combobox - Combobox with the ability to select multiple chips
  • Multiselect Select - Easily select multiple values in the select field
  • Color Picker - Beautiful color picker with HSVA and RGB options

Support for Cmd 6.7

Architect can now utilize Cmd 6.7 For details, refer to Cmd 6.7 features.

What’s New in Architect 4.2.4

We’re excited to announce that Sencha Architect 4.2.4 is now generally available, providing support for Ext JS 6.6 and Cmd 6.6. With Architect 4.2.4, you can visually build apps using new Ext JS 6.6 components such as Time Panel and Time Field, and use the new beautiful Graphite theme, and build projects with Cmd 6.6. This release will enable you to quickly build sophisticated web applications using Ext JS 6.6.

Visually build Ext JS views using new Ext JS components

You can use Architect to drag and drop new Time Panel and Time Field components and generate application code. You get access to all of the configuration parameters of components, set layouts, add custom configs, add events and create overrides with minimal manual coding.

Easily apply built-in Graphite accessible theme to your app

Architect 4.2.4 supports the new accessible Graphite theme. You can easily drag and drop the theme, apply it to your application, and customize the theme.

Easy migration to Ext JS 6.6 framework

Architect provides options to easily upgrade applications built using older versions of the framework to Ext JS 6.6. You can upgrade to the latest version of the Ext JS framework when you right click on ‘Library’ in the Resources section of Sencha Architect.

What's New in Architect 4.2.3

Architect 4.2.3 supports Ext JS 6.5.3 and Cmd 6.5.3.

Check out our change log for a complete list changes.

Ext JS 6.5.3

Architect can now utilize Ext JS 6.5.3. Ext JS 6.5.3 contains many new features.

Cmd 6.5.3

Architect can now utilize Cmd 6.5.3. For details, pl. refer to Cmd 6.5.3 features.

Easily import Premium add-ons in Architect

Architect 4.x supports all Sencha premium packages, so that you can use D3, Calendar, Pivot Grid, and Exporter in either modern and classic toolkit based applications. With Architect 4.2.3, you can easily import premium add-ons in your Architect project.

What's New in Architect 4.2

Architect 4.2 provides support for Ext JS 6.5 and Cmd 6.5, adds a new modern project template, and includes some new menu items for easier project management.

Check out our change log for a complete list changes.

Ext JS 6.5.0

Architect can now utilize Ext JS 6.5.0. Ext JS 6.5.0 contains many new features, especially within the modern toolkit.

Cmd 6.5.0

Architect can now utilize Cmd 6.5.0. Cmd 6.5.0 now supports ES6 syntax, dynamic package loading, and a whole lot more.

Restart app watch

Users can now stop app watch when it is unnecessary to run after each save. Users can also restart app watch when there are build issues.

Note: App watch is automatically started on project open.

Reinitalize Cmd

Users can now remove and add again Sencha Cmd from their project with a single click. Sometimes there can be problems that are solved by removing and adding Cmd back again.

Note: This removes all Sencha Cmd related files such as app.json and others.

Offline license

Users can now select their offline licenses via file picker instead of manually placing their files.

Electron Wrapper

Architect's electron wrapper has been updated to version 1.6.2.

Architect 4.2