ExtReact Docs Help

Introduction

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.

Terms, Icons, and Labels

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.

Access Levels

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.

Member Types

Member Syntax

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).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

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.

Class Icons

- 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

Member Icons

- 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

Class Member Quick-Nav Menu

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.

Getter and Setter Methods

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

History Bar

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.

Search and Filters

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.

API Doc Class Metadata

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:

Expanding and Collapsing Examples and Class Members

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.

Desktop -vs- Mobile View

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:

Viewing the Class Source

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.

ExtReact 6.7.0


top

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.data.schema.Association

Summary

This class is never created directly. It should be constructed through associations in Ext.data.Model.

Associations enable you to express relationships between different Ext.data.Model. Consider an ecommerce system where Users can place Orders - there is a one to many relationship between these Models, one user can have many orders (including 0 orders). Here is what a sample implementation of this association could look like. This example will be referred to in the following sections.

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: [{
        name: 'id',
        type: 'int'
    }, 'name']
});

Ext.define('Order', {
    extend: 'Ext.data.Model',
    fields: [{
        name: 'id',
        type: 'int'
    }, {
        name: 'userId',
        type: 'int',
        reference: 'User'
    }]
});

Association Types

Assocations can describe relationships in 3 ways:

Many To One

A single entity (A) has a relationship with many (B) entities. An example of this is an ecommerce system User can have many Order entities.

This can be defined using Ext.data.schema.ManyToOne for keyed associations, or Ext.data.schema.HasMany for keyless associations.

One To One

A less common form of Many To One, a single entity (A) has a relationship with at most 1 entity (B). This is often used when partitioning data. For example a User may have a single UserInfo object that stores extra metadata about the user.

This can be defined using Ext.data.schema.OneToOne for keyed associations, or Ext.data.schema.HasOne for keyless associations.

Many To Many

An entity (A) may have a have a relationship with many (B) entities. That (B) entity may also have a relationship with many A entities. For example a single Student can have many Subject entities and a single Subject can have many Student entities.

This can be defined using Ext.data.schema.ManyToMany. Many To Many relationships are readonly unless used with a Ext.data.Session.

Keyed vs Keyless Associations

Associations can be declared in 2 ways, which are outlined below.

Keyed associations

A keyed association relies on a field in the model matching the id of another model. Membership is driven by the key. This is the type of relationship that is typically used in a relational database. This is declared using the ||reference|| configuration on a model field. An example of this can be seen above for User/Order.

Keyless associations

A keyless association relies on data hierarchy to determine membership. Items are members because they are contained by another entity. This type of relationship is common with NoSQL databases. formats. A simple example definition using User/Order:

Ext.define('User', {
    extend: 'Ext.data.Model',
    fields: [{
        name: 'id',
        type: 'int'
    }, 'name'],
    hasMany: 'Order'
});

Ext.define('Order', {
    extend: 'Ext.data.Model',
    fields: [{
        name: 'id',
        type: 'int'
    }]
});

Advantages of Associations

Assocations make it easier to work with Models that share a connection. Some of the main functionality includes:

Generated Accessors/Setters

Associated models will automatically generate named methods that allow for accessing the associated data. The names for these are created using a Ext.data.schema.Schema, to provide a consistent and predictable naming structure.

Using the example code above, there will be 3 generated methods:

  • User will have an orders() function that returns a Ext.data.Store ofOrders.
  • Order will have a getUser method which will return a User Model.
  • Order will have a setUser method that will accept a User model or a key value.

Nested Loading

Nested loading is the ability to load hierarchical associated data from a remote source within a single request. In the following example, each User in the users store has an orders store. Each orders store is populated with Order models read from the request. Each Order model also has a reference back to the appropriate User.

// Sample JSON data returned by /Users
[{
    "id": 1,
    "name": "User Foo",
    "orders": [{
        "id": 101,
        "userId": 1
    }, {
        "id": 102,
        "userId": 1
    }, {
        "id": 103,
        "userId": 1
    }]
}, {
    "id": 2,
    "name": "User Bar",
    "orders": [{
        "id": 201,
        "userId": 2
    }, {
        "id": 202,
        "userId": 2
    }]
}]

// Application code
var users = new Ext.data.Store({
    model: 'User',
    proxy: {
        type: 'ajax',
        url: '/Users'
    }
});
users.load(function() {
    var user1 = users.first(),
        user2 = users.last(),
        orders1 = user1.orders(),
        orders2 = user2.orders();

    // 3 orders, same reference back to user1
    console.log(orders1.getCount(), orders1.first().getUser() === user1);
    // 2 orders, same reference back to user2
    console.log(orders2.getCount(), orders2.first().getUser() === user2);
});

Binding

Data binding using ViewModels have functionality to be able to recognize associated data as part of a bind statement. For example:

  • {user.orders} binds to the orders store for a user.
  • {order.user.name} binds to the name of the user taken from the order.

Association Concepts

Roles

The role is used to determine generated names for an association. By default, the role is generated from either the field name (in a keyed association) or the model name. This naming follows a pattern defined by the Ext.data.schema.Namer. To change a specific instance, an explicit role can be specified:

