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.3


Team Development of Architect Projects

This guide discusses the mechanics of developing Architect applications as part of a team. The MVC application architecture that Architect uses, not only creates applications that are robust and portable, but is also conducive to a team development environment. Specialists can contribute an appropriate portion of the code, user-interface specialists create the View, and business and data experts develop the Models and Stores.

Developing an Architect application as a team includes the following steps:

  • Choose and set up a Source Code Management (SCM) system and establish appropriate policies and work flow.
  • The Project Lead sets up the application project in Architect, saves the project to create the source code tree, and checks the files into the SCM.
  • All team members install and set up Architect on their systems.
  • Team members each clone a copy of all the project files to their local systems and proceed with their development work using the "Save" button frequently to preserve what they have done.
  • Work should be checked into the SCM frequently and all members of the team should sync their local files with the files in the team repository often. If multiple people modify the same file, the changes can be merged at this point.
  • If you need to share your project with other groups, create a Project Archive (.xda file) that they can download and open on their locally-installed Sencha Architect application.

Architect includes facilities that allow you to share bits of code between different projects and different developers.

Set Up the Source Code Management System

Sencha strongly recommends that the source code for all projects be maintained under a Source Code Management (SCM) system. This provides a detailed history of all changes made to the files and backup protection for the code. Most modern SCM systems also provide tools to merge changes when multiple people modify the same file. The SCM should also enable you to maintain branches for different releases.

Sencha source code is developed under Git and our example projects are publicly available for download using Git. A number of other excellent SCMs are available and should work fine with Sencha Architect.

Before beginning your project, you should set up your SCM and define where Architect projects will be stored, who has what sort of access to the source, set up back-up procedures if appropriate, and arrange for administration and maintenance of the SCM. These topics are beyond the scope of this guide.

Start your Architect project

One person, probably the team lead, needs to start the Architect project.

Choose the framework and version you want to use and choose an appropriate App Template or choose the Blank Template to start a blank project.

Name Your Application

The first step in creating an Architect project is to name the application.

To name an application:

  1. Click "Application" at the top of the Project Inspector window located on the upper-right side of the screen.

  2. Find "name" in the config panel and set it to the name of your project, such as "MyProject". A project name should begin with a capital letter.

This sets up the Application node class that represents the application. Typically, this is a single page using a Viewport that enables all the classes in your application -- its models, views, controllers and stores -- to reside under a single namespace. When the single page is ready and all JavaScript for your application is loaded, the launch function for your application is called. The launch function typically runs the "bootstrap" code that starts your application.

For a simple application, just setting the "name" for the Application Node is usually adequate. For more complex applications, you may need to set other configurations.

Save Your Project

Follow the instructions in Save your Project to save your project.

When you first save your project, Architect creates a project directory for the project.
The dialog shows you where it is saved. The convention is to name the directory using a lowercase version of the Application name you assigned in the previous step. So, if the name you use for the Application name is "MyProject", the directory for the project would be named "myproject". This convention is not enforced by Architect but it makes it easier to keep track of what you’re doing.

See the next section for a detailed list of the files and directories Architect creates.

Check the Project Into Source Control

The entire project should be versioned with the following exceptions:

  • The .architect file, which contains user-level settings
  • bootstrap.json
  • build folder
  • ext folder

You can safely set up your SCM to ignore these files.

How Team Members Develop the Project

Each member of the development team should install and set up Sencha Architect and a web server on their local system. See the Installation and Set-Up guide for instructions.

After the project lead checks the project into SCM, each team member can clone the repository to their own system then use the "Open an Existing Project" link on the Architect Splash screen to open the project locally and begin coding.

Team members should save their work often and check their changes into SCM regularly.

Create a Project Archive

A Project Archive is a file that contains all the components of an Architect Project. It can be made available to users outside your development team, who can download it to their local disk, load it into Architect, and review or modify it. This can be useful when you want to share your Architect project with the Sencha community or others outside your project team.

To create a project archive:

  1. Be sure that the project has been built, not just saved.
  2. With the project open in Architect, go to the File menu.
  3. Select Archive Project.
  4. Give the project archive a name in the dialog box that opens, and click Save.

Architect creates a file with the .xda extension that can be uploaded to a server, sent in email, copied to a USB drive, and so forth. Another person can then download this file and open it inside Architect. If they make modifications to the project, they can create an archive that contains those changes.

The .xda file should always be checked into your SCM but archives are not meant to provide or replace source control management to store and track changes.

Sharing and Reusing Components

Each top-level component is a class that is stored in its own .js file. These components can be exported from your app to your toolbox or exported to a file that can be shared with other users. Child components can be promoted to classes so they can be shared and instances of a component can be linked so that changes applied to one instance are automatically applied to all instances. This is all discussed in greater detail in the Working with Classes guide.

Creating Custom App Templates and User Extensions

If you need to share chunks of code rather than a single class, you can create Custom App Templates that are used to start a new project or User Extensions that can be installed in the Toolbox and used like other components in different apps. See Creating App Templates and Creating User Extensions for more information.

Including Resources Developed Outside Architect

Some portions of your project code may be developed outside Architect and included as "Resources" to your project. Typically this includes:

  • JavaScript code, often code that executes the business logic for your application.
  • Customized CSS.
  • Themes developed outside Architect.
  • Specialized data files.

To add a Resource to your project:

  • One developer manually copies the file for the Resource to the appropriate location in the Project Tree on their local system.
  • From within Architect, that developer adds that Resource to the project following the instructions in Using Resources.
  • That developer should then Build and Preview the application locally to ensure that it is working with the newly added Resource.
  • Check the revised project code into the SCM for the project.
  • Other developers on the project must then sync/refresh their copies of the project to access the Resource locally.

Note that beginning with Sencha Architect 3.0, JavaScript code that is developed outside Architect can be packaged as a User Extension that is then incorporated into your project instead of including it as a resource.

See Using Resources for more information.

Architect 4.3