The documentation for the ExtReact product diverges somewhat from the
documentation of other Sencha products. The sections below describe
documentation for all products except where indicated as unique to
ExtReact.
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.
ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.
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.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
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.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
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
Or in the case of an ExtReact component class this
indicates a member of type prop
- 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.
ExtReact component classes do not hoist the getter /
setter methods into the prop. All methods will be described in the
Methods section
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.
A collection of useful static methods to deal with numbers
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
value : Number
Number to be tested.
true, if the parameter is a number and finite, false otherwise.
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, []);
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
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.
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.
number : Number
The number to check
min : Number
The minimum number in the range
max : Number
The maximum number in the range
The constrained value if outside the range, otherwise the current value
Corrects floating point numbers that overflow to a non-precise
value because of their floating nature, for example 0.1 + 0.2
n : Number
The number
The correctly rounded 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
value : Object
defaultValue : Number
The value to return if the original value is non-numeric
value, if numeric, defaultValue otherwise
Determines if two numbers n1 and n2 are equal within a given
margin of precision epsilon.
n1 : Number
First number.
n2 : Number
Second number.
epsilon : Number
Margin of precision.
true, if numbers are equal. false otherwise.
Returns the base 10 logarithm of a number. This will use Math.log10, if available (ES6).
x : Number
The number.
Base 10 logarithm of the number 'x'.
Strictly parses the given value and returns the value as a number or null if
the value is not a number or contains non-numeric pieces.
Available since: 6.5.1
value : String
Strictly parses the given value and returns the value as a number or null if
the value is not an integer number or contains non-integer pieces.
Available since: 6.5.1
value : String
Returns a random integer between the specified range (inclusive)
from : Number
Lowest value to return.
to : Number
Highest value to return.
A random integer within the specified range.
Round a number to the nearest interval.
Available since: 6.2.0
value : Number
The value to round.
interval : Number
The interval to round to.
The rounded value.
Rounds a number to the specified precision.
value : Object
precision : Object
Returns the sign of the given number. See also MDN for Math.sign documentation for the standard method this method emulates.
x : Number
The number.
The sign of the number x, indicating whether the number is
positive (1), negative (-1) or zero (0).
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:
// Returns 56 - snap points are zero based
r = Ext.Number.snap(56, 2, 55, 65);
// Returns 57 - snap points are based from minValue
r = Ext.Number.snapInRange(56, 2, 55, 65);
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.
The value of the nearest snap target.
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:
// Returns 56 - snap points are zero based
r = Ext.Number.snap(56, 2, 55, 65);
// Returns 57 - snap points are based from minValue
r = Ext.Number.snapInRange(56, 2, 55, 65);
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
The value of the nearest snap target.
Formats a number using fixed-point notation
value : Number
The number to format
precision : Number
The number of digits to show after the decimal point
Truncates a number to the specified precision, without rounding.
Available since: 6.5.1
value : Object
precision : Object
ExtAngular | Terms of Use