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 Architect 4.1

Guides
API
top

Using User Extensions

This guide discusses how to use user extensions in your project. See the creating user extensions guides for information about creating your own.

Incorporating User Extensions

The user extensions feature enables you to incorporate components (classes) that are developed outside of Architect into your Architect project. Components from user extensions that have been packaged for Architect can be dragged from the Toolbox, rendered in the Architect Canvas, configured through the Architect Config panel, and maintained inside Architect like any other component.

Using these extensions saves you the effort of rewriting functionality that someone else has already coded. They also include the added benefit of extensive testing extensive community use.

Architect user extensions are delivered in packages that are easily downloaded and installed. Be sure to select a package that is compatible with the framework you are using for your Architect project.

A user extension runs in its own sandbox, which provides the security that is warranted when running code that is downloaded from the web.

Downloading User Extensions

To download a user extension:

  • Log into Sencha Market.
  • Click on the "Product" tab.
  • Select your version of Architect
  • Be sure to choose an extension that is packaged for use with your version of Architect.
  • Be sure that the extension you choose works with the framework and version you are using for your project.

Installing a User Extension

To incorporate a user extension into an Architect project:

  1. Download the user extension package. This is a file with an .aux extension.
  2. Open (or start) an Architect project, using a framework with which the user extension is compatible.
  3. Click on the icon to the right of "Extensions" in the Toolbox or go to the File menu and choose "Install User Extension".
  4. When the file browser comes up, browse to the downloaded .aux file and select it.
  5. You should receive a message indicating that the extension was installed successfully.

After the extension is installed successfully, it is listed in the Toolbox in its own category below "Extensions". It will include a number in parenthesis that indicates total classes included in the extension.

Classes that are included in user extensions may also be included in other Categories. For example, the "Drag Drop Region" and "Scheduler Grid" classes are both listed under the "Containers" category.

The icon shaped like a jigsaw puzzle indicates that this class is part of a user extension. This same icon shows in the Project Inspector when a class from a user extension is used.

If the extension does not install successfully, the package is likely missing files, key configuration parameters, or have some other problem.

Architect outputs some useful debugging information into the Sencha Architect Log to help you analyze the problem.

Using Components from a User Extension Package

After you successfully install a user extension package, the components from the extension are listed in your Toolbox under the "Extensions" category, and possibly, another appropriate category.

You can drag any component to the Canvas or Project Inspector like any other component. YOu may also set its configs in the Config Panel.

Some components from user extensions automatically create more than one top-level component. For example, a special type of view might come with a store and model with pre-configured fields. When this is the case, Architect creates them as a linked group. This linkage allows Architect to warn you if you attempt to delete a component that is a member of that linked group, since these components are inter-dependent.

You can also use the keyboard shortcuts + and +- (Mac) or Ctrl++ and Ctrl+- (Windows and Linux) to cycle between selecting the components in a linked group.

When you Save or Build your project, a copy of each extension that has been used in the project is saved inside your project folder so it is included in your project going forward.

Extension developers control which config items are visible and create additional config items with reasonable default values. The end user can then tweak those values as needed.

Versioning

User extension packages are versioned. You can install multiple versions of a user extension package on your system, but only the most recent (highest numbered) package is loaded and visible in your Toolbox.

If you open a project that used an older version of that user extension package, Architect loads the older version of the package but prompts you for alternatives.

  • If you have a later version of that Extension installed (e.g. v1.1, while the project contains v1.0), you will be asked if you want to upgrade the project to use that later version. The version contained in the project will be used unless you choose to upgrade.
  • If the project contains a later version of an extension than what is currently installed in your Sencha Architect, you will be asked if you want to install that Extension so it is available to you to use in other projects.
  • If the project contains an extension that is not currently installed in your Sencha Architect, you will be asked if you want to install that extension so it is available to you to use in other projects.

Uninstalling a User Extension Package

To uninstall a user extension package from your system, right-click on the user extension in the Toolbox, then select "Uninstall Extension" from the drop-down menu:

Note: You can change the installation location for user extensions by going into the Preferences screen. Click "Preferences" on the Sencha Architect drop-down menu on Mac, or the "Edit" drop-down menu on Windows and Linux) and modify the value of the "Extensions" field:

Sencha Architect 4.1

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

Sencha Test

2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation