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.
This class is used as a set of methods that are applied to the prototype of a Ext.data.Model to decorate it with a Node API. This means that models used in conjunction with a tree will have all of the tree related methods available on the model. In general, this class will not be used directly by the developer.
This class also creates extra fields on the model, if they do not exist, to help maintain the tree state and UI. These fields are documented as config options.
The data fields used to render a tree node are: text, leaf, children, and expanded. Once a node is loaded to the tree store you can use get() to fetch the value of a given field name (provided there is not a convenience accessor on the Node for that field).
The following configs have methods used to set the value / state of the node at runtime:
The remaining configs may be set using set().
node.set('text', 'Changed Text'); // example showing how to change the node label
The qtip, qtitle, and qshowDelay use QuickTips and requires initializing Ext.tip.QuickTipManager unless the application is created using application.
Ext.tip.QuickTipManager.init();
For additional information and examples see the description for Ext.tree.Panel.
Set to false to deny dragging of this node.
Applicable when using the TreeViewDragDrop plugin.
Defaults to:
true
Set to false to deny dropping on this node.
Applicable when using the TreeViewDragDrop plugin.
Defaults to:
true
Set to true or false to show a checkbox alongside this node.
To fetch an array of checked nodes use getChecked().
Defaults to:
null
Array of child nodes.
Note: By default the child nodes root is children, but can be set using the
reader rootProperty config on the
Ext.data.TreeStore proxy.
The number of parents this node has. A root node has depth 0, a child of it depth 1, and so on...
See getDepth.
False to prevent expanding/collapsing of this node.
See also: isExpandable.
Defaults to:
true
True if the node is expanded.
When the tree is asynchronously remote loaded, expanding a collapsed node loads the children of that node (if the node has not already been loaded previously).
See also: isExpanded.
Defaults to:
false
A numeric unicode character code to use as the icon. The default font-family
for glyphs can be set globally using
glyphFontFamily application
config or the Ext.setGlyphFontFamily() method.
It is initially set to 'Pictos'.
The following shows how to set the glyph using the font icons provided in the SDK (assuming the font-family has been configured globally):
// assumes the glyphFontFamily is "Pictos"
glyph: 'x48' // the "home" icon (H character)
// assumes the glyphFontFamily is "Pictos"
glyph: 72 // The "home" icon (H character)
// assumes the glyphFontFamily is "Pictos"
glyph: 'H' // the "home" icon
Alternatively, this config option accepts a string with the charCode and
font-family separated by the @ symbol.
// using Font Awesome
glyph: 'xf015@FontAwesome' // the "home" icon
// using Pictos
glyph: 'H@Pictos' // the "home" icon
Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:
Available since: 6.2.0
Path to an image to use as an icon.
For instructions on how you can use icon fonts including those distributed in the SDK see iconCls.
One or more space separated CSS classes to be applied to the icon element. The CSS rule(s) applied should specify a background image to be used as the icon.
An example of specifying a custom icon class would be something like:
// specify the property in the config for the class:
iconCls: 'my-home-icon'
// css rule specifying the background image to be used as the icon image:
.my-home-icon {
background-image: url(../images/my-home-icon.gif) !important;
}
In addition to specifying your own classes, you can use the font icons provided in the SDK using the following syntax:
// using Font Awesome
iconCls: 'x-fa fa-home'
// using Pictos
iconCls: 'pictos pictos-home'
Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:
The position of the node inside its parent. When parent has 4 children and the node is third amongst them, index will be 2.
Set to true to indicate that this child can have no children. The expand icon/arrow will then not be rendered for this node.
See also: isLeaf.
Defaults to:
false
The text to show on node label (html tags are accepted).
The default text for the root node is ROOT. All other nodes default to ''.
Note: By default the node label is text, but can be set using the tree's
displayField config.
An array of this nodes children. Array will be empty if this node has no children.
A reference to this node's first child node. null if this node has no children.
true in this class to identify an object as an instantiated Node, or subclass thereof.
Defaults to:
true
A reference to this node's last child node. null if this node has no children.
A reference to this node's next sibling node. null if this node does not have a next sibling.
A reference to this node's parent node. null if this node is the root node.
A reference to this node's previous sibling node. null if this node does not have a previous sibling.
Inserts node(s) as the last child node of this node.
If the node was previously a child node of another parent node, it will be removed from that node first.
node : Ext.data.NodeInterface/Ext.data.NodeInterface[]/Object
The node or Array of nodes to append
suppressEvents : Boolean (optional)
True to suppress firing of events.
Defaults to: false
commit : Boolean (optional)
Defaults to: false
The appended node if single append, or null if an array was passed
Bubbles up the tree from this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the bubble is stopped.
fn : Function
The function to call
scope : Object (optional)
The scope (this reference) in which the function is executed. Defaults to the current Node.
args : Array (optional)
The args to call the function with. Defaults to passing the current Node.
Cascades down the tree from this node, calling the specified functions with each node. The arguments to the function
will be the args provided or the current node. If the before function returns false at any point,
the cascade is stopped on that branch.
Note that the 3 argument form passing fn, scope, args is still supported. The fn function is as before, called
before cascading down into child nodes. If it returns false, the child nodes are not traversed.
spec : Object/Function
An object containing before and after
functions, scope and an argument list or simply the before function.
before : Function (optional)
A function to call on a node before
cascading down into child nodes. If it returns false, the child nodes
are not traversed.
after : Function (optional)
A function to call on a node after cascading down into child nodes.
scope : Object (optional)
The scope (this reference) in which the functions are executed. Defaults to the current Node.
args : Array (optional)
The args to call the function with. Defaults to passing the current Node.
scope : Object (optional)
If spec is the before function instead of
an object, this argument is the this pointer.
args : Array (optional)
If spec is the before function instead of
an object, this argument is the args to pass.
after : Function (optional)
If spec is the before function instead of
an object, this argument is the after function to call.
Clears the node.
erase : Boolean (optional)
True to erase the node using the configured proxy.
Defaults to: false
resetChildren : Boolean (optional)
True to reset child nodes
Defaults to: false
Collapse this node.
recursive : Boolean (optional)
True to recursively collapse all the children
Defaults to: false
callback : Function (optional)
The function to execute once the collapse completes
scope : Object (optional)
The scope to run the callback in
Collapse all the children of this node.
recursive : Function (optional)
True to recursively collapse all the children
Defaults to: false
callback : Function (optional)
The function to execute once all the children are collapsed
scope : Object (optional)
The scope to run the callback in
Returns true if this node is an ancestor (at any point) of the passed node.
node : Ext.data.NodeInterface
Creates a copy (clone) of this Node.
newId : String (optional)
A new id, defaults to this Node's id.
session : Ext.data.session.Session (optional)
The session to which the new record belongs.
deep : Boolean (optional)
True to recursively copy all child nodes into the new Node. False to copy without child Nodes.
Defaults to: false
A copy of this Node.
Ensures that the passed object is an instance of a Record with the NodeInterface applied
node : Object
Iterates the child nodes of this node, calling the specified function with each node. The arguments to the function will be the args provided or the current node. If the function returns false at any point, the iteration stops.
fn : Function
The function to call
scope : Object (optional)
The scope (this reference) in which the function is executed. Defaults to the Node on which eachChild is called.
args : Array (optional)
The args to call the function with. Defaults to passing the current Node.
Expand this node.
recursive : Boolean (optional)
True to recursively expand all the children
Defaults to: false
callback : Function (optional)
The function to execute once the expand completes
scope : Object (optional)
The scope to run the callback in
Expand all the children of this node.
recursive : Boolean (optional)
True to recursively expand all the children
Defaults to: false
callback : Function (optional)
The function to execute once all the children are expanded
scope : Object (optional)
The this pointer for the callback.
Finds the first child that has the attribute with the specified value.
attribute : String
The attribute name
value : Object
The value to search for
deep : Boolean (optional)
True to search through nodes deeper than the immediate children
Defaults to: false
The found child or null if none was found
Finds the first child by a custom function. The child matches if the function passed returns true.
fn : Function
A function which must return true if the passed Node is the required Node.
scope : Object (optional)
The scope (this reference) in which the function is executed. Defaults to the Node being tested.
deep : Boolean (optional)
True to search through nodes deeper than the immediate children
Defaults to: false
The found child or null if none was found
Fires the specified event with the passed parameters (minus the event name, plus the options object passed
to addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object...
Variable number of parameters are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Returns the child node at the specified index.
index : Number
Returns the tree this node is in.
The tree panel which owns this node.
Gets the hierarchical path from the root of the current node.
field : String (optional)
The field to construct the path from. Defaults to the model idProperty.
separator : String (optional)
A separator to use.
Defaults to: '/'
The node path
Returns the Ext.data.TreeStore which owns this node.
The TreeStore which owns this node.
Returns true if this node has one or more child nodes, else false.
Returns the index of a child node
child : Ext.data.NodeInterface
The index of the child node or -1 if it was not found.
Returns the index of a child node that matches the id
id : String
The id of the node to find
The index of the node or -1 if it was not found
Inserts the first node before the second node in this nodes childNodes collection.
node : Ext.data.NodeInterface/Ext.data.NodeInterface[]/Object
The node to insert
refNode : Ext.data.NodeInterface
The node to insert before (if null the node is appended)
The inserted node
Inserts a node into this node.
index : Number
The zero-based index to insert the node at
node : Ext.data.NodeInterface/Object
The node to insert
The node you just inserted
Returns true if the passed node is an ancestor (at any point) of this node.
node : Ext.data.NodeInterface
Returns true if this node is a branch node, and the entire branch is fully loaded.
Using this method, it is possible to ascertain whether an
expandAll() call (classic toolkit TreePanel method) will have
access to all descendant nodes without incurring a store load.
Returns true if this node has one or more child nodes, or if the expandable node attribute is explicitly specified as true, otherwise returns false.
Used by Ext.tree.Column#initTemplateRendererData to determine whether a node is the last visible sibling.
Returns true if this node is visible. Note that visibility refers to the structure of the tree, the Ext.tree.Panel#rootVisible configuration is not taken into account here. If this method is called on the root node, it will always be visible.
Called as a callback from the Ext.data.TreeStore#onBeforeNodeExpand when the child nodes needed by method-expand have been loaded and appended.
records : Object
recursive : Object
callback : Object
scope : Object
Implement this method in a tree record subclass if it needs to track whenever it is registered with a Ext.data.TreeStore.
treeStore : Ext.data.TreeStore
The TreeStore to which the node is being registered.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Implement this method in a tree record subclass if it needs to track whenever it is unregistered from a Ext.data.TreeStore.
treeStore : Ext.data.TreeStore
The TreeStore from which the node is being unregistered.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Removes this node from its parent.
If the node is not phantom (only added in the client side), then it may be marked for removal.
If the owning Ext.data.TreeStore is set to track removed then the node will be added to the stack of nodes due to be removed the next time the store is synced with the server.
If the owning Ext.data.TreeStore is set to auto synchronize then the synchronize request will be initiated immediately.
erase : Boolean (optional)
True to erase the node using the configured proxy. This is only needed when the owning Ext.data.TreeStore is not taking care of synchronization operations.
Defaults to: false
this
Removes all child nodes from this node.
erase : Boolean (optional)
True to erase the node using the configured proxy.
Defaults to: false
this
Removes a child node from this node.
node : Ext.data.NodeInterface
The node to remove
erase : Boolean (optional)
True to erase the record using the configured proxy.
Defaults to: false
The removed node
Replaces one child node in this node with another.
newChild : Ext.data.NodeInterface
The replacement node
oldChild : Ext.data.NodeInterface
The node to replace
The replaced node
Creates an object representation of this node including its children.
writerParam : Object
Sets the node into the collapsed state without affecting the UI.
This is called when a node is collapsed with the recursive flag. All the descendant nodes will have been removed from the store, but descendant non-leaf nodes still need to be set to the collapsed state without affecting the UI.
recursive : Object
Sorts this nodes children using the supplied sort function.
sortFn : Function (optional)
A function which, when passed two Nodes, returns -1, 0 or 1 depending upon required sort order.
It omitted, the node is sorted according to the existing sorters in the owning Ext.data.TreeStore.
recursive : Boolean (optional)
True to apply this sort recursively
Defaults to: false
suppressEvent : Boolean (optional)
True to not fire a sort event.
Defaults to: false
Updates general data of this node like isFirst, isLast, depth. This method is internally called after a node is moved. This shouldn't have to be called by the developer unless they are creating custom Tree plugins.
commit : Boolean
info : Object
The info to update. May contain any of the following
The names of any persistent fields that were modified.
This method decorates a Model class such that it implements the interface of a tree node. That is, it adds a set of methods, events, properties and fields on every record.
modelClass : Ext.Class/Ext.data.Model
The Model class or an instance of the Model class you want to decorate. In either case, this method decorates the class so all instances of that type will have the new capabilities.
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 when a new child node is appended
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The newly appended node
index : Number
The index of the newly appended node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a new child is appended, return false to cancel the append.
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The child node to be appended
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before this node is collapsed.
this : Ext.data.NodeInterface
The collapsing node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before this node is expanded.
this : Ext.data.NodeInterface
The expanding node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a new child is inserted, return false to cancel the insert.
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The child node to be inserted
refNode : Ext.data.NodeInterface
The child node the node is being inserted before
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before this node is moved to a new location in the tree. Return false to cancel the move.
this : Ext.data.NodeInterface
This node
oldParent : Ext.data.NodeInterface
The parent of this node
newParent : Ext.data.NodeInterface
The new parent this node is moving to
index : Number
The index it is being moved to
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires before a child is removed, return false to cancel the remove.
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The child node to be removed
isMove : Boolean
true if the child node is being removed so it can be moved to another position in the tree.
(a side effect of calling appendChild or
insertBefore with a node that already has a parentNode)
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this node is collapsed.
this : Ext.data.NodeInterface
The collapsing node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this node is expanded.
this : Ext.data.NodeInterface
The expanding node
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a new child node is inserted.
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The child node inserted
refNode : Ext.data.NodeInterface
The child node the node was inserted before
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this node is moved to a new location in the tree
this : Ext.data.NodeInterface
This node
oldParent : Ext.data.NodeInterface
The old parent of this node
newParent : Ext.data.NodeInterface
The new parent of this node
index : Number
The index it was moved to
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when a child node is removed
this : Ext.data.NodeInterface
This node
node : Ext.data.NodeInterface
The removed node
isMove : Boolean
true if the child node is being removed so it can be moved to another position in the tree.
context : Object
An object providing information about where the removed node came from. It contains the following properties:
parentNode : Ext.data.NodeInterface
The node from which the removed node was removed.
previousSibling : Ext.data.NodeInterface
The removed node's former previous sibling.
nextSibling : Ext.data.NodeInterface
The removed node's former next sibling. (a side effect of calling appendChild or insertBefore with a node that already has a parentNode)
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when this node's childNodes are sorted.
this : Ext.data.NodeInterface
This node.
childNodes : Ext.data.NodeInterface[]
The childNodes of this node.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
ExtReact | Terms of Use