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

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.


item :  Object

The config object being added.


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.

Sencha Test 2.1.0





This class is not created by user code. It is created by the Sencha Test Event Recorder in Sencha Studio via the injected ST#startRecording method call.

No members found using the current filters


Optional Configs

scrollThreshold : Number

if a "scroll" event occurs within this many milliseconds after a wheel, touchmove, or pointermove with pointerType == 'touch' within the same element, the wheel, touchmove or pointermove event will be removed from the recording. The scroll event is all we need for playback - playing back both the scroll event and the event that triggered the scroll could cause more scrolling than desired.

Defaults to:


throttle : Number

Number of milliseconds to use for throttling events (only events contained in throttledEvents are eligible for throttling). Set to 0 to disable throttling and add all events to the recording. Only consecutive events of the same type are throttled. This approach ensures consistency when interleaving mousemove/mouseover/mouseout events - for example a mouseout would always be preceded by a mousemove, even if the throttling threshold had not yet been reached.

Defaults to:


throttledEvents : Object

High-frequency events that should be throttled during recording (if throttle > 0)

Defaults to:

    mousemove: 1,
    touchmove: 1,
    pointermove: 1,
    MSPointerMove: 1,
    scroll: 1


Instance Properties

private pri

In browsers that implement pointerevents when a pointerdown is triggered by touching the screen, pointerover and pointerenter events will be fired immmediately before the pointerdown. When a pointerup is triggered by a touch, pointerout and pointerleave events are fired imediatetely after. We block pointerover, pointerout, pointerenter, and pointerleave, from being recorded when trigered by touch input, since it is not likely the user intended to record these. Note: this only affects events with pointerType === 'touch' or pointerType === 'pen', we do NOT want to block these events when triggered using a mouse. See also:

Defaults to:

    pointerover: 1,
    pointerout: 1,
    pointerenter: 1,
    pointerleave: 1,
    MSPointerOver: 1,
    MSPointerOut: 1,
    MSPointerEnter: 1,
    MSPointerLeave: 1

private pri

To ensure we do not miss any events that may have been canceled by user code we want to capture the event at the highest level possible. Most events can be captured at the window object, but some events must be captured at the document level.

Defaults to:

    mouseenter: 1,
    mouseleave: 1


Instance Methods

clearScrollSource ( scrollEvent )
private pri

Removes from the recording the source event(s) that triggered a scroll event


scrollEvent :  ST.event.Event

The scroll event


Returns the number of milliseconds since start was called.

isEventBlocked ( e, now ) : Boolean
private pri

Detects if the given event should be blocked from being recorded because it is a emulated "compatibility" mouse event triggered by a touch on the screen, or an emulated pointerover/out/enter/leave triggered by touch screen input.


e :  ST.event.Event

now :  Number

Current time stamp




Starts this object. If this object is already started, nothing happens.


Stops this object. If this object is not started, nothing happens.


add ( this, events, eOpts )

Fires when events are added to the recording.


this :  ST.event.Recorder

events :  ST.event.Event[]

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

start ( this, eOpts )

Fires when this object is started.


this :  Ext.ux.event.Driver

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

stop ( this, eOpts )

Fires when this object is stopped.


this :  Ext.ux.event.Driver

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Sencha Test 2.1.0