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


top

Change Log

Version 4.3.0

New Features

  • DSGNR-8306 - Update Sencha Architect to Version 4.3.0 Supporting ExtJS 7.4
    • Grid Multi-level Grouping - The MultiGrouping grid feature allows the Grid Panel to display the Store data that is grouped by multiple groupers. Here is an example of what it looks like:
    • Grid Filter bar - This classic and modern toolkit plugin will add a docked bar under the grid headers and depending on the grid columns configuration,filter fields will be added.
    • Grid Summaries and totals for grouping - Quickly define functions for aggregation such as sum, min, max count and more per column.
    • Grid Grouping Panel plugin - This plugin allows your end-users to drag and drop grid columns to the grouping panel section that is visible above the grid panel.
  • DSGNR-8309 - Architect should support new Ext JS 7.4 grid features
    • The necessary definition and definition-gen files have been created based on the component hierarchy and the component configurations. The reasonable parent child restrictions have been put in place.

Bug Fixes

  • DSGNR-8310 - Sencha Architect Should work in MacBook M1 processor
  • DSGNR-8311 - Update Orion Core (and dependencies) and Sencha Architect (Designer) Build Tools (and dependencies)
  • DSGNR-8287 - Architect 4.2.7 Bug with extjs 7.1
  • DSGNR-8278 - Font Awesome icons does not display on Sencha Architect 4.2
  • DSGNR-8244 - Theme fonts is not rendered correctly in Architect
  • DSGNR-8305 - Custom UI Mixin undefined error while upgrading app from 6.7 to above (7.0)
  • DSGNR-8233 - Box layout missing from the classic toolkit
  • DSGNR-8125 - Modern 6.2.x+ includes Google API package by default which require Internet access
  • DSGNR-8307 - SA Treats String[] as String
  • DSGNR-8295 - Architect does not handle toolbar/button UI mixins on build.
  • DSGNR-8291 - Architect will not start with the latest version of Ubuntu 20.4
  • DSGNR-8271 - Cannot create PreviousButton on Modern calendar
  • DSGNR-8147 - Error while creating a polar/pie charts using Sencha Architect
  • DSGNR-8156 - "Converting circular structure to JSON" error when trying to preview JSON Store in the UI
  • DSGNR-8259 - Architect Save will cause IDE to hang and not finish save.

Version 4.2.7

Bug Fixes

  • DSGNR-8206 - Color Picker not working
  • DSGNR-8222 - Framework upgrade button does not appear
  • DSGNR-8235 - Sencha Architect crashes when you add a segmented button to a classic toolkit project
  • DSGNR-8254 - Missing toolbox components from 7.0.

Version 4.2.5

New Features

  • DSGNR-8153 - Support new features of Ext 6.7 and Cmd 6.7 in Sencha Architect
    • 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

Version 4.2.4

New Features

  • EXTJS-26353 - Add Ext 6.6 and Cmd 6.6 to Sencha Architect

Version 4.2.3

New Features

  • DSGNR-8139 - Add Ext 6.5.3 and Cmd 6.5.3 to Sencha Architect
  • DSGNR-8119 - Added Grid exporter project example.
  • DSGNR-8035 - Added form for importing Premium components.
  • DSGNR-8010 - Added project packages info to the project inspector.
  • DSGNR-7754 - Added possibility to delete component in Project inspector hitting the delete key.
  • DSGNR-7996 - Added new settings for Cmd timeout in Edit → Preferences → Behavior.

Bug Fixes

  • DSGNR-8115 - Fixed creating the modern project offline.
  • DSGNR-8050 - Added box layout to modern components.
  • DSGNR-8036 - Enable reference the variables in custom UIs.
  • DSGNR-8031 - Enable reference the variables in theme.
  • DSGNR-8012 - Fixed dependency resolving Cmd error.
  • DSGNR-8025 - Fixed rotate interaction config.
  • DSGNR-8009 - Fixed applying of Themer theme.
  • DSGNR-7959 - Added chart interaction configs.
  • DSGNR-7899 - Added missing route configs.
  • DSGNR-8089 - Fixed project upgrade loading.
  • DSGNR-8074 - Fixed D3 project example.
  • DSGNR-8064 - Fixed radiusField config to offer project stores.
  • DSGNR-8054 - Fixed false project upgrade.
  • DSGNR-8039 - Improved drag&drop of components to Project Inspector.
  • DSGNR-7999 - Fixed Big data grid example.
  • DSGNR-7996 - Increased build timeout.
  • DSGNR-7626 - Improved speed of app watch executing.
  • DSGNR-6766 - Enable auto-restart in OSX.
  • DSGNR-8099 - Fixed Car listing project example.
  • DSGNR-8091 - Fixed D3 axis field config to offer project fields.
  • DSGNR-8067 - Allow sorterFn in grouper.
  • DSGNR-8033 - Fixed exportRenderer function parameters.
  • DSGNR-8013 - Fixed calendar store to add requires.
  • DSGNR-8007 - Enable add Themer theme to unsaved project.

Known Issues

  • DSGNR-7556 - Google Map component doesn't work in Ext JS 6 classic.

Version 4.2.2

New Features

  • Added Cmd 6.5.1.

