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 3.5

Guides
API
top

Ext JS View Components

General descriptions of view component categories in the Toolbox of the Ext JS version of Architect are provided here. When you click each component name in the Toolbox, Architect displays a brief description of it in the text panel below the Toolbox, which includes a link to [[ext: Ext JS API Documentation]]. For complete information about each component, follow those links. The links in this section also take you to Ext JS API documentation.

Ext JS component categories

The Toolbox organizes Ext JS views into the following categories:

  • Containers
  • Charts, including Chart Series and Chart Axis
  • Form Fields
  • Grids, including Grid Columns, Grid Features, Grid Selections, and Grid Views
  • Menus
  • Standard
  • Toolbar
  • Tree
  • Views

Let's take a closer look at each of these component types.

Containers

Containers are components that can contain other components. Architect lets you select from the standard Ext JS containers, which meet most UI development needs. This includes the following:

Container. The simplest component that can contain other components. All other container types are extensions of the Container class. A Container is simply a logical container and does not include any default visual characteristics.

FieldContainer.Enables a UI to easily display multiple fields on the same row of a form, along with a label and optional validation messages that match the display of other form fields. A common use of FieldContainer is for multi-part name fields. However, a FieldContainer can contain any type of Form Field, not just Text fields. Add fields by dragging them into the FieldContainer or duplicating existing fields.

FieldSet. A FieldSet is used to group related fields within a Form Panel, and lets you visually separate elements of a form. For example, an online sales form might divide fields into groups, one for billing address, the other for shipping address. FieldSet can be used on its own or inside a form and optionally has a title at the top and instructions at the bottom. Typically, FieldSet contains form fields, but a FieldSet can also contain nested containers. For example, nested container components can be used within a FieldSet to create a multicolumn layout.

Form Panel. A specialized Panel that groups a collection of form fields and labels and adds capabilities for validating and submitting forms. In addition to the various Form Fields, containers such as Container and FieldSet can be added to a Form Panel. For example, nested Containers might be used to build a multicolumn form.

Panel. The basic building block for user interfaces providing robust application functionality. A Panel can be added to any type of container and can have sub-components added to its body area or docked to any of its four edges. In addition to the generic Panel container, Ext JS provides a number of specialized types of panels, including Form Panel, Tab Panel, Grid Panel, and Tree Panel. The Window container is also an extension of Panel.

Tab Panel. A specialized type of Panel that uses card layout to display a collection of nested components as separate tabs. Architect adds a Tab Panel with three tab components to the canvas by default. Additional subcomponents can be added to each tab, and tabs can be added by dragging components onto the Tab Panel.

Viewport. Used to represent the entire viewable application area in a browser window. A Viewport automatically sizes itself to the size of the browser viewport. Each page can have only one Viewport, but it can contain nested panels that each have their own layouts and nested components. A Viewport is not scrollable; if scrolling is required, use scrollable child components within the Viewport.

Window. A specialized type of Panel that is resizable and draggable. Windows can also be maximized to fill the viewport, minimized, and restored to their previous size. Unlike an ordinary Panel, a Windows floats and can be closed. Windows are commonly used to present dialogs and errors.

Charts

The charting package, introduced in Ext JS 4, allows visualization of complex data stores with a number of different chart types. The Charts toolbox section provides a set of predefined chart types, with common axis and series configurations already in place and a temporary data store with dummy data attached. Once you add one of these chart types to your project, you need to change its data store from the dummy data to an actual data store you have defined. You can change, add, and remove its child axis and series items to meet the needs of your application and its UI.

The Architect Toolbox breaks down chart components into the following three sections:

Select from the following types of predefined charts:

  • Bar
  • Column
  • Gauge
  • Legend Line
  • Pie
  • Radar
  • Stacked Bar

Chart Series Contains the supported series types -- the actual representations of the records in data stores, including labels, highlights, tips, and callouts. Series types also handle mouse events by animating, hiding, showing all elements, and showing the legend item colors, and other event-driven behaviors. Examples include Bar Series, which displays data records as horizontal bars; Column Series, which display data records as vertical bars; and Gauge Series, which displays a single data point as a gauge along an arc.

Chart Axis Contains the supported axis types -- scales with tick marks and value labels for one or more dimensions of the chart data that are used to define the axes for charts. The axis position, type, style can all be configured. Examples include Category Axis, which is usually used for arranging data points by a non-numeric field like months of the year or people's names; Gauge Axis, which displays tick marks along an arc for a Gauge Series; Numeric Axis, which is used to arrange data points by a numeric field like number of visitors or stock price; and Radial Axis.

Form Fields

Form Fields are components you add to a Form Panel container to create a form. Ext JS provides the standard field types used to build almost any kind of form, including Checkbox, Checkbox Group, ComboBox, Date Field, HTML Editor, Label, Text Field, and so on. To group related fields, place them inside a FieldSet container nested within a Form Panel. If you want to create multicolumn forms, add nested Containers for the columns. For more information about building forms, see Building Ext JS Forms in Architect.

Grids

Grids display data in interactive tables. Ext JS provides a variety of components for building grids, starting with Grid Panel, which has built-in support for resizing and sorting columns as well as dragging columns to new locations in the grid. Grid Panel also supports horizontal scrolling and single and multiple selections. Ext JS also provides Cell Editing and Row Editing plugins that provide support for inline editing of the grid's values one cell at a time or an entire row at a time.

The Architect Toolbox breaks down grid components into the following sections:

Grid Columns: Contains the types of columns used in a Grid Panel, including action, boolean, date, number, and template columns. By default, Grid Panel contains string, number, date, and boolean columns when added to a project.

Grid Features: Contains pluggable features that modify how grid data is presented, including grouping, grouping summary, row body, and summary, each of which arrange items in the grid according to the way you configure them.

Grid Selection: Contains methods for selecting data elements in grids, including cell selection, checkbox selection, and row selection models. Drag the model you want to use onto the Grid Panel to enable it.

Menus

Menu components are used to build menus. Ext JS provides a standard set of menu components -- including Check Item, Color Menu, Date Menu, and Menu Item -- that you can add and configure through Architect. For example, to build a menu bar, add a Button from the Standard set of components (see below) for each menu to a Toolbar (see below under Toolbar) and then configure a Menu component for each button.

Standard

Standard components provide basic building blocks for your UI, including Button, Progress Bar, Splitter, and Tool components. Standard also includes Ext.Component, the basis for all other components. Typically, Component is not used directly; instead you'd use a container or another specialized component.

Toolbar

Toolbar includes components you use to build toolbars, including Toolbar, Button Group, Fill, Separator, and Spacer components. To create a toolbar with its controls, add a Toolbar component and then add the control components to the Toolbar. Toolbars are typically added to a Panel container, and can be docked to any of the panel's edges by setting the "Dock in parent" option in the Toolbar's config flyout.

Tree

Use Tree components to build trees, which your application uses to display hierarchical data in a list that can be expanded and collapsed. The basic Ext JS tree building block is the Tree Panel container. A Tree Panel contains a root node and any number of child nodes. You can bind a Tree Panel to a TreeStore. As changes happen to the data in the TreeStore they are automatically reflected in the Tree Panel.

Views

Components used to display dynamic data from a data store, enabling you to have complete control over the formatting and layout of the data through an XTemplate. The View component displays data from a Store using an XTemplate to format and lay out the data. When data in the attached store changes, View automatically updates the data in the UI. View provides built-in support for common actions such as click and mouseover and supports both single and multiple selections.

Sencha Architect 3.5

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