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.

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.

Member Types

Config - The configuration options for a class.

Property - Set once a class is instantiated. *See Read Only below.

Method - Actions that can be performed by a class. Methods should be read as
instance methods and can only be called from a instance of a given class. Static methods
that can be called directly from the class itself will have a static label next to the
method name. *See Static below.

Event - Events are specific to the framework event system allowing for classes to
programmatically raise an event to be handled by one or more event handler methods. DOM
events, while handled by the framework event system, are not specifically described
within the API documentation. *For DOM events refer to the
event reference page from MDN.

Theme Variable - Variables used by the visual theme engine employed by the
framework.

Theme Mixin - Functions used by the visual theme engine employed by the framework
and may use values set in various Theme Variables.

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

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:

Expand/Collapse - On the left-hand size of the member row is a control used to
expand and collapse each member row to show / hide member details.

Member Name - The name of the class member (lookupComponent in this example)

Method Param - Any required or optional params used by a method (or passed to an
event handler method) will be listed next to the method name within parenthesis
(( item ) in this example)

Return type - The class instance or javascript object returned by the method or
property (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).

Flags - Any flags applicable to the member will be displayed next (PROTECTED in
this example - see the Flags section below)

Member Origin - On the right-hand side of the member row is the class where the
member was initially described (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.

Member Source - On the right-hand side below the member origin class is a link to
view the member's source (view source in the example)

Params List - Each param for a class method will be listed using the same name
found above in parenthesis, the type of class or object expected, and a description of
the param (item : Object in the example).

Returns - If a class returns a value other than undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)

Since (not shown in the example) - Some members will show which version of the
product the member was first introduced (i.e. Available since 3.4.0 - not pictured in
the example) just after the member description

Default (not shown in the example) - Configs often show the default config value
to be applied to a class instance if not overridden (i.e. Defaults to: false)

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.

Required - Required config when instantiating a class

Bindable - The config has a setter which allows this config to be set via ViewModel
binding

Read Only - The property may be read, but cannot be used to configure /
re-configure a class instance at runtime

Singleton - Singleton classes are instantiated immediately once defined and may not
be instantiated manually

Static - A static method or property is a method or property belonging to the class
itself, not an instance of the class

Deprecated - A class or member that is scheduled for removal in a future
framework version and is provided in the current version for backwards compatibility.Deprecated classes and members will have a message directing you to the preferred class /
method going forward.

Removed - A removed class or member that exists in documentation only as a
reference for users upgrading between framework versions

Template - A method defined within a base class designed to be overridden by
subclasses

Abstract - A class or member may be be defined as abstract. Abstract classes and
members establish a class structure and provide limited, if any, code. Class-specific
code will be furnished via overrides in subclasses.

Preventable - Events marked preventable will not fire if false is returned from
an event handler

Class Icons

- Indicates a framework class

- A singleton framework class. *See the
singleton flag for more information

- 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

Navigation and Features

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:

