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 is not an actual class or singleton but rather the contents of 'package.json'
which Sencha Cmd uses to describe a package.
To maintain compatibility with Node.js, Sencha packages wrap these configs in a "sencha"
root property:
{
... Node.js properties ...
"sencha": {
... Sencha properties ...
}
}
One or more alternate package names. This is used to support old names for a package when it has been renamed.
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.
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.
The version that users can transparently update from without requiring code changes.
In addition to the version property, packages can also indicate the degree to which
they are backward compatible using this property.
If not set to null, this config determines what JavaScript compressor is used to make
a "minified" build.
The author of the package.
Required only if you are distributing this package through a Sencha Cmd repository, in which case it should match the name you assign to your local package repository.
Defaults to:
"anonymous"
This config instructs the sencha package build command to also build one or more
example applications contained in example.path.
path : String
The path to the example(s) for this package. It is assumed that all sub-directories
of this location should be built using sencha app build.
apps : String[]
This optional array of strings are the names of apps that should be built using the
sencha app build command. This is used when only some of the subdirectories of
examples.path are buildable in this way.
For "theme" type packages only, this determines the styles and variables this theme
will inherit.
The framework to use when building. This is typically "ext" but can be any key in the frameworks collection of the workspace.
One or more JavaScript assets to include either in the build or to load remotely.
"js": [{
"path": "http://3rd.party.org/third-party.js",
"remote": true
}]
Indicates whether this is a locally developed package or downloaded form a repository.
Defaults to true on newly generated packages. This value is removed in the package's
build output and should not be removed manually.
This flag was originally used by Sencha Cmd to avoid replacing local packages with
remote packages (when all packages were stored in the ./packages directory).
The name of the package. Should be a valid JavaScript identifier but can also use
hyphens. If a name is not specified in the sencha object, the name from the
outer (Node.js) level is assumed.
The namespace of this package.
As a general rule, all classes that belong to this package should be under this namespace if multiple namespaces are part of this package, set this to "".
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.
This config controls how Cmd will process the application's Sass assets. Typically
these are located in the ./sass folder.
An array that contains the paths to templates included in this package or an object
keyed by those paths. When using strings, the $template.json file is loaded from there.
Otherwise, the value is the Cmd.template.json.Manifest.
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).
The package's type. The role of "theme" packages is the most significantly different
as it controls whether CSS builds include all inherited styling. By default, "code"
packages only build their own CSS, though they may use mixins and variables from the
theme.
Defaults to:
"code"
Cmd | Terms of Use