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 mixin which allows a data component to be sorted. This is used by e.g. Ext.data.Store and Ext.data.TreeStore.
NOTE: This mixin is mainly for internal use and most users should not need to use it directly. It is more likely you will want to use one of the component classes that import this mixin, such as Ext.data.Store or Ext.data.TreeStore.
The default sort direction to use if one is not specified.
Defaults to:
"ASC"
The default sort direction to use if one is not specified.
Defaults to:
"ASC"
The maximum number of sorters which may be applied to this Sortable when using the "multi" insertion position when adding sorters.
New sorters added using the "multi" insertion position are inserted at the top of the sorters list becoming the new primary sort key.
If the sorters collection has grown to longer then multiSortLimit, then it is trimmed.
Defaults to:
3
The maximum number of sorters which may be applied to this Sortable when using the "multi" insertion position when adding sorters.
New sorters added using the "multi" insertion position are inserted at the top of the sorters list becoming the new primary sort key.
If the sorters collection has grown to longer then multiSortLimit, then the it is trimmed.
Defaults to:
3
The initial set of Ext.util.Sorter.
sorters: [{
property: 'age',
direction: 'DESC'
}, {
property: 'firstName',
direction: 'ASC'
}]
Defaults to:
null
The initial set of Ext.util.Sorter.
sorters: [{
property: 'age',
direction: 'DESC'
}, {
property: 'firstName',
direction: 'ASC'
}]
Defaults to:
null
true in this class to identify an object as an instantiated Sortable, or subclass thereof.
Defaults to:
true
true in this class to identify an object as an instantiated Sortable, or subclass thereof.
Defaults to:
true
Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances
sorters : Object[]
The sorters array
Array of Ext.util.Sorter objects
Returns a comparator function which compares two items and returns -1, 0, or 1 depending on the currently defined set of cfg-sorters.
If there are no cfg-sorters defined, it returns a function which returns 0 meaning
that no sorting will occur.
Returns a comparator function which compares two items and returns -1, 0, or 1 depending on the currently defined set of cfg-sorters.
If there are no cfg-sorters defined, it returns a function which returns 0 meaning
that no sorting will occur.
Gets the first sorter from the sorters collection, excluding any groupers that may be in place
The sorter, null if none exist
Returns the number of Sorters which apply to this Sortable.
May be overridden in subclasses. Ext.data.Store in particlar overrides this because its groupers must contribute to the sorter count so that the sort method above executes doSort.
Updates the sorters collection and triggers sorting of this Sortable. Example usage:
//sort by a single field
myStore.sort('myField', 'DESC');
//sorting by multiple fields
myStore.sort([{
property : 'age',
direction: 'ASC'
}, {
property : 'name',
direction: 'DESC'
}]);
Classes which use this mixin must implement a soSort method which accepts a comparator
function computed from the full sorter set which performs the sort
in an implementation-specific way.
When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:
store.sort('myField');
store.sort('myField');
Is equivalent to this code, because Store handles the toggling automatically:
store.sort('myField', 'ASC');
store.sort('myField', 'DESC');
sorters : String/Ext.util.Sorter[] (optional)
Either a string name of one of the fields in this Store's configured Ext.data.Model, or an array of sorter configurations.
direction : String (optional)
The overall direction to sort the data by.
Defaults to: "ASC"
insertionPosition : String (optional)
Where to put the new sorter in the collection of sorters. This may take the following values:
replace: This means that the new sorter(s) becomes the sole sorter set for this Sortable.
This is the most useful call mode to programatically sort by multiple fields.
prepend: This means that the new sorters are inserted as the primary sorters, unchanged,
and the sorter list length must be controlled by the developer.
multi: This is mainly useful for implementing intuitive "Sort by this" user interfaces
such as the GridPanel's column sorting UI. This mode is only
supported when passing a property name and a direction. This means that the new sorter
becomes the primary sorter. If the sorter was already the primary sorter, the direction
of sort is toggled if no direction parameter is specified. The number of sorters maintained
is limited by the multiSortLimit configuration.
append : This means that the new sorter becomes the last sorter.
Defaults to: "replace"
doSort : Boolean
True to sort using a generated sorter function that combines all of the Sorters passed
The new sorters.
Updates the sorters collection and triggers sorting of this Sortable. Example usage:
//sort by a single field
myStore.sort('myField', 'DESC');
//sorting by multiple fields
myStore.sort([{
property : 'age',
direction: 'ASC'
}, {
property : 'name',
direction: 'DESC'
}]);
Classes which use this mixin must implement a soSort method which accepts a comparator function computed from
the full sorter set which performs the sort in an implementation-specific way.
When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:
store.sort('myField');
store.sort('myField');
Is equivalent to this code, because Store handles the toggling automatically:
store.sort('myField', 'ASC');
store.sort('myField', 'DESC');
sorters : String/Ext.util.Sorter[] (optional)
Either a string name of one of the fields in this Store's configured Ext.data.Model, or an array of sorter configurations.
direction : String (optional)
The overall direction to sort the data by.
Defaults to: "ASC"
insertionPosition : String (optional)
Where to put the new sorter in the collection of sorters. This may take the following values:
replace : This means that the new sorter(s) becomes the sole sorter set for this Sortable. This is the most useful call mode
to programatically sort by multiple fields.
prepend : This means that the new sorters are inserted as the primary sorters, unchanged, and the sorter list length must be controlled by the developer.
multi : This is mainly useful for implementing intuitive "Sort by this" user interfaces such as the GridPanel's column sorting UI.
This mode is only supported when passing a property name and a direction.
This means that the new sorter is becomes the primary sorter. If the sorter was already the primary sorter, the direction of sort is toggled if no direction parameter is specified.
The number of sorters maintained is limited by the multiSortLimit configuration.
append : This means that the new sorter becomes the last sorter.
Defaults to: "replace"
doSort : Boolean
True to sort using a generated sorter function that combines all of the Sorters passed
The new sorters.
Creates a single comparator function which encapsulates the passed Sorter array.
sorters : Ext.util.Sorter[]
The sorter set for which to create a comparator function
a function, which when passed two comparable objects returns the result of the whole sorter comparator functions.
Creates a single comparator function which encapsulates the passed Sorter array.
sorters : Ext.util.Sorter[]
The sorter set for which to create a comparator function
a function, which when passed two comparable objects returns the result of the whole sorter comparator functions.
Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
Fires before a sort occurs.
me : Ext.util.Sortable
This object.
sorters : Ext.util.Sorter[]
The collection of Sorters being used to generate the comparator function.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a sort occurs.
me : Ext.util.Sortable
This object.
sorters : Ext.util.Sorter[]
The collection of Sorters being used to generate the comparator function.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
ExtReact | Terms of Use