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.
Ext.Mixin
Ext.mixin.Bindable
Ext.mixin.ComponentDelegation
Ext.mixin.Identifiable
Ext.mixin.Inheritable
Ext.mixin.Observable
Ext.mixin.Pluggable
Ext.mixin.Traversable
Displays a value within the given interval as a gauge. For example:
It's also possible to use gauges to create loading indicators:
The angle at which the minValue starts in case of a circular gauge.
Defaults to:
0
The animation applied to the gauge on changes to the value and the angleOffset configs. Defaults to 1 second animation with the 'out' easing.
Defaults to:
true
duration : Number
The duraction of the animation.
easing : String
The easing function to use for the animation. Possible values are:
linear - no easing, no accelerationin - accelerating from zero velocityout - (default) decelerating to zero velocityinOut - acceleration until halfway, then decelerationtrue - value increments in a clockwise fashion
false - value increments in an anticlockwise fashion
Defaults to:
true
Gauge sector padding in pixels or percent of width/height, whichever is smaller.
Defaults to:
10
If the gauge has a donut hole, the text will be centered inside it.
Otherwise, the text will be centered in the middle of the gauge's
bounding box. This config allows to alter the position of the text
in the latter case. See the docs for the align option to the
{@Ext.util.Region#alignTo} method for possible ways of alignment
of the text to the guage's bounding box.
Defaults to:
'c-c'
The template for the text in the center of the gauge. The available data values are:
value - The value of the gauge.percent - The value as a percentage between 0 and 100.minValue - The value of the minValue config.maxValue - The value of the maxValue config.delta - The delta between the minValue and maxValue.Defaults to:
[
'<tpl>{value:number("0.00")}%</tpl>'
]
The angle in the (0, 360] interval to add to the trackStart angle to determine the angle at which the track ends.
Defaults to:
270
The angle in the [0, 360) interval at which the gauge's track sector starts. E.g. 0 for 3 o-clock, 90 for 6 o-clock, 180 for 9 o-clock, 270 for noon.
Defaults to:
135
Track sector styles.
Defaults to:
{
outerRadius: '100%',
innerRadius: '100% - 20',
round: false
}
fill : String/Object[]
Track sector fill color. Defaults to CSS value. It's also possible to have a linear gradient fill that starts at the top-left corner of the gauge and ends at its bottom-right corner, by providing an array of color stop objects. For example:
trackStyle: {
fill: [{
offset: 0,
color: 'green',
opacity: 0.8
}, {
offset: 1,
color: 'gold'
}]
}
fillOpacity : Number
Track sector fill opacity. Defaults to CSS value.
stroke : String
Track sector stroke color. Defaults to CSS value.
strokeOpacity : Number
Track sector stroke opacity. Defaults to CSS value.
strokeWidth : Number
Track sector stroke width. Defaults to CSS value.
outerRadius : Number/String
The outer radius of the track sector. For example:
outerRadius: '90%', // 90% of the maximum radius
outerRadius: 100, // radius of 100 pixels
outerRadius: '70% + 5', // 70% of the maximum radius plus 5 pixels
outerRadius: '80% - 10', // 80% of the maximum radius minus 10 pixels
Defaults to: '100%'
innerRadius : Number/String
The inner radius of the track sector.
See the trackStyle.outerRadius config documentation for more information.
Defaults to: '50%'
round : Boolean
Whether to round the track sector edges or not.
Defaults to: false
Value sector styles.
Defaults to:
{
outerRadius: '100% - 2',
innerRadius: '100% - 18',
round: false
}
fill : String/Object[]
Value sector fill color. Defaults to CSS value.
See the trackStyle.fill config documentation for more information.
fillOpacity : Number
Value sector fill opacity. Defaults to CSS value.
stroke : String
Value sector stroke color. Defaults to CSS value.
strokeOpacity : Number
Value sector stroke opacity. Defaults to CSS value.
strokeWidth : Number
Value sector stroke width. Defaults to CSS value.
outerRadius : Number/String
The outer radius of the value sector.
See the trackStyle.outerRadius config documentation for more information.
Defaults to: '100% - 4'
innerRadius : Number/String
The inner radius of the value sector.
See the trackStyle.outerRadius config documentation for more information.
Defaults to: '50% + 4'
round : Boolean
Whether to round the value sector edges or not.
Defaults to: false
from : Object
to : Object
duration : Object
easing : Object
fn : Object
scope : Object
width : Object
height : Object
padding : Object
startAngle : Object
lengthAngle : Object
ratio : Object
Given a rect with a known width and height, find the maximum radius of the donut sector that can fit into it, as well as the center point of such a sector. The end and start angles of the sector are also known, as well as the relationship between the inner and outer radii.
width : Object
height : Object
startAngle : Object
lengthAngle : Object
ratio : Object
startAngle : Object
lengthAngle : Object
gradient : Object
x1 : Object
y1 : Object
x2 : Object
y2 : Object
Ext JS | Terms of Use