Docs Help

Terms, Icons, and Labels

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.

Access Levels

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.

Member Types

Member Syntax

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).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

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.

Class Icons

- 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

Member Icons

- 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

Class Member Quick-Nav Menu

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.

Getter and Setter Methods

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.

History Bar

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.

Search and Filters

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.

API Doc Class Metadata

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:

Expanding and Collapsing Examples and Class Members

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.

Desktop -vs- Mobile View

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:

Viewing the Class Source

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 JS 6.2.0 - Modern Toolkit


top

Ext.ux.Gauge xtype: gauge

Summary

Displays a value within the given interval as a gauge. For example:

It's also possible to use gauges to create loading indicators:

No members found using the current filters

configs

Optional Configs

angleOffset : Number
bindable bind

The angle at which the minValue starts in case of a circular gauge.

Defaults to:

0

getAngleOffset : Number

Returns the value of angleOffset

Returns

Number

setAngleOffset (angleOffset)

Sets the value of angleOffset

Parameters

angleOffset :  Number

animation : Object / Boolean
bindable bind

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

Properties

duration : Number

The duraction of the animation.

easing : String

The easing function to use for the animation. Possible values are:

  • linear - no easing, no acceleration
  • in - accelerating from zero velocity
  • out - (default) decelerating to zero velocity
  • inOut - acceleration until halfway, then deceleration

getAnimation : Object / Boolean

Returns the value of animation

Returns

Object / Boolean

setAnimation (animation)

Sets the value of animation

Parameters

animation :  Object / Boolean

clockwise : Boolean
bindable bind

true - value increments in a clockwise fashion false - value increments in an anticlockwise fashion

Defaults to:

true

getClockwise : Boolean

Returns the value of clockwise

Returns

Boolean

setClockwise (clockwise)

Sets the value of clockwise

Parameters

clockwise :  Boolean

maxValue : Number
bindable bind

The maximum value that the gauge can represent.

Defaults to:

100

getMaxValue : Number

Returns the value of maxValue

Returns

Number

setMaxValue (maxValue)

Sets the value of maxValue

Parameters

maxValue :  Number

minValue : Number
bindable bind

The minimum value that the gauge can represent.

Defaults to:

0

getMinValue : Number

Returns the value of minValue

Returns

Number

setMinValue (minValue)

Sets the value of minValue

Parameters

minValue :  Number

padding : Number / String
bindable bind

Gauge sector padding in pixels or percent of width/height, whichever is smaller.

Defaults to:

10

getPadding : Number / String

Returns the value of padding

Returns

Number / String

setPadding (padding)

Sets the value of padding

Parameters

padding :  Number / String

textAlign : String
bindable bind

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'

getTextAlign : String

Returns the value of textAlign

Returns

String

setTextAlign (textAlign)

Sets the value of textAlign

Parameters

textAlign :  String

textTpl : Ext.XTemplate
bindable bind

The template for the text in the center of the gauge. The available data values are:

Defaults to:

[
    '<tpl>{value:number("0.00")}%</tpl>'
]

getTextTpl : Ext.XTemplate

Returns the value of textTpl

Returns

Ext.XTemplate

setTextTpl (textTpl)

Sets the value of textTpl

Parameters

textTpl :  Ext.XTemplate

trackLength : Number
bindable bind

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

getTrackLength : Number

Returns the value of trackLength

Returns

Number

setTrackLength (trackLength)

Sets the value of trackLength

Parameters

trackLength :  Number

trackStart : Number
bindable bind

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

getTrackStart : Number

Returns the value of trackStart

Returns

Number

setTrackStart (trackStart)

Sets the value of trackStart

Parameters

trackStart :  Number

trackStyle : Object
bindable bind

Track sector styles.

Defaults to:

{
    outerRadius: '100%',
    innerRadius: '100% - 20',
    round: false
}

Properties

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

getTrackStyle : Object

Returns the value of trackStyle

Returns

Object

setTrackStyle (trackStyle)

Sets the value of trackStyle

Parameters

trackStyle :  Object

value : Number
bindable bind

The current value of the gauge.

Defaults to:

50

getValue : Number

Returns the value of value

Returns

Number

setValue (value)

Sets the value of value

Parameters

value :  Number

valueStyle : Object
bindable bind

Value sector styles.

Defaults to:

{
    outerRadius: '100% - 2',
    innerRadius: '100% - 18',
    round: false
}

Properties

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

getValueStyle : Object

Returns the value of valueStyle

Returns

Object

setValueStyle (valueStyle)

Sets the value of valueStyle

Parameters

valueStyle :  Object

methods

Instance Methods

animate ( from, to, duration, easing, fn, scope )
private pri

Parameters

from :  Object

to :  Object

duration :  Object

easing :  Object

fn :  Object

scope :  Object

camelToHyphen ( name )
private pri

Parameters

name :  Object

createInterpolator ( rangeCheck )
private pri

Parameters

rangeCheck :  Object

fitSectorInPaddedRect ( width, height, padding, startAngle, lengthAngle, ratio )
private pri

Parameters

width :  Object

height :  Object

padding :  Object

startAngle :  Object

lengthAngle :  Object

ratio :  Object

fitSectorInRect ( width, height, startAngle, lengthAngle, ratio )
private pri

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.

Parameters

width :  Object

height :  Object

startAngle :  Object

lengthAngle :  Object

ratio :  Object

getRadiusFn ( radius )
private pri

Parameters

radius :  Object

getUnitSectorExtrema ( startAngle, lengthAngle )
private pri

Parameters

startAngle :  Object

lengthAngle :  Object

normalizeAngle ( angle )
private pri

Parameters

angle :  Object

resizeGradients ( size )
private pri

Parameters

size :  Object

setGradientSize ( gradient, x1, y1, x2, y2 )
private pri

Parameters

gradient :  Object

x1 :  Object

y1 :  Object

x2 :  Object

y2 :  Object

setGradientStops ( gradient, stops )
private pri

Parameters

gradient :  Object

stops :  Object

stopAnimation

Stops the current value or angleOffset animation.

Ext JS 6.2.0 - Modern Toolkit