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 instantiated for each event record passed to the ST#play
method. The items in the array passed to ST#play are passed to the
constructor as the config object.
Determines if animations must complete before this event is ready to be played.
Specify null to disable animation checks.
Defaults to:
true
Determines if the target and relatedTarget must be present in the dom (descendants
of document.body) before this event is ready to be played. Specify false to wait
for elements to be non-available. Specify null to disable availability checks.
Defaults to:
true
The number of milliseconds of delay to inject after playing the previous event before playing this event.
The function to call when playing this event. If this config is set, the type
property is ignored and nothing is injected.
If this function returns a Promise that promise is resolved before the next
event is played. Otherwise, this function should complete before returning. If
this is not desired, the function must declare a single argument (typically named
"done" and call this function when processing is finished).
[{
fn: function () {
// either finish up now or return a Promise
}
}, {
fn: function (done) {
somethingAsync(function () {
// do stuff
done(); // mark this event as complete
});
}
}]
An optional function that returns true when this event can be played. This config
will replace the ready method.
The maximum time (in milliseconds) to wait for this event to be ready. If this
time is exceeded, playback will be aborted.
For injectable events this property holds the event type. For example, "mousedown". This should not be specified for non-injectable events.
Determines if the target and relatedTarget must be visible before this event is
ready to be played. Specify false to wait for elements to be non-visible. Specify
null to disable visibility checks.
Defaults to:
true
The browser Context in which to play this Playable. For example either Local, which plays events directly into the current window/document or Webdriver, which uses webdriverio calls to play events remotely via the webdriverio API. context
This string contains the name of the item preventing readiness of this event. For
example, "target" or "relatedTarget". This is used to formulate an appropriate
error message should the timeout be exceeded. See setWaiting for setting
this value.
This string describes the aspect of the item preventing readiness of this event.
For example, "available" or "visible". This is used to formulate an appropriate
error message should the timeout be exceeded. See setWaiting for setting
this value.
The timestamp recorded when the event is first checked for readiness and found
not ready.
Defaults to:
0
Returns true when there are no animations in progress. This method respects the
animation config to disable this check.
From an playable config object (event) determine if the Playable type has an fn to execute when played. Allows the Player to decide whether to playFn() or inject() without instantiating the event.
event : Object
Returns true when this event is ready to be played. This method checks for the
existence and visibility (based on the visible config) of the target and
relatedTarget elements. In addition, this method also waits for animations to
finish (based on the animation config).
Updates the waitingFor and waitingState properties given their provided values
and returns true if this call clears the waitingFor property.
This method is not normally called by user code but should be called if a custom
ready method is provided to ensure timeouts have helpful state information.
waitingFor : Boolean/String
The waitingFor value or false to clear
the waiting state.
waitingState : String
The waitingState value.
true if waitingFor is false and false otherwise.
Returns true when the specified target is ready. The ST.Element instance is
cached on this object based on the specified name (e.g., "targetEl"). This method
respects the visible config as part of this check.
name : Boolean/String (optional)
The name of the target property. This is
the name of the property that holds the ST.Locator. If
true or false are specified, these indicate the relatedTarget or target,
respectively.
Defaults to: "target"
Sencha Test | Terms of Use