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


Setting Up D3

The D3 component (and other premium Ext JS framework packages) may be included in your Architect projects. In this guide, we’ll walk through connecting the premium packages from the ExtJS SDK to your projects. We’ll also step through the additions and configurations required to use D3 components in an active project.

Note: This guide applies to Architect 4.1+ and Ext JS 6.2+

Premium Package Setup

Architect ships with the D3 component, which allows you to compose your project with D3 components in the Design view. However, to use them in a saved project, you’ll need to copy the premium packages folders over to your saved project or the Architect frameworks library folder. Below are the two paths you may need to take to add the necessary package folders for use in your Architect projects.

Before Your Architect Project Is Created

The following steps will be the steps you’ll need to include the D3 component and other premium packages in new Architect projects.

  1. In your computer’s file browser, open the Ext JS SDK addons packages folder.
    e.g. {ext-addons-6.2.1}/packages. You should see the "d3" folder along with the other included premium add-ons.

  2. Copy all folders in the "packages" folder

  3. Paste the premium package folders into the Architect frameworks folder

    1. Mac: /Users//Documents/Architect/frameworks///commercial/packages/

    2. PC: c:\Users\pf\Documents\Architect\frameworks\\\commercial\packages\

    3. Linux: ~/Documents/Architect/frameworks///commercial/packages

Note: Architect will use the most recent version of the framework within the "frameworks" subfolder. For example, if you see 6.2.0.x and 6.2.1.x in the “frameworks/ext62” folder, you’ll want to make sure the packages are added to the 6.2.1.x folder from the 6.2.1 addons download.

Existing Architect Project

Once a project has been saved for the first time, the framework assets are copied to the project’s output directory. For previously saved projects, you’ll need to copy the premium package folders to the project itself via these steps:

  1. In your computer’s file browser, open the Ext JS SDK addons packages folder.
    e.g {ext-addons-7.0.0}/packages. You should see the "d3" folder along with the other included premium add-ons.

  2. Copy all folders in the "packages" folder

  3. Paste the premium package folders in your saved project folder’s {SavePath}/ext/packages

Note: If you have already added a D3 view to your project prior to adding the package to your save folder, you’ll need to restart Architect after copying the premium package folders before you can preview your project.

Using the D3 in a Project

Add a Container

D3 charts need a container to nest within, so let's drag a container onto the canvas to begin. Before we move on, let's also bump up the height and width. Filter for each property on the container's config and set them to 600 each.

Add a Heatmap to the View

With the D3 package accessible to both Architect and your project builds, you may click on "premium" in the toolbox panel and drag one of the views onto the design canvas. Any of the d3 views could be selected. We’ll use the heatmap component for the purpose of this walkthrough. Simply search for "heatmap" and drag Heatmap onto the container and you'll see a heatmap chart appear.

Add data to the D3 chart

You will see that the chart already has a shape, but this is simply for placeholder purposes.

Note: If you were to preview your application currently, you would only see the x and y axes with no data visualization.

The first thing we'll need to do, is add a store.


Search the toolbox for "store" and then drag the Store onto your Project Inspector's "Stores" node. You'll see a red exclamation next to your newly created store. This indicates the need for a model.


Search the toolbox for "model" and then drag the Model onto your Project Inspector's "Models" node. With your model selected, filter the model's configs for "fields". Click the "+" button and add "date, bucket, count". You'll now see your fields populated under your model in the Project Inspector. Before we go on, let's click on the date field.
Then filter for "type" and set it to "date".

Connecting the Model and Store

Now, let's tie the model to the store. With MyStore selected in your Project Inspector, filter for "model" in the tree store's configs. Once filtered, you should see a single entry for model. Click within the box and select MyModel. Now, the red exclamation point should have disappeared.

Adding the Data to the Store

We are now ready for data. You can use the following data to finalize your store and view a completed heatmap.

    { "date": "2012-07-20", "bucket": 800, "count": 119 },        
    { "date": "2012-07-20", "bucket": 900, "count": 123 },        
    { "date": "2012-07-20", "bucket": 1000, "count": 173 },        
    { "date": "2012-07-20", "bucket": 1100, "count": 226 },        
    { "date": "2012-07-20", "bucket": 1200, "count": 284 },        
    { "date": "2012-07-21", "bucket": 800, "count": 123 },        
    { "date": "2012-07-21", "bucket": 900, "count": 165 },        
    { "date": "2012-07-21", "bucket": 1000, "count": 237 },        
    { "date": "2012-07-21", "bucket": 1100, "count": 278 },        
    { "date": "2012-07-21", "bucket": 1200, "count": 338 },        
    { "date": "2012-07-22", "bucket": 900, "count": 154 },        
    { "date": "2012-07-22", "bucket": 1000, "count": 241 },        
    { "date": "2012-07-22", "bucket": 1100, "count": 246 },        
    { "date": "2012-07-22", "bucket": 1200, "count": 300 },        
    { "date": "2012-07-22", "bucket": 1300, "count": 305 },        
    { "date": "2012-07-23", "bucket": 800, "count": 120 },        
    { "date": "2012-07-23", "bucket": 900, "count": 156 },        
    { "date": "2012-07-23", "bucket": 1000, "count": 209 },        
    { "date": "2012-07-23", "bucket": 1100, "count": 267 },        
    { "date": "2012-07-23", "bucket": 1200, "count": 299 },        
    { "date": "2012-07-23", "bucket": 1300, "count": 316 },        
    { "date": "2012-07-24", "bucket": 800, "count": 105 },        
    { "date": "2012-07-24", "bucket": 900, "count": 156 },        
    { "date": "2012-07-24", "bucket": 1000, "count": 220 },        
    { "date": "2012-07-24", "bucket": 1100, "count": 255 },        
    { "date": "2012-07-24", "bucket": 1200, "count": 308 },        
    { "date": "2012-07-25", "bucket": 800, "count": 104 },        
    { "date": "2012-07-25", "bucket": 900, "count": 191 },        
    { "date": "2012-07-25", "bucket": 1000, "count": 201 },        
    { "date": "2012-07-25", "bucket": 1100, "count": 238 },        
    { "date": "2012-07-25", "bucket": 1200, "count": 223 },        
    { "date": "2012-07-26", "bucket": 1300, "count": 132 },        
    { "date": "2012-07-26", "bucket": 1400, "count": 117 },        
    { "date": "2012-07-26", "bucket": 1500, "count": 124 },        
    { "date": "2012-07-26", "bucket": 1600, "count": 154 },        
    { "date": "2012-07-26", "bucket": 1700, "count": 167 }

Copy and paste the above data, and then click on your Store. Filter for data and click on its array value. Then paste in your copied data.

Note: You may need to delete a phantom "0" that seems to currently pop up.

Now we're ready to tie our data to our heatmap!

Connecting the Store to the Heatmap

Click on your heatmap in the Project Inspector. While selected, filter for "store" in the heatmap's config section. Associate the store with "MyStore" and you should see the data in your heatmap change immediately. You can now preview your application in a browser and see a D3 heatmap conveying all of the data we just added.

image alt text

Additional Resources

For additional information on the D3 package refer to the D3 Guide. You can also inspect the examples in the Kitchen Sink.

Architect 4.2