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.
If the surface is in the RTL mode, text will render with the RTL direction, but the alignment and position of the text won't change by default. Setting this config to 'true' will get text alignment and its position within a surface mirrored.
Defaults to:
false
The reported device pixel density. devicePixelRatio is only supported from IE11, so we use deviceXDPI and logicalXDPI that are supported from IE6.
Defaults to:
window.devicePixelRatio || window.screen.deviceXDPI / window.screen.logicalXDPI
This flag is used to indicate that predecessors surfaces that should render
before this surface renders are dirty, and to call renderFrame
when all predecessors have their renderFrame called (i.e. not dirty anymore).
This flag indicates that current surface has surfaces that are yet to render
before current surface can render. When all the predecessors surfaces
have rendered, i.e. when dirtyPredecessorCount reaches zero,
Defaults to:
false
Add a Sprite to the surface. You can put any number of objects as the parameter. See Ext.draw.sprite.Sprite for the configuration object to be passed into this method.
For example:
drawContainer.getSurface().add({
type: 'circle',
fill: '#ffc',
radius: 100,
x: 100,
y: 100
});
drawContainer.renderFrame();
sprite : Object/Object[]
Creates an item and appends it to the surface. Called
as an internal method when calling add.
config : Object
Creates a DOM element under the SVG namespace of the given type.
type : String
The type of the SVG DOM element.
The created element.
Flattens the given drawing surfaces into a single image and returns an object containing the data (in the DataURL format) and the type (e.g. 'png' or 'svg') of that image.
surfaces : Ext.draw.Surface[]
The surfaces to flatten.
Get the sprite by id or index. It will first try to find a sprite with the given id, otherwise will try to use the id as an index.
id : String/Number
Return the minimal bounding box that contains all the sprites bounding boxes in the given list of sprites.
sprites : Ext.draw.sprite.Sprite[]/Ext.draw.sprite.Sprite
isWithoutTransform : Boolean (optional)
Defaults to: false
{{x: Number, y: Number, width: number, height: number}}
Gets the next reference element under the SVG 'defs' tag.
tagName : String
The type of reference element.
The reference element.
Returns the SVG DOM element at the given position. If it does not already exist or is a different element tag it will be created and inserted into the DOM.
group : Ext.dom.Element
The parent DOM element.
tag : String
The SVG element tag.
position : Number
The position of the element in the DOM.
The SVG element.
Performs a hit test on all sprites in the surface, returning the first matching one.
point : Array
A two-item array containing x and y coordinates of the point.
options : Object
Hit testing options.
A hit result object that contains more information about what exactly was hit or null if nothing was hit.
Performs a hit test on all sprites in the surface, returning the first matching one. Since hit testing is typically performed on mouse events, this convenience method converts event's page coordinates to surface coordinates before calling hitTest.
point : Array
An event object.
options : Object
Hit testing options.
A hit result object that contains more information about what exactly was hit or null if nothing was hit.
Invoked when a sprite is added to the surface.
sprite : Ext.draw.sprite.Sprite
The sprite to be added.
Remove a given sprite from the surface,
optionally destroying the sprite in the process.
You can also call the sprite's own remove method.
For example:
drawContainer.surface.remove(sprite);
// or...
sprite.remove();
sprite : Ext.draw.sprite.Sprite/String
A sprite instance or its ID.
isDestroy : Boolean (optional)
If true, the sprite will be destroyed.
Defaults to: false
Returns the removed/destroyed sprite or null otherwise.
Remove all sprites from the surface, optionally destroying the sprites in the process.
For example:
drawContainer.getSurface('main').removeAll();
isDestroy : Boolean (optional)
Defaults to: false
Renders a single sprite into the surface.
Do not call it from outside renderFrame method.
sprite : Ext.draw.sprite.Sprite
The Sprite to be rendered.
returns false to stop the rendering to continue.
Round the number to align to the pixels on device.
num : Number
The number to align.
The resultant alignment.
Serializes an SVG DOM element and its children recursively into a string.
node : Object
DOM element to serialize.
Applies attributes to the given element.
element : Ext.dom.Element
The DOM element to be applied.
attributes : Object
The attributes to apply to the element.
Mark the surface to render after another surface is updated.
surface : Ext.draw.Surface
The surface to wait for.
Ext JS | Terms of Use