Alternate Name - One or more additional class name synonymns (in Ext JS 6.0.0 the
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.

Hierarchy - The hierararchy view lists the inheritance chain of the current class
up through its ancestor classes up to the root base class.

Mixins - A list of classes that are mixed into the current class

Inherited Mixins - A list of classes that are mixed into an ancestor of the current
class

Requires - All classes required to be defined for the class to be instantiated

Uses - A list of classes potentially used by the class at some point in its
lifecycle, but not necessarily requried for the class to initially be instantiated

Subclasses - Classes that extend the current class

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:

Global navigation will be located in a menu on the left-hand side accessible via the
hamburger menu icon. The menu houses the following (on most pages):

The name of the current product (as a link to the product landing page)

The Sencha icon used to navigate back to the documentation home page

The product menu drop-down button

Tabs of navigation trees for the API docs and guides

Current context navigation and tools is located on the right-hand side accessible via
the gear icon. The context menu houses teh following:

The global search input field

(API doc) A "Filters" tab with the member filter, expand / collapse all examples
button, expand / collapse all member rows button, the access level filter checkboxes,
and the counts of each member

(API doc) A "Related Classes" tab containing the menu of metadata related to the
current class

(Guides) The table of contents for the guide

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.

This property is most useful when creating multiple entities in a single call to
the server in a Ext.data.operation.Create. Alternatively,
the server could respond with records that correspond one-to-one to those sent in
the operation.

IMPORTANT: When upgrading from previous versions be aware that this property
used to perform the role of Ext.data.writer.Writer#clientIdProperty as
well as that described above. To continue send a client-generated id as other than
the idProperty, set clientIdProperty on the writer. A better solution, however,
is most likely a properly configured identifier as that would work better with
associations.

Set to false to prevent any converters from being called on fields specified in
a set operation.

Note: Setting the config to false will only prevent the convert / calculate
call when the set fieldName param matches the field's name. In the
following example the calls to set salary will not execute the convert method
on set while the calls to set vested will execute the convert method on the
initial read as well as on set.

The id generator to use for this model. The identifier generates values for the
idProperty when no value is given. Records with client-side generated
values for idProperty are called phantom records since they are
not yet known to the server.

This can be overridden at the model level to provide a custom generator for a model.
The simplest form of this would be:

If specified, this is the name of the property that contains the entity "version".
The version property is used to manage a long-running transaction and allows the
detection of simultaneous modification.

The way a version property is used is that the client receives the version as it
would any other entity property. When saving an entity, this property is always
included in the request and the server uses the value in a "conditional update".
If the current version of the entity on the server matches the version property
sent by the client, the update is allowed. Otherwise, the update fails.

On successful update, both the client and server increment the version. This is
done on the server in the conditional update and on the client when it receives a
success on its update request.

Defaults to:

null

properties

privatepri

privatepri

The value true causes config values to be stored on instances using a
property name prefixed with an underscore ("_") character. A value of false
stores config values as properties using their exact name (no prefix).

privatepri

The value true instructs the initConfig method to only honor values for
properties declared in the config block of a class. When false, properties
that are not declared in a config block will be placed on the instance.

privatepri

Setting this property to true will result in setting the object's
prototype to null after the destruction sequence is fully completed.
After that, most attempts at calling methods on the object instance
will result in "method not defined" exception. This can be very helpful
with tracking down otherwise hard to find bugs like runaway Ajax requests,
timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support Object.setPrototypeOf
method, and is only available in debugging mode.

readonlyroprotectedpro

This value is initially "R" or "C" indicating the initial CRUD state. As the
record changes and the various joined parties (stores, sessions, etc.) are notified
this value is updated prior to these calls. In other words, the joined parties
are notified after the crudState is updated. This means that the crudState
property may be briefly out of sync with underlying changes if this state is used
outside of these notifications.

readonlyroprotectedpro

This value is initially null indicating there is no previous CRUD state. As the
record changes and the various joined parties (stores, sessions, etc.) are notified
this value is updated for the subsequent calls. In other words, the joined parties
are notified and then crudStateWas is modified for the next update.

readonlyro

protectedpro

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics,
this.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#statics
for a detailed comparison

privatepri

Helper function used by afterEdit, afterReject and afterCommit. Calls the given
method on the Ext.data.Store that this instance has joined, if any.
The store function will always be called with the model instance as its single
argument. If this model is joined to a Ext.data.NodeStore, then this method calls
the given method on the NodeStore and the associated Ext.data.TreeStore.

Parameters

funcName :
String

The name function to call on each store.

args :
Array(optional)

The arguments to pass to the method. This instance is
always inserted as the first argument.

Returns

protectedpro

This method is used by an override to call the superclass method but
bypass any overridden method. This is often done to "patch" a method that
contains a bug but for whatever reason cannot be fixed directly.

The patch method cannot use method-callParent to call the superclass
method since that would call the overridden method containing the bug. In
other words, the above patch would only produce "Fixed" then "Good" in the
console log, whereas, using callParent would produce "Fixed" then "Bad"
then "Good".

Parameters

args :
Array/Arguments

The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)

