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

Change Log

Version 4.1.2

New Features

  • DSGNR-7621 - Full synchronization with Themer.
  • DSGNR-7606 - Added Ext JS 5.1.4.
  • DSGNR-7640 - Added Cmd 6.2.2.
  • DSGNR-7560 - Added Tab Reorder and TabCloseMenu plugins.
  • DSGNR-7480 - Added new Modern project template BigDataGrid.
  • DSGNR-7548 - Added new menu action ViewOpen Project Folder.
  • DSGNR-7593 - Added new menu action ViewToggle Full Screen.
  • DSGNR-7545 - Smaller size of the installer.

Bug Fixes

  • DSGNR-7376 - Fixed archiving of the project containing non-ASCII char in the file path.
  • DSGNR-7508 - Fixed wrong type options for some configs.
  • DSGNR-7587 - Fixed broken design view when the project is in the workspace.
  • DSGNR-7602 - Fixed usage of Ext.ux.form.ItemSelector.
  • DSGNR-7609 - Fixed usage of hasOne, hasMany, belongsTo associations in model.
  • DSGNR-7559 - Fixed usage of PagingToolbar plugin.
  • DSGNR-7618 - Fixed displaying of FontAwesome in design view.
  • DSGNR-7620 - Fixed Ext JS 5 documentation links.
  • DSGNR-7108 - Closing sencha process when SA application is killed.
  • DSGNR-7595 - Fixed custom Panel light UI.
  • DSGNR-6322 - Fixed Grid grouping listeners.
  • DSGNR-7514 - Fixed double loading of some project templates.
  • DSGNR-7539 - Added TabPanel#plugins config.
  • DSGNR-7561 - Added HeaderGroup column.
  • DSGNR-7567 - Added type string option for ActionColumnItem#handler config.
  • DSGNR-7599 - Fixed error when used extended model in the store.
  • DSGNR-7558 - Display used Grid plugins in the config window.
  • DSGNR-7325 - Display used PivotGrid#matrix in the config window.
  • DSGNR-7568 - Display used Ext.pivot.matrix.local#aggregate#leftAxis#topAxis in the config window.
  • DSGNR-7569 - Display used Ext.pivot.dimension.Item#filter in the config window.
  • DSGNR-7437 - Allowed custom type for Proxy#reader config.
  • DSGNR-7450 - Removed false error WidgetColumn needs data index.
  • DSGNR-7566 - Removed bindable of Component#id config.
  • DSGNR-7591 - Removed bindable of Ext.pivot.matrix.Local#store config.
  • DSGNR-7580 - Fixed previewing of the project templates.
  • DSGNR-7614 - Fixed main window shrinking when multi display is set on Linux.
  • DSGNR-7630 - Fixed tutorial links.
  • DSGNR-7627 - Added tooltip help for File Watcher and Fashion Live settings in Preferences.

Known Issues

  • DSGNR-7556 - Google Map component doesn't work in Ext JS 6 classic.
  • DSGNR-6654 - A black window is shown. The workaround is to run SA from command line with --disable-gpu switch.

Version 4.1.1

Bug Fixes

  • Fixed JSON error when working on the project with Column chart.
  • Fixed the issue when some users were not able to open project due to Unable to read property 'refreshRequiredPackages' from null.
  • Fixed missing rtl config in Ext 6.2 Classic.
  • Fixed Material theme not updating properly on the design view.
  • Fixed correct load of the preview url with Cmd app watch port on the project open.
  • Fixed duplicated config types on some components in Ext 6.2.
  • Fixed phantom 0 as default value when adding data to the store.
  • Fixed the Classic Login and Register example.
  • Fixed never-ending project loading caused by deprecated Google Feeds API.

Known Issues

  • Google Map component doesn't work in Ext JS 6 classic.
  • Some custom UIs created in Themer are not supported.
  • A black window is shown. The workaround is to run SA from command line with --disable-gpu switch.

Version 4.1.0

New Features

  • Added Ext JS 6.2.1.
  • Added Cmd 6.2.1.
  • Added Calendar premium component.
  • Added Pivot Grid premium component.
  • Added D3 premium package.
  • Added Pivot-D3 premium package.
  • Added Grid Exporter premium plugin.
  • Added ux form MultiSelect and ItemSelect components.
  • Added Asset Manager with the possibility to set the custom paths or remove unused assets.
  • Allow editing the extend config in classes.
  • Ability to collapse all nodes in the Project Inspector.
  • Support bidirectional Themer integration.
  • Support Themer UIs.
  • Added shortcut Ctrl+B for jump to toolbox filter.
  • Ability to add requires to app.json from Library Resources.
  • Ability to copy/paste config values.
  • Added filter to Project Inspector.
  • Updated application container to Electron 1.2.8.

Bug Fixes

  • Fixed moving the Tools item out of the tools config when reordering them.
  • Fixed the redirection of REST proxy to component alias instead of url config.
  • Fixed adding an incorrect class requirement to the model when hasMany or hasOne associations are used.
  • Allow the grid columns to be promoted as class.
  • Added Check and RowNumberer grid columns.
  • Fixed basic event binding in the viewmodel store.
  • Improved UX of the config filter and lock.
  • Fixed project backup when upgrading of SA.
  • Added HeaderResizer, RowWidget and RowExpander grid plugins.
  • Added Grid Builder for modern toolkit.
  • Added Tree Grid component to modern toolkit.
  • Put custom property of controller into the config object.
  • Added GMapPanel component to classic toolkit.
  • Fixed the changing of the name property in metadata after project save.
  • Fixed TreeList to provide view controller and view model when promoted to class.
  • Fixed code editor to not obscure last character in long lines.
  • Fixed project archive including SDK.
  • Fixed resizing of welcome screen.
  • Backup is offered when updating of minor SA version.
  • Fixed the model associations when upgrading from ext 6.0 to 6.2.
  • Fixed previewing of the JSON store data.
  • Fixed the signature of summaryRenderer function.
  • Fixed frozen Architect GUI when open CLI from menu.
  • Fixed preview error when hidden form field is presented.
  • Fixed grid column alignment.

Known Issues

  • A black window is shown. The workaround is to run SA from command line with --disable-gpu switch.

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