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.

Ext JS 7.0.0 - Classic Toolkit

Quick Start
Guides
API
modern
classic
Ext
Ext
Getting Started
What's New?
Core Concepts
Architecture
UI Components
Tutorials
Backend Connectors
Other Resources
Supported Browsers
top

Ext.Boot private singleton

Filters
Related Classes

Hierarchy

Ext.Boot
NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.
No members found using the current filters

configs

assetConfig : Object

A map (url->assetConfig) that contains information about assets loaded by the Microlaoder.

Defaults to: _assetConfig

charset : String

Optional charset to specify encoding of dynamic content.

Defaults to: UTF-8

disableCaching : Boolean

If true current timestamp is added to script URL's to prevent caching. In debug builds, adding a "cache" or "disableCacheBuster" query parameter to the page's URL will set this to false.

Defaults to: true

disableCachingParam : String

The query parameter name for the cache buster's timestamp.

Defaults to: "_dc"

loadDelay : Boolean

Millisecond delay between asynchronous script injection (prevents stack overflow on some user agents) 'false' disables delay but potentially increases stack load.

Defaults to: false

preserveScripts : Boolean

false to remove asynchronously loaded scripts, true to retain script element for browser debugger compatibility and improved load performance.

Defaults to: true

properties

currentFile

contains the current script name being loaded (loadSync or sequential load only)

Defaults to: null

useElements

enables / disables loading scripts via script / link elements rather than using ajax / eval

Defaults to: true

methods

canonicalUrl ( url )
private pri

This method returns a canonical URL for the given URL.

For example, the following all produce the same canonical URL (which is the last one):

 http://foo.com/bar/baz/zoo/derp/../../goo/Thing.js?_dc=12345
 http://foo.com/bar/baz/zoo/derp/../../goo/Thing.js
 http://foo.com/bar/baz/zoo/derp/../jazz/../../goo/Thing.js
 http://foo.com/bar/baz/zoo/../goo/Thing.js
 http://foo.com/bar/baz/goo/Thing.js

Parameters

url :  Object

complete ( response )
private pri

Parameters

response :  Object

complete ( response )
private pri

Parameters

response :  Object

create ( url , key , cfg )
private pri

Parameters

url :  Object

key :  Object

cfg :  Object

createLoadElement ( callback )
private pri

Parameters

callback :  Object

createLoadOrderMap ( loadOrder )
private pri

Parameters

loadOrder :  Object

createLoadOrderMap ( loadOrder )
private pri

Parameters

loadOrder :  Object

detectPlatformTags ( tags )

The default function that detects various platforms and sets tags in the platform map accordingly. Examples are iOS, android, tablet, etc.

Parameters

tags :  Object

the set of tags to populate

expandLoadOrder :
chainable ch private pri

Returns

:

expandUrl ( url , loadOrder , loadOrderMap , indexMap , includeUses , skipLoaded )
private pri

Parameters

url :  Object

loadOrder :  Object

loadOrderMap :  Object

indexMap :  Object

includeUses :  Object

skipLoaded :  Object

expandUrls ( urls , includeUses )
private pri

Parameters

urls :  Object

includeUses :  Object

fetch ( req )
private pri

Parameters

req :  Object

fetch ( url , complete , scope , async )
private pri

Parameters

url :  Object

complete :  Object

scope :  Object

async :  Object

filterPlatform ( platform , excludes )
private pri

Parameters

platform :  Object

excludes :  Object

getConfig ( name ) : Object

Get the config value corresponding to the specified name. If no name is given, will return the config object

Parameters

name :  String

The config property name

Returns

:Object

getElement ( tag )
private pri

Parameters

tag :  Object

getEntry ( url , cfg , canonicalPath )
private pri

Parameters

url :  Object

cfg :  Object

canonicalPath :  Object

getLoadIndexes ( item , indexMap , loadOrder , includeUses , skipLoaded )
private pri

Parameters

item :  Object

indexMap :  Object

loadOrder :  Object

includeUses :  Object

skipLoaded :  Object

getPathsFromIndexes ( indexMap , loadOrder )

this is a helper function used by Ext.Loader to flush out 'uses' arrays for classes in some Ext versions

Parameters

indexMap :  Object

loadOrder :  Object

getPathsFromIndexes ( indexes , loadOrder )
private pri

Parameters

indexes :  Object

loadOrder :  Object

inject ( content , asset ) :
chainable ch private pri

Parameters

content :  Object

asset :  Object

Returns

:

load ( request )
private pri

Parameters

request :  Object

load ( sync ) : Boolean
private pri

Parameters

sync :  Object

Returns

:Boolean

loadBasePrefix ( request )
private pri

Parameters

request :  Object

loadCrossDomain : Boolean
private pri

Returns

:Boolean

loadElement : Boolean
private pri

Returns

:Boolean

loadEntries ( sync )
private pri

Parameters

sync :  Object

loadPlatformsParam : Object

Extracts user supplied platform tags from the "platformTags" query parameter of the form:

 ?platformTags=name:state,name:state,...

(each tag defaults to true when state is unspecified)

Example:

 ?platformTags=isTablet,isPhone:false,isDesktop:0,iOS:1,Safari:true, ...

Returns

:Object

the platform tags supplied by the query string

loadSync ( request )
private pri

Parameters

request :  Object

loadSyncBasePrefix ( request )
private pri

Parameters

request :  Object

notifyAll ( entry )
private pri

Parameters

entry :  Object

onBootReady ( listener )
private pri

Parameters

listener :  Object

onContentLoaded ( response )
private pri

Parameters

response :  Object

onDone ( listener )
private pri

Parameters

listener :  Object

onDone ( listener )
private pri

Parameters

listener :  Object

prepareUrl ( url )
private pri

Parameters

url :  Object

processRequest ( request , sync )
private pri

Parameters

request :  Object

sync :  Object

registerContent ( url , type , content )
private pri

Parameters

url :  Object

type :  Object

content :  Object

requestComplete ( request )
private pri

Parameters

request :  Object

setConfig ( config ) : Ext.Boot

Set the configuration.

Parameters

config :  Object

The config object to override the default values.

Returns

:Ext.Boot

this

Ext JS 7.0.0 - Classic Toolkit

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation