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.
Adds points to the subpath such that the arc described by the circumference of the circle described by the arguments, starting at the given start angle and ending at the given end angle, going in the given direction (defaulting to clockwise), is added to the path, connected to the previous point by a straight line.
x : Object
y : Object
radius : Object
startAngle : Object
endAngle : Object
anticlockwise : Object
Adds an arc with the given control points and radius to the current subpath, connected to the previous point by a straight line. If two radii are provided, the first controls the width of the arc's ellipse, and the second controls the height. If only one is provided, or if they are the same, the arc is from a circle.
In the case of an ellipse, the rotation argument controls the clockwise inclination of the ellipse relative to the x-axis.
x1 : Object
y1 : Object
x2 : Object
y2 : Object
radius : Object
Adds the given point to the current subpath, connected to the previous one by a cubic Bézier curve with the given control points.
c1x : Object
c1y : Object
c2x : Object
c2y : Object
x : Object
y : Object
Clears all pixels on the canvas in the given rectangle to transparent black.
x : Object
y : Object
w : Object
h : Object
Returns an object that represents a linear gradient that paints along the line given by the coordinates represented by the arguments.
x0 : Object
y0 : Object
x1 : Object
y1 : Object
Returns a CanvasGradient object that represents a radial gradient that paints along the cone given by the circles represented by the arguments. If either of the radii are negative, throws an IndexSizeError exception.
x0 : Object
y0 : Object
r0 : Object
x1 : Object
y1 : Object
r1 : Object
Draws the given image onto the canvas. If the first argument isn't an img, canvas, or video element, throws a TypeMismatchError exception. If the image has no image data, throws an InvalidStateError exception. If the one of the source rectangle dimensions is zero, throws an IndexSizeError exception. If the image isn't yet fully decoded, then nothing is drawn.
img_elem : Object
arg1 : Object
arg2 : Object
arg3 : Object
arg4 : Object
dst_x : Object
dst_y : Object
dw : Object
dh : Object
Paints the given rectangle onto the canvas, using the current fill style.
x : Object
y : Object
w : Object
h : Object
Fills the given text at the given position. If a maximum width is provided, the text will be scaled to fit that width if necessary.
text : Object
x : Object
y : Object
maxWidth : Object
Adds the given point to the current subpath, connected to the previous one by a straight line.
x : Object
y : Object
Adds the given point to the current subpath, connected to the previous one by a quadratic Bézier curve with the given control point.
cx : Object
cy : Object
x : Object
y : Object
Adds a new closed subpath to the path, representing the given rectangle.
x : Object
y : Object
w : Object
h : Object
Scales the transformation matrix.
sx : Object
sy : Object
Changes the transformation matrix to the matrix given by the arguments as described below.
x2x : Object
x2y : Object
y2x : Object
y2y : Object
newDx : Object
newDy : Object
Strokes the subpaths of the current default path or the given path with the current stroke style.
Paints the box that outlines the given rectangle onto the canvas, using the current stroke style.
x : Object
y : Object
w : Object
h : Object
Strokes the given text at the given position. If a maximum width is provided, the text will be scaled to fit that width if necessary.
text : Object
x : Object
y : Object
maxWidth : Object
Changes the transformation matrix to apply the matrix given by the arguments as described below.
x2x : Object
x2y : Object
y2x : Object
y2y : Object
newDx : Object
newDy : Object
Translates the transformation matrix.
dx : Object
dy : Object
Normally, a surface will have a single canvas. However, on certain platforms/browsers there's a limit to how big a canvas can be. 'splitThreshold' is used to determine maximum width/height of a single canvas element. When a surface is wider/taller than the splitThreshold, extra canvas element(s) will be created and tiled inside the surface.
rect : Object