Bug Fixes

  • DSGNR-7932 - Fixed integration with Themer theme containing custom UIs.
  • DSGNR-7944 - Fixed requires duplication in application node.
  • DSGNR-7948 - Fixed setting of TabPanel#iconCls config.
  • DSGNR-7950 - Enable create modern 6.5 offline.
  • DSGNR-7955 - Fixed usage of ext-ux package.
  • DSGNR-7956 - Fixed upgrade from modern 6.2 to 6.5 when menu component is used.
  • DSGNR-7978 - Fixed loading the extensions created by Cmd 6.5+.
  • DSGNR-7965 - Fixed event parameters in calendar component.
  • DSGNR-7924 - Fixed D3 HeatMap component.
  • DSGNR-7835 - Enable to add static function to application node.
  • DSGNR-7943 - Fixed alternate type of Grid#tool config.
  • DSGNR-7974 - Fixed function parameter of Reader#transform config.
  • DSGNR-7951 - Added basic icons for Button#iconCls config.
  • DSGNR-7989 - Enable remove duplicated configs.

Known Issues

  • DSGNR-8012 - You may see a failed build message in Cmd Output tab when saving a new project containing a chart or a premium component for the first time. Ignore this error.
  • DSGNR-7556 - Google Map component doesn't work in Ext JS 6 classic.

Version 4.2.1

Bug Fixes

  • DSGNR-7910 - Fixed infinite update of auxiliary files.
  • DSGNR-7914 - Enable setting the custom framework path.
  • DSGNR-7909 - Fixed integration with Themer theme when tabpanel custom UI is used.
  • DSGNR-7824 - Fixed the scrolling in source code editor.
  • DSGNR-7905 - Enable edit the records in Modern 6.5 Quick Start example.
  • DSGNR-7919 - Fixed ActionColumnItem#isActionDisabled config.
  • DSGNR-7929 - Fixed ComboBox#displayField config to use reference.
  • DSGNR-7925 - Enable to switch the type of store config to simple object.
  • DSGNR-7937 - Fixed tools config in Grid Column.
  • DSGNR-7934 - Fixed Ext.tab.Panel#tabRotation config number values.

Known Issues

  • Using Sencha Themer custom themes with custom UIs may result in compile errors.
  • DSGNR-7556 - Google Map component doesn't work in Ext JS 6 classic.

Version 4.2.0

New Features

  • Added Ext JS 6.5.0.
  • Added Cmd 6.5.0.
  • Updated application container to Electron 1.6.2.
  • DSGNR-7616 - Enable to import offline license when activating SA.
  • DSGNR-7364 - Enable to create ViewModel and ViewController.
  • DSGNR-7813 - Added new modern project template Card List.
  • DSGNR-7743 - Added EditProject SettingsFrameworkReinitialize Cmd settings.
  • DSGNR-6224 - Added center layout.
  • DSGNR-7829 - Added Ext.picker.Picker to the toolbox.
  • DSGNR-7863 - Added warnings about deprecated events when upgrading from modern 6.2 to 6.5.
  • DSGNR-7335 - Enable to restart Cmd app watch.
  • DSGNR-7348 - Enable ECMAScript 2015 syntax.

Bug Fixes

  • DSGNR-6831 - Fixed slow project save.
  • DSGNR-7753 - Fixed missing theme variables.
  • DSGNR-7599 - Fixed usage of extended models in store and in extensions.
  • DSGNR-7659 - Fixed type of Ext.data.field.Field#reference.
  • DSGNR-7648 - Fixed broken Project Inspector when user is offline.
  • DSGNR-7647 - Fixed metadata when clearing a config value.
  • DSGNR-7624 - Fixed running SA without Cmd.
  • DSGNR-7701 - Fixed requiresSdk config for custom resurces.
  • DSGNR-7777 - Fixed the grid when zooming the canvas.
  • DSGNR-7532 - Fixed theme losing after upgrade from SA 3.5.
  • DSGNR-7815 - Fixed start of Cmd service when the machine is slow.
  • DSGNR-7792 - Added Ext.chart.interactions.ItemInfo#show event.
  • DSGNR-7765 - Added init and onLaunch method to Ext.app.Controller.
  • DSGNR-7572 - Fixed theme recompiling before project save.
  • DSGNR-7551 - Fixed missing icons in iOS theme.
  • DSGNR-7509 - Fixed the import of templates.
  • DSGNR-7869 - Fixed Round UIs names.
  • DSGNR-7407 - Improved the error message about non valid directory in the publish path.
  • DSGNR-7270 - Fixed sharing the requires between the projects created in single SA instance.
  • DSGNR-7013 - Fixed the switch of the tab after new tab is added into Ext.tab.Panel.
  • DSGNR-6270 - Removed redundant css files from resource folder after the project build.
  • DSGNR-7794 - Fixed parameters of Ext.chart.axis.Category#renderer method.
  • DSGNR-7787 - Fixed bounded store within ViewModel.
  • DSGNR-7781 - Fixed store fields lookup in Ext.field.Select#valueField config.
  • DSGNR-7761 - Fixed Ext.grid.column.Column#summaryType method parameter.
  • DSGNR-7721 - Fixed default width and height of sparklines.
  • DSGNR-7661 - Fixed removing of config filter.
  • DSGNR-7828 - Allow multiple tbfills on Ext.toolbar.Toolbar.
  • DSGNR-7806 - Made Ext.tab.Panel#badgeText config bindable.
  • DSGNR-7770 - Fixed error when accessing method from deleted Controller.
  • DSGNR-7737 - Fixed the preview of project templates.
  • DSGNR-7736 - Fixed url format in generated data.
  • DSGNR-7702 - Improved checking of the extensions for class name collision.
  • DSGNR-7683 - Fixed error when hit the enter on custom theme import dialog.

Known Issues

  • DSGNR-7556 - Google Map component doesn't work in Ext JS 6 classic.

Architect 4.3