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.1 - Modern Toolkit


top

Ext.Number singleton

Hierarchy

Ext.Number

Summary

A collection of useful static methods to deal with numbers

No members found using the current filters

properties

Instance Properties

isFinite

Determines if the value passed is a number and also finite. This a Polyfill version of Number.isFinite(),differently than the isFinite() function, this method doesn't convert the parameter to a number.

Defaults to:

Number.isFinite || function(value) {
    return typeof value === 'number' && isFinite(value);
}

Available since: 6.2

Parameters

value :  Number

Number to be tested.

Returns

:Boolean
`true`, if the parameter is a number and finite, `false` otherwise.

methods

Instance Methods

clipIndices ( length, indices, [options] ) : Number[]

Coerces a given index into a valid index given a length.

Negative indexes are interpreted starting at the end of the collection. That is, a value of -1 indicates the last item, or equivalent to length - 1.

When handling methods that take "begin" and "end" arguments like most array or string methods, this method can be used like so:

 function foo (array, begin, end) {
     var range = Ext.Number.clipIndices(array.length, [begin, end]);

     begin = range[0];
     end   = range[1];

     // 0 <= begin <= end <= array.length

     var length = end - begin;
 }

For example:

 +---+---+---+---+---+---+---+---+
 |   |   |   |   |   |   |   |   |  length = 8
 +---+---+---+---+---+---+---+---+
   0   1   2   3   4   5   6   7
  -8  -7  -6  -5  -4  -3  -2  -1

 console.log(Ext.Number.clipIndices(8, [3, 10]); // logs "[3, 8]"
 console.log(Ext.Number.clipIndices(8, [-5]);    // logs "[3, 8]"
 console.log(Ext.Number.clipIndices(8, []);
 console.log(Ext.Number.clipIndices(8, []);

Parameters

length :  Number

indices :  Number[]

options :  Object (optional)

An object with different option flags.

count :  Boolean (optional)

The second number in indices is the count not and an index.

Defaults to:

false

inclusive :  Boolean (optional)

The second number in indices is "inclusive" meaning that the item should be considered in the range. Normally, the second number is considered the first item outside the range or as an "exclusive" bound.

Defaults to:

false

wrap :  Boolean (optional)

Wraps negative numbers backwards from the end of the array. Passing false simply clips negative index values at 0.

Defaults to:

true

Returns

:Number[]
The normalized `[begin, end]` array where `end` is now exclusive such that `length = end - begin`. Both values are between 0 and the given `length` and `end` will not be less-than `begin`.

constrain ( number, min, max ) : Number

Checks whether or not the passed number is within a desired range. If the number is already within the range it is returned, otherwise the min or max value is returned depending on which side of the range is exceeded. Note that this method returns the constrained value but does not change the current number.

Parameters

number :  Number

The number to check

min :  Number

The minimum number in the range

max :  Number

The maximum number in the range

Returns

:Number
The constrained value if outside the range, otherwise the current value

correctFloat ( n ) : Number

Corrects floating point numbers that overflow to a non-precise value because of their floating nature, for example 0.1 + 0.2

Parameters

n :  Number

The number

Returns

:Number
The correctly rounded number

from ( value, defaultValue ) : Number

Validate that a value is numeric and convert it to a number if necessary. Returns the specified default value if it is not.

Ext.Number.from('1.23', 1); // returns 1.23 Ext.Number.from('abc', 1); // returns 1

Parameters

value :  Object

defaultValue :  Number

The value to return if the original value is non-numeric

Returns

:Number
value, if numeric, defaultValue otherwise

isEqual ( n1, n2, epsilon ) : Boolean

Determines if two numbers n1 and n2 are equal within a given margin of precision epsilon.

Parameters

n1 :  Number

First number.

n2 :  Number

Second number.

epsilon :  Number

Margin of precision.

Returns

:Boolean
`true`, if numbers are equal. `false` otherwise.

log10 ( x ) : Number

Returns the base 10 logarithm of a number. This will use Math.log10, if available (ES6).

Parameters

x :  Number

The number.

Returns

:Number
Base 10 logarithm of the number 'x'.

randomInt ( from, to ) : Number

Returns a random integer between the specified range (inclusive)

Parameters

from :  Number

Lowest value to return.

to :  Number

Highest value to return.

Returns

:Number
A random integer within the specified range.

roundToNearest ( value, interval ) : Number

Round a number to the nearest interval.

Available since: 6.2.0

Parameters

value :  Number

The value to round.

interval :  Number

The interval to round to.

Returns

:Number
The rounded value.

sign ( x ) : Number

Returns the sign of the given number. See also MDN for Math.sign documentation for the standard method this method emulates.

Parameters

x :  Number

The number.

Returns

:Number
The sign of the number `x`, indicating whether the number is positive (1), negative (-1) or zero (0).

snap ( value, increment, minValue, maxValue ) : Number

Snaps the passed number between stopping points based upon a passed increment value.

The difference between this and snapInRange is that snapInRange uses the minValue when calculating snap points:

r = Ext.Number.snap(56, 2, 55, 65);        // Returns 56 - snap points are zero based

r = Ext.Number.snapInRange(56, 2, 55, 65); // Returns 57 - snap points are based from minValue

Parameters

value :  Number

The unsnapped value.

increment :  Number

The increment by which the value must move.

minValue :  Number

The minimum value to which the returned value must be constrained. Overrides the increment.

maxValue :  Number

The maximum value to which the returned value must be constrained. Overrides the increment.

Returns

:Number
The value of the nearest snap target.

snapInRange ( value, increment, [minValue], [maxValue] ) : Number

Snaps the passed number between stopping points based upon a passed increment value.

The difference between this and snap is that snap does not use the minValue when calculating snap points:

r = Ext.Number.snap(56, 2, 55, 65);        // Returns 56 - snap points are zero based

r = Ext.Number.snapInRange(56, 2, 55, 65); // Returns 57 - snap points are based from minValue

Parameters

value :  Number

The unsnapped value.

increment :  Number

The increment by which the value must move.

minValue :  Number (optional)

The minimum value to which the returned value must be constrained.

Defaults to: 0

maxValue :  Number (optional)

The maximum value to which the returned value must be constrained.

Defaults to: Infinity

Returns

:Number
The value of the nearest snap target.

toFixed ( value, precision )

Formats a number using fixed-point notation

Parameters

value :  Number

The number to format

precision :  Number

The number of digits to show after the decimal point

Ext JS 6.2.1 - Modern Toolkit