Parameters

silent :
Boolean(optional)

Pass true to skip notification of the owning store of the change.

Defaults to: false

modifiedFieldNames :
String[](optional)

Array of field names changed during sync with server if known.
Omit or pass null if unknown. An empty array means that it is known that no fields were modified
by the server's response.
Defaults to false.

Marks this record as dropped and waiting to be deleted on the server. When a
record is dropped, it is automatically removed from all association stores and
any child records associated to this record are also dropped (a "cascade delete")
depending on the cascade parameter.

Parameters

Returns

Gets all of the data from this Models loaded associations. It does this
recursively. For example if we have a User which hasMany Orders, and each Order
hasMany OrderItems, it will return an object like this:

{
orders: [
{
id: 123,
status: 'shipped',
orderItems: [
...
]
}
]
}

Parameters

result :
Object(optional)

The object on to which the associations will be added. If
no object is passed one is created. This object is then returned.

Pass true to only include fields that
have been modified. Note that field modifications are only tracked for fields that
are not declared with persist set to false. In other words, only persistent
fields have changes tracked so passing true for this means options.persist is
redundant.

Returns

Gets an object of only the fields that have been modified since this record was
created or committed. Only persistent fields are tracked in the modified set so
this method will only return changes to persistent fields.

Returns

privatepri

Gets all values for each field in this model and returns an object containing the
current data. This can be tuned by passing an options object with various
properties describing the desired result. Passing true simply returns all fields
and all associated record data.

Parameters

options :
Boolean/Object(optional)

An object containing options describing the data
desired. If true is passed it is treated as an object with associated set to
true.

Pass true to only include fields that
have been modified. Note that field modifications are only tracked for fields that
are not declared with persist set to false. In other words, only persistent
fields have changes tracked so passing true for this means options.persist is
redundant.

Parameters

refresh :
Boolean(optional)

Pass false to not call the refresh method on the
validation instance prior to returning it. Pass true to force a refresh of the
validation instance. By default the returned record is only refreshed if changes
have been made to this record.

Usually called by the Ext.data.Store to which this model instance has been joined. Rejects
all changes made to the model instance since either creation, or the last commit operation. Modified fields are
reverted to their original values.

privatepri

Parameters

protectedpro

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self,
this.statics() is scope-independent and it always returns the class from which it was called, regardless of what
this points to during run-time

Returns

Returns a url-suitable string for this model instance. By default this just returns the name of the Model class
followed by the instance ID - for example an instance of MyApp.model.User with ID 123 will return 'user/123'.

The scope in which to execute the callback
functions. Defaults to the model instance.

session :
Ext.data.Session(optional)

The session for this record.

Returns

:Ext.data.Model

The newly created model. Note that the model will
(probably) still be loading once it is returned from this method. To do any
post-processing on the data, the appropriate place to do see is in the
callback.

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

staticstaprotectedpro

Removes the given set of fields from this model.

Available since: 5.0.0

Parameters

removeFields :
Boolean/String[]

The names of fields to remove or true
to remove all existing fields. Removes are processed first followed by adds so
if a field name appears in newFields as well that field will effectively be
added (however, in that case there is no need to include the field in this
array).

staticstaprotectedpro

This method replaces the specified set of fields with a given set of new fields.
Fields should normally be considered immutable, but if the timing is right (that
is, before derived classes are declared), it is permissible to change the fields
collection.

Available since: 5.0.0

Parameters

newFields :
String[]/Object[]

The new fields to add. Based on the name
of a field this may replace a previous field definition.

removeFields :
Boolean/String[]

The names of fields to remove or true
to remove all existing fields. Removes are processed first followed by adds so
if a field name appears in newFields as well that field will effectively be
added (however, in that case there is no need to include the field in this
array).