Ext.define('Thread', {
    extend: 'Ext.data.Model',
    fields: ['id', 'title']
});

Ext.define('Post', {
    extend: 'Ext.data.Model',
    fields: ['id', 'content', {
        name: 'threadId',
        reference: {
            type: 'Thread',
            role: 'discussion',
            inverse: 'comments'

        }
    }]
});

In the above example, the Thread will be decorated with a comments method that returns the store. The Post will be decorated with getDiscussion/setDiscussion methods.

Generated Methods

Associations generate methods to allow reading and manipulation on associated data.

On records that have a "to many" relationship, a single methods that returns a Ext.data.Store is created. See storeGetter. On records that have a "to one" relationship, 2 methods are generated, a getter and a setter.

Reflexive

Associations are reflexive. By declaring one "side" of the relationship, the other is automatically setup. In the example below, there is no code in the Thread entity regarding the association, however by virtue of the declaration in post, Thread is decorated with the appropriate infrastructure to participate in the association.

Ext.define('Thread', {
    extend: 'Ext.data.Model',
    fields: ['id', 'title']
});

Ext.define('Post', {
    extend: 'Ext.data.Model',
    fields: ['id', 'content', {
        name: 'threadId',
        reference: 'Thread'
    }]
});

Naming

Referring to model names in associations depends on their Ext.data.Model#entityName. See the "Relative Naming" section in the Ext.data.schema.Schema documentation.

No members found using the current filters

configs

Optional Configs

associationKey : String

The name of the property in the data to read the association from. Defaults to the name of the associated model.

name : String

The name of this association.

properties

methods

Instance Methods

recordGetter ( [options], [scope] ) : Ext.data.Model

This is not a real method, it is placeholder documentation for a generated method on a Ext.data.Model.

Gets a model of the "one" type.

Parameters

options :  Object/Function (optional)

The options for the getter, or a callback function to execute. If specified as a function, it will act as the callback option.

reload :  Boolean (optional)

true to force the record to reload from the server.

scope :  Object (optional)

The this reference for the callback. Defaults to the record.

success :  Function (optional)

A function to execute when the record loads successfully. If the record has already loaded, this will be called immediately and the Operation will be null. The success is passed the following parameters:

record :  Ext.data.Model (optional)

The record.

operation :  Ext.data.operation.Operation (optional)

The operation. null if no load occurred.

failure :  Function (optional)

A function to execute when the record load fails. If the record has already loaded, this will not be called. The failure is passed the following parameters:

record :  Ext.data.Model (optional)

The record.

operation :  Ext.data.operation.Operation (optional)

The operation

callback :  Function (optional)

A function to execute when the record loads, whether it is successful or failed. If the record has already loaded, this will be called immediately and the Operation will be null. The callback is passed the following parameters:

record :  Ext.data.Model (optional)

The record.

operation :  Ext.data.operation.Operation (optional)

The operation. null if no load occurred.

success :  Boolean (optional)

true if the load was successful. If already loaded this will always be true.

scope :  Object (optional)

The this reference for the callback. Defaults to the record.

Returns

:Ext.data.Model

The record. null if the reference has been previously specified as empty.

recordSetter ( value, [options] )

This is not a real method, it is placeholder documentation for a generated method on a Ext.data.Model.

Sets a model of the "one" type.

Parameters

value :  Ext.data.Model/Object

The value to set. This can be a model instance, a key value (if a keyed association) or null to clear the value.

options :  Object/Function (optional)

Options to handle callback. If specified as a function, it will act as the callback option. If specified as an object, the params are the same as Ext.data.Model#save. If options is specified, Ext.data.Model#save will be called on this record.

storeGetter ( [options], [scope] ) : Ext.data.Store

This is not a real method, it is placeholder documentation for a generated method on a Ext.data.Model.

Gets a store configured with the model of the "many" record.

Parameters

options :  Object/Function (optional)

The options for the getter, or a callback function to execute. If specified as a function, it will act as the callback option.

reload :  Boolean (optional)

true to force the store to reload from the server.

scope :  Object (optional)

The this reference for the callback. Defaults to the record.

success :  Function (optional)

A function to execute when the store loads successfully. If the store has already loaded, this will be called immediately and the Operation will be null. The success is passed the following parameters:

store :  Ext.data.Store (optional)

The store.

operation :  Ext.data.operation.Operation (optional)

The operation. null if no load occurred.

failure :  Function (optional)

A function to execute when the store load fails. If the store has already loaded, this will not be called. The failure is passed the following parameters:

store :  Ext.data.Store (optional)

The store.

operation :  Ext.data.operation.Operation (optional)

The operation

callback :  Function (optional)

A function to execute when the store loads, whether it is successful or failed. If the store has already loaded, this will be called immediately and the Operation will be null. The callback is passed the following parameters:

store :  Ext.data.Store (optional)

The store.

operation :  Ext.data.operation.Operation (optional)

The operation. null if no load occurred.

success :  Boolean (optional)

true if the load was successful. If already loaded this will always be true.

scope :  Object (optional)

The this reference for the callback. Defaults to the record.

Returns

:Ext.data.Store

The store.

Static Methods

override ( members ) : Ext.Base
static sta

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).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

ExtReact 6.7.0