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.
Instances of this class encapsulate a position in a grid's row/column coordinate system.
Cell addresses are configured using the owning record and column for robustness.
The column may be moved, the store may be sorted, and the grid Location will still reference the same logical cell. Be aware that due to buffered rendering the physical cell may be recycled and used by another record.
The setPosition, setRecord and setColumn methods however, allow numeric row and column values to be passed in. These are immediately converted.
Be careful not to make grid Location objects too persistent. If the owning record
is removed or filtered out, or the owning column is removed, the reference will be stale.
Note that due to buffered rendering, a valid location object might be scrolled out of
visibility, and therefore derendered, and may not not have a corresponding rendered
row.
Also, when using Ext.data.virtual.Store, the record referenced may not be present in the store, and may require an asynchronous load to bring it into the store before the location can be realized.
Freshly created Location objects, such as those exposed by events from the grid selection model are safe to use until your application mutates the store, or changes the column set.
The event that led to the creation of this event. This may be null.
Defaults to:
null
true in this class to identify an object this type, or subclass thereof.
Defaults to:
true
true in this class to identify an object this type, or subclass thereof.
Defaults to:
true
The item in the view, if it backed by a record.
Defaults to:
null
Internal function to allow the clone method to mutate the clone as requested in the options.
column : Object
Creates a clone of this Location, optionally moving either the record or column to a different position.
options : Object (optional)
The different record or column to attach the clone to.
record : Ext.data.Model / Number / Ext.dom.Element (optional)
The different record or
DataView item to attach the clone to.
column : GridColumn / Number (optional)
The different column to which to
attach the clone.
The clone, optionally repositioned using the options parameter.
Create a new Location
view : Ext.grid.Grid
The view.
source : Object
The source for the location. It can be:
Ext.event.Event - An event from the view.Ext.dom.Element/HTMLElement - An element from the view.Ext.Widget - A child component from the view.Ext.data.Model - A record from the view.Number - The record index.Object - An object with 2 properties, the record and column.Navigates to the next visible Location.
options : Boolean/Object (optional)
An options object or a boolean flag meaning wrap
A new Location object representing the new location.
Navigates to the next visible Location.
options : Boolean/Object
An options object or a boolean flag meaning wrap
A new Location object representing the new location.
Compares this grid Location object to another grid Location to see if they refer to the same cell address.
other : Ext.grid.Location
The grid Location to compare.
true if the other cell Location references the same cell address as this.
Compares this grid Location object to another grid Location to see if they refer to the same cell and, if actionable, the same element in the same cell. So an actionable location focused upon a Ext.Tool inside a cell will not be equal to the raw Location of that cell.
other : Ext.grid.Location
The grid Location to compare.
true if the other cell Location references the same cell in the same
action/navigation mode as this.
Returns the GridCell Component referenced at the time of calling. Note that grid DOM is recycled, and the cell referenced may be repurposed for use by another record.
The Cell component referenced by this Location.
Returns the GridCell Component referenced at the time of calling. Note that grid DOM is recycled, and the cell referenced may be repurposed for use by another record.
The Cell component referenced by this Location.
Returns the cell Component referenced at the time of calling. Note that grid DOM is recycled, and the cell referenced may be repurposed for use by another record.
as : "cmp"/"dom"/"el" (optional)
Pass "dom" to always return the cell's HTMLElement.
Pass "el" to return the cell's Ext.dom.Element . Pass "cmp" to
return the cell Ext.Component reference for this location (if one exists).
Defaults to: el
The Cell component referenced by this Location.
Returns the cell Component referenced at the time of calling. Note that grid DOM is recycled, and the cell referenced may be repurposed for use by another record.
as : "cmp"/"dom"/"el" (optional)
Pass "dom" to always return the cell's HTMLElement.
Pass "el" to return the cell's Ext.dom.Element . Pass "cmp" to
return the cell Ext.Component reference for this location (if one exists).
Defaults to: el
The Cell component referenced by this Location.
Returns the view item element referenced at the time of calling..
returnDom : Boolean
Pass true to return a DOM object instead of an {@link Ext.dom.Element Element).
The view item element referenced by this context.
Returns the location's referenced focusEl at the time of calling.
as : "dom"/"el" (optional)
Pass "dom" to always return the item's HTMLElement.
Pass "el" to return the item's Ext.dom.Element.
Defaults to: el
The item focusable element referenced by this location.
Returns the Ext.grid.Row Component referenced at the time of calling. Note that grid DOM is recycled, and the row referenced may be repurposed for use by another record.
The Row component referenced by this Location.
Function to get the new location object based on target columns and the row num.
Column : Ext.Grid.Column
target column in for which we need the location
targetRowIndex : Int
target row in which we need to find the column
Navigates to the next visible Location.
options : Boolean/Object (optional)
An options object or a boolean flag meaning wrap
wrap : Boolean (optional)
true to wrap from the last to the first Location.
A Location object representing the new location.
Navigates to the next visible Location.
options : Boolean/Object
An options object or a boolean flag meaning wrap
A Location object representing the new location.
By default, this will be a new instance. If the move option is passed as true
this instance will be mutated.
Navigates to the next visible cell Location.
options : Boolean/Object
An options object or a boolean flag meaning wrap
wrap : Boolean (optional)
true to wrap from the last to the first Location.
A Location object representing the new location.
Returns a new Location object encapsulating the next item in the DataView.
options : Boolean/Object (optional)
An options object or a boolean flag meaning wrap
wrap : Boolean (optional)
true to wrap from the last to the first Location.
A new Location object representing the new location.
Navigates to the previous visible Location.
options : Boolean/Object (optional)
An options object or a boolean flag meaning wrap
wrap : Boolean (optional)
true to wrap from the first to the last Location.
A Location object representing the new location.
Navigates to the previous visible Location.
options : Boolean/Object
An options object or a boolean flag meaning wrap
A Location object representing the new location.
By default, this will be a new instance. If the move option is passed as true
this instance will be mutated.
Navigates to the previous visible cell Location.
options : Boolean/Object
An options object or a boolean flag meaning wrap
wrap : Boolean (optional)
true to wrap from the first to the last Location.
A Location object representing the new location.
Returns a new Location object encapsulating the previous item in the DataView.
options : Boolean/Object (optional)
An options object or a boolean flag meaning wrap
wrap : Boolean (optional)
true to wrap from the first to the last Location.
A new Location object representing the new location.
Re-orientates this Location according to the existing settings. If for example a row has been deleted, or moved by a sort, or a column has been moved, this will resync internal values with reality.
Navigates to the previous visible Location.
options : Boolean/Object (optional)
An options object or a boolean flag meaning wrap
A new Location object representing the new location.
Navigates to the previous visible Location.
options : Boolean/Object
An options object or a boolean flag meaning wrap
A new Location object representing the new location.
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
ExtReact | Terms of Use