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

Ext.data.schema.Schema alias: schema.default

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.data.schema.Schema

Summary

A Schema is a collection of related Ext.data.Model and their respective Ext.data.schema.Association.

Schema Instances

By default a single instance of this class is created which serves as the schema for all entities that do not have an explicit schema config either specified or inherited. This is sufficient in most cases.

When an entity does specify a schema, however, that looks up (or creates) an instance for that entity class which is then inherited.

Important: All related entities must belong to a single schema instance in order to properly link up their associations.

Configuring Schemas

The best way to control the configuration of your schema is to define a base class for all of your entities and use the schema config like this:

 Ext.define('MyApp.model.Base', {
     extend: 'Ext.data.Model',

     // This configures the default schema because we don't assign an "id":
     schema: {
         // configs go here
     }
 });

Note: Only one explicit configuration can be applied to the default schema. In most applications this will not be an issue.

By using a base class for your entities you can ensure that the default schema is fully configured before declaration of your classes proceeds. This is especially helpful if you need to set the namespace for your schema (see below).

Relative Naming

When describing associations between entities, it is desirable to use shorthand names that do not contain the common namespace portion. This is called the entityName as opposed to its class name. By default, the entityName is the full class name. However, if a namespace is used, the common portion can be discarded and we can derive a shorter name. In the following code, "MyApp.model.Foo" has an entityName of "Foo" and the schema has a namespace of "MyApp.model".

If you use deeper nesting for entities, you may need to set the namespace config to account for this. For example:

 Ext.define('MyApp.model.Base', {
     extend: 'Ext.data.Model',

     schema: {
         namespace: 'MyApp.model'
     }
 });

Your derived classes now will generate proper default entityName values even if they have further namespaces. For example, "MyApp.model.foo.Thing" will produce "foo.Thing" as the entityName given the above as a base class.

Association Naming

There are various terms involved when describing associations. Perhaps the simplest example that will clarify these terms is that of the common many-to-many association of User and Group.

  • entityName - The names "User" and "Group" are the entityName values associated with these two classes. These are derived from their full classnames (perhaps something like "App.model.User" and "App.model.Group").

  • associationName - When talking about associations, especially the many-to-many variety, it is important to give them names. Associations are not owned by either of the entities involved, so this name is similar to an entityName. In the case of "User" and "Group", the default associationName would be "GroupUsers".

  • left and right - Associations describe a relationship between two entities. To talk about specific associations we would use the entityName of the parties (such as "User" or "Group"). When discussing associations in the abstract, however, it is very helpful to be able to talk about the entities in an association in a general way. In the case of the "GroupUsers" association, "User" is said to be the left while "Group" is said to be the right. In a many-to-many association the selection of left and right is arbitrary. When a foreign-key is involved, the left entity is the one containing the foreign-key.

Custom Naming Conventions

One of the jobs the the Schema is to manage name generation (such as entityName). This job is delegated to a class called the namer. If you need to generate names in other ways, you can provide a custom namer for your classes:

 Ext.define('MyApp.model.Base', {
     extend: 'Ext.data.Model',

     schema: {
         namespace: 'MyApp.model',
         namer: 'custom'
     }
 });

This will create a class using the alias "namer.custom". For example:

 Ext.define('MyApp.model.CustomNamer', {
     extend: 'Ext.data.schema.Namer',

     alias: 'namer.custom',
     ...
 });

For details see the documentation for Ext.data.schema.Namer.

No members found using the current filters

configs

Optional Configs

defaultIdentifier : Object

This config is used to initialize the Ext.data.Model#identifier config for classes that do not define one.

getDefaultIdentifier : Object

Returns the value of defaultIdentifier

Returns

Object

setDefaultIdentifier (defaultIdentifier)

Sets the value of defaultIdentifier

Parameters

defaultIdentifier :  Object

namer : String / Object / Ext.data.schema.Namer

Specifies or configures the name generator for the schema.

Defaults to:

"default"

getNamer : String / Object / Ext.data.schema.Namer

Returns the value of namer

Returns

String / Object / Ext.data.schema.Namer

setNamer (namer)

Sets the value of namer

Parameters

namer :  String / Object / Ext.data.schema.Namer

namespace : String

The namespace for entity classes in this schema.

getNamespace : String

Returns the value of namespace

Returns

String

setNamespace (namespace)

Sets the value of namespace

Parameters

namespace :  String

proxy : Object / Ext.util.ObjectTemplate

This is a template used to produce Ext.data.proxy.Proxy configurations for Models that do not define an explicit proxy.

This template is processed with the Model class as the data object which means any static properties of the Model are available. The most useful of these are

  • prefix - The urlPrefix property of this instance.
  • entityName - The name of the Model (for example, "User").
  • schema - This instance.

setProxy (proxy)

Sets the value of proxy

Parameters

proxy :  Object / Ext.util.ObjectTemplate

urlPrefix : String

This is the URL prefix used for all requests to the server. It could be something like "/~api". This value is included in the proxy template data as "prefix".

Defaults to:

""

getUrlPrefix : String

Returns the value of urlPrefix

Returns

String

setUrlPrefix (urlPrefix)

Sets the value of urlPrefix

Parameters

urlPrefix :  String

properties

Instance Properties

factoryConfig : Object

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

methods

Instance Methods

getAssociation ( name ) : Ext.data.schema.Association

Returns an Association by name.

Parameters

name :  String

The name of the association.

Returns

:Ext.data.schema.Association

The association instance.

getEntity ( name ) : Ext.data.Model

Returns an entity by name.

Parameters

name :  String

The name of the entity

Returns

:Ext.data.Model

The entity class.

getEntityName ( cls ) : String

Get the entity name taking into account the namespace.

Parameters

cls :  String/Ext.data.Model

The model class or name of the class.

Returns

:String

The entity name

hasAssociations ( name ) : Boolean

Checks if the passed entity has attached associations that need to be read when using nested loading.

Parameters

name :  String/Ext.Class/Ext.data.Model

The name, instance, or Model class.

Returns

:Boolean

true if there are associations attached to the entity.

hasEntity ( entity ) : Boolean

Checks if an entity is defined

Parameters

entity :  String/Ext.data.Model

The name or model

Returns

:Boolean

True if this entity is defined

Static Methods

get ( config ) : Ext.data.schema.Schema
static sta

Returns the Schema instance given its id or config object. If only the id is specified, that Schema instance is looked up and returned. If there is no instance already created, the id is assumed to be the type. For example:

 schema: 'foo'

Would be created from the alias "schema.foo" and assigned the id of "foo" as well.

Parameters

config :  String/Object

The id, type or config object of the schema.

type :  String (optional)

The type alias of the schema. A "schema." prefix is added to this string, if provided, to complete the alias. This should match match the "alias" of some class derived from Ext.data.schema.Schema.

Returns

:Ext.data.schema.Schema

The previously existing or newly created instance.

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