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 to write Ext.data.Model data to the server in a JSON format. The allowSingle configuration can be set to false to force the records to always be encoded in an array, even if there is only a single record being sent.
This object contains the options passed to Ext.data.Model#getData when
writing Ext.data.Model#phantom records or when writeAllFields is set
to true.
NOTE: The serialize option cannot be used here.
Sets the value of allDataOptions
allDataOptions : Object
Configure with false to ensure that records are always wrapped in an array, even if there is only
one record being sent. When there is more than one record, they will always be encoded into an array.
Defaults to:
true
When specified this property causes the Ext.data.Model#idProperty of
newly created records to be sent to the server as this name instead of the
value of the idProperty.
For example, by default, the following code:
Ext.define('Person', {
idProperty: 'id', // this is the default value (for clarity)
fields: [ 'name' ]
});
var person = new Person({
// no id provided, so one is generated
name: 'Clark Kent'
});
Will send this to the server:
{
id: 'Person-1',
name: 'Clark Kent'
}
This can be an issue if the server expects an integer for the "id" property.
You can use Ext.data.Model#identifier to produce identifiers that
the server would recognize or use this config to send the client's id in a
different property.
Ext.define('Person', {
idProperty: 'id', // this is the default value (for clarity)
proxy: {
writer: {
clientIdProperty: 'clientId'
}
},
fields: [ 'name' ]
});
Given the above, the server is sent this data now:
{
clientId: 'Person-1',
name: 'Clark Kent'
}
While this config provides the behavior of Ext.data.Model#clientIdProperty
from previous releases, this property is not as useful as a suitable
Ext.data.Model#identifier due to id's appearing in foreign-key fields
and in Ext.data.Model#manyToMany associations.
See Ext.data.Model#identifier for more on id generation.
Sets the value of clientIdProperty
clientIdProperty : String
This is used for each field of type date in the model to format the value before it is sent to the server.
Configure true to send record data (all record fields if writeAllFields is true)
as a JSON encoded HTTP parameter named by the rootProperty configuration.
The encode option should only be set to true when a rootProperty is defined, because the values will be sent as part of the request parameters as opposed to a raw post. The root will be the name of the parameter sent to the server.
Defaults to:
false
By default, when dot-delimited field mappings are
used (e.g. name: 'myProperty', mapping: 'my.nested.property') the writer will simply output a flat data
object containing the mapping string literal as the property name (e.g. { 'my.nested.property': 'foo' }).
Mappings are used to map incoming nested JSON to flat Ext models. In many case, the data output by the
writer should preferrably match the original nested data format. Setting this config to true will ensure
that the output will instead look like { my: { nested: { property: 'foo' }}}. The output is generated
by getExpandedData, which can optionally be overridden to apply more customized logic.
Defaults to:
false
This property is used to read the key for each value that will be sent to the server.
For example:
Ext.define('Person', {
extend: 'Ext.data.Model',
fields: [{
name: 'first',
mapping: 'firstName'
}, {
name: 'last',
mapping: 'lastName'
}, {
name: 'age'
}]
});
new Ext.data.writer.Writer({
nameProperty: 'mapping'
});
// This will be sent to the server
{
firstName: 'first name value',
lastName: 'last name value',
age: 1
}
If the value is not present, the field name will always be used.
Defaults to:
"name"
This object contains the options passed to Ext.data.Model#getData when
writing non Ext.data.Model#phantom records or when writeAllFields is
set to false.
NOTE: The serialize option cannot be used here.
Sets the value of partialDataOptions
partialDataOptions : Object
The HTTP parameter name by which JSON encoded records will be passed to the server if the
encode option is true.
If a transform function is set, it will be invoked just before writeRecords executes. It is passed the unserialized data object and the Ext.data.Request object. The transform function returns a data object, which can be a modified version of the original data object, or a completely new data object. The transform can be a function, or an object with a 'fn' key and an optional 'scope' key. Example usage:
Ext.create('Ext.data.Store', {
model: 'User',
proxy: {
type: 'ajax',
url : 'users.json',
writer: {
type: 'json',
transform: {
fn: function(data, request) {
// do some manipulation of the unserialized data object
return data;
},
scope: this
}
}
},
});
true to write all fields from the record to the
server. If set to false it will only send the fields that were modified. Note
that any fields that have Ext.data.field.Field#persist set to false
will still be ignored while those with Ext.data.field.Field#critical
set to true will be included.
The exact set of fields written is determined by allDataOptions (when true)
or partialDataOptions (when false). This option is ignored and treated as
true when writing Ext.data.Model#phantom records.
It is seldom a good idea to use this config. Rather use allDataOptions or
partialDataOptions to control what fields are sent for records based on their
Ext.data.Model#phantom state.
In the previous release, this was default true.
Sets the value of writeAllFields
writeAllFields : Boolean
By default, each record's id is always included in the output for non-phantom records since in most cases the id will be required on the server to process the record action. This is helpful since the id will normally not be modified, and so would not be sent to the server unless writeAllFields was explicitly enabled.
However, there are cases where it is not desirable for the record id to be passed in the data directly. For example, when using a RESTful API the record id would typically be appended to the url instead.
If this property is specified by the target class of this mixin its properties are
used to configure the created Ext.Factory.
Formats the data for each record before sending it to the server. This method should be overridden to format the data in a way that differs from the default.
record : Ext.data.Model
The record that we are writing to the server.
operation : Ext.data.operation.Operation (optional)
An operation object.
An object literal of name/value keys to be written to the server. By default this method returns the data property on the record.
Prepares a Proxy's Ext.data.Request object.
request : Ext.data.Request
The request object.
The modified request object.
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