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

Guides
API
top

Change Log

Version 4.0.2

New Features

  • Editing Themer imported theme in SA is synchronized with Themer.

Bug Fixes

  • Fixed usage of Process Config in child views in modern.
  • Fixed usage of theme UIs.
  • Fixed classic Neptun theme to allow changing the configs.
  • Fixed import of xda archive.
  • Fixed refreshing the theme imported from Themer.
  • Fixed Google Map component in modern.
  • Fixed plugin user extension (aux) in modern.
  • Fixed the signature of serializer function in store filter.
  • Allow disabling itemTpl in user extensions (aux).

Known Issues

  • A black window is shown. The workaround is to run SA from command line with --disable-gpu switch.
  • Auto-update on 32bit platforms (Windows and Linux) is not supported. Download the new installer from sencha support.

Version 4.0.1

New Features

  • Added possibility to skip assets synchronization after first start of SA.

Bug Fixes

  • Fixed me scope bug when custom or basic event binding in Store is used.
  • Fixed nonexistent getConfigurator function when Process Config is used.
  • Fixed Grid columns aligning to the right.
  • Added hasMany/hasOne/belongsTo associations to model.
  • Fixed error Cannot read property '$validationInstance' of undefined.
  • Fixed the type of baseCls config.
  • Fixed the xtype of chart legend.
  • Fixed the values of column align config.
  • Removed redundant warnings in the log tab when Themer theme is imported.
  • The preference settings of url prefix is persistent.
  • Application renaming dialog is shown in the correct moment.
  • Possibility to use apostrophes in the configs of object type.
  • Added labels to UI builder.
  • OpenJDK is valid dependency.

Known Issues

  • Usage of Process Config in modern toolkit in children views still generates broken code. This bug will be addressed soon in 4.0.2. The temporal workaround is to create override for Ext.Base, see this forum post.
  • A black window is shown. The workaround is to run SA from command line with --disable-gpu switch.
  • Auto-update on 32bit platforms (Windows and Linux) is not supported. Download the new installer from sencha support.
  • Creation of custom UIs in modern toolkit has been disabled till next release.
  • Import of Ext-less xda archive made in SA 4 fails. The workaround is to create archive with Ext JS framework included.
  • Using Google Map component in modern toolkit produce error during the build. The workaround is to add "google" into requires array in app.json.

Version 4.0.0

New Features

  • Added Ext JS 6.2.0
  • Utilized Cmd 6.2.0
  • Added Ext JS 5.1.3
  • Application container updated to Electron 1.2.3
  • Ability to import theme from Themer
  • Added Tree list component
  • Added Modern Grid component with plugins
  • Supported spreadsheet selection model in Grid
  • Supported Clipboard plugin in Grid
  • Added new Quick Start, Dashboard and Login project templates

Bug Fixes

  • Fixed license activation for usernames containing unicode chars
  • Added missing Triton variables
  • Added missing Triton UI theme group
  • Added info message when Cmd cannot start
  • Added chart interactions
  • Fixed CDN urls of theme packages
  • Set Triton as default theme
  • Removed error message and allow TreeStore automatically use TreeModel
  • Improved logging into Output tab
  • Fixed adding functions to Draw Container
  • Set project unsaved when any resource is removed
  • Added angleField to Pie chart
  • Fixed signature of renderer method of Axis, Axis3D and Series classes
  • Allow set javascript date object to min or max value of datefield component
  • Allow opening system file explorer from log tab
  • Fixed doc urls to address Ext JS 6
  • Fixed type of Ext.layout.container.Border.split config
  • Fixed cursors in Sencha Architect
  • Fixed type of Ext.panel.Tool.type config
  • Added explaining note to the publish window
  • Added defaultMargins config to HBox and VBox classes
  • Allow set object type of Ext.grid.filters.filter.Base.value config
  • Displayed default Cmd path in dependencies window
  • Fixed rootProperty config of JSON reader
  • Fixed columns being moved to items section after columns reordering
  • Added missing configs of data model validators
  • Allow set function type of Ext.data.field.Field.mapping config
  • Offer data field from linked store in angleField config of Pie3D and Gauge series
  • Fixed application preview in multi-application workspace environment
  • Fixed setting of the config to default value in linked instance

Changes

  • License activation does not require Sencha Forum id
  • The default path of Cmd asset changed from <home>/bin/Sencha/Cmd to <home>/bin/Sencha/Architect/Cmd
  • Cmd runs preview and service on random free port instead of default 1841 and 1842
  • Removed Touch framework
  • Removed BlackBerry theme and Quick themes
  • Removed Appurify
  • Project Inspector is on the left side by default

Known Issues

  • A black window is shown. The workaround is to run SA from command line with --disable-gpu switch.
  • Auto-update on 32bit platforms (Windows and Linux) is not supported. Download the new installer from sencha support.
  • Creation of custom UIs in modern toolkit has been disabled till next release.
  • Import of Ext-less xda archive made in SA 4 fails. The workaround is to create archive with Ext JS framework included.
  • Using Google Map component in modern toolkit produce error during the build. The workaround is to add "google" into requires array in app.json.

Sencha Architect 4.0

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