Docs Help

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.

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

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

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.

Ext JS 6.7.0-CE - Modern Toolkit


top

Hierarchy

Ext.data.schema.Reference

Summary

This is not a real JavaScript class and cannot be created. This is for documentation purposes only.

This documentation is for:

The name of the entity referenced by this field. In most databases, this relationship is represented by a "foreign key". That is, a value for such a field matches the value of the id for an entity of this type.

 Ext.define('MyApp.models.Organization', {
     extend: 'Ext.data.Model',
     ...
 });

 Ext.define('MyApp.models.User', {
     extend: 'Ext.data.Model',

     fields: [
         { name: 'organizationId', reference: 'Organization' }
     ],
     ...
 });

If the name of the generated Ext.data.schema.Association or other aspects need to be specified, the reference can be an object. The following usage shows what would be generated by default given the above examples using the string form.

 Ext.define('MyApp.models.User', {
     extend: 'Ext.data.Model',

     fields: [{
         name: 'organizationId',
         reference: {
             type: 'Organization',
             association: 'UsersByOrganization',
             role: 'organization',
             inverse: 'users'
         }
     }],
     ...
 });

Finally, a reference can also describe ownership between the entities. By default, no ownership relationship is assumed. If, however, the User entities are owned by their Organization, we could say this:

 Ext.define('MyApp.models.User', {
     extend: 'Ext.data.Model',

     fields: [{
         name: 'organizationId',
         reference: {
             parent: 'Organization' // Organization is the parent of User
         }
     }],
     ...
 });
No members found using the current filters

configs

Optional Configs

association : String

The name of the association. By default, the name of the association is the capitalized inverse plus "By" plus the capitalized role.

child : String

Set this property instead of reference.type to indicate that the referenced entity is an owned child of this entity. That is, the reference entity should be deleted when this entity is deleted.

getterName : String

The name of the getter function. Typically this is generated based on the role.

inverse : String / Object

The name of the inverse role (of this entity with respect to the reference entity). By default, this is the pluralized name of this entity, unless this reference is unique, in which case the default name is the singularized name of this entity.

This config may also be an object containing a role, getter, or setter.

parent : String

Set this property instead of reference.type to indicate that the referenced entity is the owning parent of this entity. That is, this entity should be deleted when the reference entity is deleted.

reader : Object

A custom Ext.data.reader.Reader configuration for reading nested data.

role : String

The name of the role played by the referenced entity. By default, this is the field name (minus its "Id" suffix if present).

setterName : String

The name of the setter function (if required). Typically this is generated based on the role.

type : String

The type which this field references. This is the value set by the string form of reference. If the referenced entity has an ownership relationship this field should be omitted and reference.parent or reference.child should be specified instead.

unique : Boolean

true True for this reference to create a Ext.data.schema.OneToOne relationship. If not specified, the default is Ext.data.schema.ManyToOne.

properties

methods

Ext JS 6.7.0-CE - Modern Toolkit