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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
This class is a description of the contents of 'app.json' file which Sencha Cmd
compiles to produce Ext.manifest.
Directory path to store all previous production builds. Note that the content generated inside this directory must be kept intact for proper generation of deltas between updates.
Options for development-mode artifacts. If this value is a string, it is equivalent to
setting the bootstrap.base value.
base : String
The base location where development-mode
artifacts are stored. By default they are stored in the same location as app.json
itself. Relative paths for other bootstrap artifacts are based at this location.
Defaults to: "${app.dir}"
css : String
The development mode CSS file.
Defaults to: "bootstrap.css"
microloader : String
The path to the main JavaScript file to load in development mode that will then load
the files described in the bootstrap.manifest. This file will be generated with the
Ext.Boot and Ext.Microloader classes.
Defaults to: "bootstrap.js"
manifest : String/Object
When this config is a string, it is equivalent to setting bootstrap.manifest.path.
Otherwise this config is an object with optional path and exclude properties.
path : String (optional)
The location of the development-mode manifest file. This file describes the files to load for the application and framework.
Defaults to:
"bootstrap.json"
exclude : String (optional)
A comma-separated list of top-level keys to remove from the generated manifest object.
One key that may be desirable to remove is loadOrder, which is used to load files in
the same order as a production build, but can be rather large.
This object's properties are "build profiles". You can add as many as you need to
produce optimized builds for devices, themes, locales or other criteria. Your
Ext.beforeLoad function is responsible for selecting the desired build profile by
setting Ext.manifest to one of these names.
enable : Boolean
This property controls whether localStorage caching of the manifest file. If disabled no deltas will be generated during a build and full updates will be disabled.
deltas : Boolean/String
Determines whether the localStorage cache of assets will use "delta patching" to update assets.
If set to a String, that value will be used as the path to where deltas will be generated relative to the build.
If set to true the default path of "deltas" will be used. If set to false or if
this property is not present, deltas will not be generated.
An array of paths or a comma-separated string of paths to folder or files to search for
classes. Any classes declared in these locations will be available to use in Ext.define
as "requires" or in calls to Ext.require.
If not set to null, this config determines what JavaScript compressor is used to make
a "minified" build.
The options that control the CSS build using the Sencha Fashion theme compiler.
The framework of this application. This is typically "ext" but can be any key in the frameworks collection of the workspace.
Uniquely generated id for this application, used as prefix for localStorage keys. Normally you should never change this value.
File / directory name pattern to ignore when copying to the builds. Must be a valid regular expression.
The relative path to the application's markup file (html, jsp, asp, etc.). Typically "index.html".
One or more JavaScript assets to include in the build (or load remotely). Typically this config is set to something like:
"js": [{
"path": "app.js",
"bundle": true
}]
Settings for the Ext JS dynamic loader (Ext.Loader).
cache : Boolean/String
When set to false the loader uses the
loader.cacheParam to disable cached responses. When set to true, the loader does
not disable browser caching. In a production build this is usually set to the build
timestamp using the ${build.timestamp} variable.
Defaults to: false
cacheParam : String
The URL query parameter to use to disable the
browser cache. For example "?_dc=12345".
Defaults to: "_dc"
The application's root namespace. This property can be provided if the name property
is used in ways that do not match with the JavaScript namespace.
An array of paths or a comma-separated string of paths to folder or files to search for overrides. Any code declared in these locations will be automatically required and included in the build. If any file defines an Ext JS override (using Ext.define with an "override" property), that override will in fact only be included in the build if the target class specified in the "override" property is also included.
When configured on a build profile, selects the desired native packager to use for that build profile.
This config is the same as the cordova config but applies to the PhoneGap packager.
config : Object
PhoneGap configuration options.
This is the configuration object for Progressive Web Applications
This config controls how Cmd will process the application's Sass assets. Typically
these are located in the ./sass folder.
The name of the theme package to use for generating CSS. Typical values include
"theme-material" (for the modern toolkit) and "theme-triton" (for both toolkits).
Cmd | Terms of Use