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 not created by user code. It is created by the Sencha Test Event Recorder in Sencha Studio via the injected ST#startRecording method call.
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:
300
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:
200
High-frequency events that should be throttled during recording (if throttle > 0)
Defaults to:
{
mousemove: 1,
touchmove: 1,
pointermove: 1,
MSPointerMove: 1,
scroll: 1
}
We need to capture all pointer events for certain elements (e.g. grid column headers), so the class names of those elements should be defined here. All pointer events (e.g. "pointermove", "pointerover") associated with those matched elements will then be captured (not blocked) by the event recorder.
Defaults to:
/x-column-header-trigger|x-trigger-el/
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 most pointerover, pointerout, pointerenter, pointerleave, and pointermove events
from being recorded, due to the very large number of these events that occur when using event
recorder on an application.
All of these events can specifically be allowed for certain elements by including the
className of the element in allowedPointerElementClasses.
Defaults to:
{
pointerover: 1,
pointerout: 1,
pointerenter: 1,
pointerleave: 1,
pointermove: 1,
mouseover: 1,
mouseout: 1,
mouseenter: 1,
mouseleave: 1,
mousemove: 1,
MSPointerOver: 1,
MSPointerOut: 1,
MSPointerEnter: 1,
MSPointerLeave: 1,
MSPointerMove: 1
}
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
}
Removes from the recording the source event(s) that triggered a scroll event
scrollEvent : ST.event.Event
The scroll event
Detects if the given event should be blocked from being recorded.
e : ST.event.Event
now : Number
Current time stamp
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.
Fires when this object is started.
this : Ext.ux.event.Driver
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this object is stopped.
this : Ext.ux.event.Driver
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Sencha Test | Terms of Use