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.

Cmd 7.4.0


top

Hierarchy

Cmd.codebase.json.Manifest
Cmd.app.json.Manifest

Summary

This class is a description of the contents of 'app.json' file which Sencha Cmd compiles to produce Ext.manifest.

No members found using the current filters

configs

Optional Configs

appCache : Cmd.app.json.AppCache

Settings used to generate a cache.manifest file.

archivePath : String

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.

bootstrap : String / Object

Options for development-mode artifacts. If this value is a string, it is equivalent to setting the bootstrap.base value.

Properties

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.

builds : Object

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.

cache : Object

Properties

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.

classpath : String / String[]

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.

compressor : Cmd.codebase.json.Compressor

If not set to null, this config determines what JavaScript compressor is used to make a "minified" build.

cordova : Object

TODO

Properties

config : Object

Cordova configuration object.

cordova : Cmd.app.json.packager.Cordova

The config options for the cordova packager process

css : Cmd.codebase.json.Asset[]

One or more CSS assets to include in the build.

fashion : Cmd.app.json.Fashion

The options that control the CSS build using the Sencha Fashion theme compiler.

framework : String

The framework of this application. This is typically "ext" but can be any key in the frameworks collection of the workspace.

id : String

Uniquely generated id for this application, used as prefix for localStorage keys. Normally you should never change this value.

ignore : String[]

File / directory name pattern to ignore when copying to the builds. Must be a valid regular expression.

indexHtmlPath : String

The relative path to the application's markup file (html, jsp, asp, etc.). Typically "index.html".

js : Cmd.codebase.json.JS[]

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
 }]

loader : Object

Settings for the Ext JS dynamic loader (Ext.Loader).

Properties

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"

name : String

The application's name (typically also its root namespace).

namespace : String

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.

output : Cmd.app.json.Output

The options used to control build output.

overrides : String / String[]

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.

packager : "cordova" / "phonegap"

When configured on a build profile, selects the desired native packager to use for that build profile.

phonegap : Object

This config is the same as the cordova config but applies to the PhoneGap packager.

Properties

config : Object

PhoneGap configuration options.

phonegap : Cmd.app.json.packager.Phonegap

The cofig options for the phonegap packager process

progressive : Cmd.app.json.progressive.Progressive

This is the configuration object for Progressive Web Applications

requires : String[]

A list of required packages.

sass : Cmd.codebase.json.Sass

This config controls how Cmd will process the application's Sass assets. Typically these are located in the ./sass folder.

slicer : Object

Additional resources used during theme slicing operations.

theme : String

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

toolkit : "classic" / "modern"

This config is needed when using the Ext JS 6+ framework.

uses : String[]

A list of packages that will be used by the application. These packages are built so that they can be dynamically loaded using the package-loader package.

properties

methods

Cmd 7.4.0