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

Ext.app.ViewModel alias: viewmodel.default

Summary

This class manages arbitrary data and its relationship to data models. Instances of ViewModel are associated with some Component and then used by their child items for the purposes of Data Binding.

Binding

The most commonly used aspect of a ViewModel is the bind method. This method takes a "bind descriptor" (see below) and a callback to call when the data indicated by the bind descriptor either becomes available or changes.

The bind method, based on the bind descriptor given, will return different types of "binding" objects. These objects maintain the connection between the requested data and the callback. Bindings ultimately derive from Ext.app.bind.BaseBinding which provides several methods to help manage the binding.

Perhaps the most important method is destroy. When the binding is no longer needed it is important to remember to destroy it. Leaking bindings can cause performance problems or worse when callbacks are called at unexpected times.

The types of bindings produced by bind are:

Bind Descriptors

A "bind descriptor" is a value (a String, an Object or an array of these) that describe the desired data. Any piece of data in the ViewModel can be described by a bind descriptor.

Textual Bind Descriptors

The simplest and most common form of bind descriptors are strings that look like an Ext.Template containing text and tokens surrounded by "{}" with dot notation inside to traverse objects and their properties.

For example:

  • 'Hello {user.name}!'
  • 'You have selected "{selectedItem.text}".'
  • '{!isDisabled}'
  • '{a > b ? "Bigger" : "Smaller"}'
  • '{user.groups}'

All except the last are Ext.app.bind.TemplateBinding which use the familiar Ext.Template syntax with some slight differences. For more on templates see Ext.app.bind.Template.

The last descriptor is called a "direct bind descriptor". This special form of bind maps one-to-one to some piece of data in the ViewModel and is managed by the Ext.app.bind.Binding class.

Two-Way Descriptors

A direct bind descriptor may be able to write back a value to the ViewModel as well as retrieve one. When this is the case, they are said to be "two-way". For example:

 var binding = viewModel.bind('{s}', function(s) { console.log('s=' + s); });

 binding.setValue('abc');

Direct use of ViewModel in this way is not commonly needed because Ext.Component automates this process. For example, a textfield component understands when it is given a "two-way" binding and automatically synchronizes its value bidirectionally using the above technique. For example:

 Ext.widget({
     items: [{
         xtype: 'textfield',
         bind: '{s}'  // a two-way / direct bind descriptor
     }]
 });

Object and Array Descriptors / Multi-Bind

With two exceptions (see below) an Object is interpreted as a "shape" to produce by treating each of its properties as individual bind descriptors. An object of the same shape is passed as the value of the bind except that each property is populated with the appropriate value. Of course, this definition is recursive, so these properties may also be objects.

For example:

 viewModel.bind({
         x: '{x}',
         foo: {
             bar: 'Hello {foo.bar}'
         }
     },
     function (obj) {
         //  obj = {
         //      x: 42,
         //      foo: {
         //          bar: 'Hello foobar'
         //      }
         //  }
     });

Arrays are handled in the same way. Each element of the array is considered a bind descriptor (recursively) and the value produced for the binding is an array with each element set to the bound property.

Bind Options

One exception to the "object is a multi-bind" rule is when that object contains a bindTo property. When an object contains a bindTo property the object is understood to contain bind options and the value of bindTo is considered the actual bind descriptor.

For example:

 viewModel.bind({
         bindTo: '{x}',
         single: true
     },
     function (x) {
         console.log('x: ' + x); // only called once
     });

The available bind options depend on the type of binding, but since all bindings derive from Ext.app.bind.BaseBinding its options are always applicable. For a list of the other types of bindings, see above.

Deep Binding

When a direct bind is made and the bound property is an object, by default the binding callback is only called when that reference changes. This is the most efficient way to understand a bind of this type, but sometimes you may need to be notified if any of the properties of that object change.

To do this, we create a "deep bind":

 viewModel.bind({
         bindTo: '{someObject}',
         deep: true
     },
     function (someObject) {
         // called when reference changes or *any* property changes
     });

Binding Timings

The ViewModel has a scheduler attached that is used to coordinate the firing of bindings. It serves 2 main purposes:

  • To coordinate dependencies between bindings. This means bindings will be fired in an order such that the any dependencies for a binding are fired before the binding itself.
  • To batch binding firings. The scheduler runs on a short timer, so the following code will only trigger a single binding (the last), the changes in between will never be triggered.

Example:

viewModel.bind('{val}', function(v) {
    console.log(v);
});
viewModel.set('val', 1);
viewModel.set('val', 2);
viewModel.set('val', 3);
viewModel.set('val', 4);

The ViewModel can be forced to process by calling notify, which will force the scheduler to run immediately in the current state.

viewModel.bind('{val}', function(v) {
    console.log(v);
});
viewModel.set('val', 1);
viewModel.notify();
viewModel.set('val', 2);
viewModel.notify();
viewModel.set('val', 3);
viewModel.notify();
viewModel.set('val', 4);
viewModel.notify();

Models, Stores and Associations

A Ext.data.Session manages model instances and their associations. The ViewModel may be used with or without a Session. When a Session is attached, the ViewModel will always consult the Session to ask about records and stores. The Session ensures that only a single instance of each model Type/Id combination is created. This is important when tracking changes in models so that we always have the same reference.

A ViewModel provides functionality to easily consume the built in data package types Ext.data.Model and Ext.data.Store, as well as their associations.

Model Links

A model can be described declaratively using links. In the example code below, We ask the ViewModel to construct a record of type User with id: 17. The model will be loaded from the server and the bindings will trigger once the load has completed. Similarly, we could also attach a model instance to the ViewModel data directly.

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: ['name']
});

var rec = new MyApp.model.User({
    id: 12,
    name: 'Foo'
});

var viewModel = new Ext.app.ViewModel({
    links: {
        theUser: {
            type: 'User',
            id: 17
        }
    },
    data: {
        otherUser: rec
    }
});
viewModel.bind('{theUser.name}', function(v) {
    console.log(v);
});
viewModel.bind('{otherUser.name}', function(v) {
    console.log(v);
});

Model Fields

Bindings have the functionality to inspect the parent values and resolve the underlying value dynamically. This behavior allows model fields to be interrogated as part of a binding.

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: ['name', 'age']
});

var viewModel = new Ext.app.ViewModel({
    links: {
        theUser: {
            type: 'User',
            id: 22
        }
    }
});

// Server responds with:
{
    "id": 22,
    "name": "Foo",
    "age": 100
}

viewModel.bind('Hello {name}, you are {age} years old', function(v) {
    console.log(v);
});

Record Properties

It is possible to bind to the certain state properties of a record. The available options are:

Example usage:

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: [{
        name: 'name',
        validators: 'presence'
    }, {
        name: 'age',
        validators: {
           type: 'range',
            min: 0
         }
    }]
});

var rec = new MyApp.model.User();

var viewModel = new Ext.app.ViewModel({
    data: {
        theUser: rec
    }
});

viewModel.bind({
    dirty: '{theUser.dirty}',
    phantom: '{theUser.phantom}',
    valid: '{theUser.valid}'
}, function(v) {
    console.log(v.dirty, v.valid);
});

rec.set('name', 'Foo');
viewModel.notify(); // dirty, not valid
rec.set('age', 20);
viewModel.notify(); // dirty, valid
rec.reject();
viewModel.notify(); // not dirty, not valid

Advanced Record Binding

For accessing other record information that is not exposed by the binding API, formulas can be used to achieve more advanced operations:

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: ['name', 'age']
});

var rec = new MyApp.model.User();

var viewModel = new Ext.app.ViewModel({
    formulas: {
        isNameModified: {
            bind: {
                bindTo: '{theUser}',
                deep: true
            },
            get: function(rec) {
                return rec.isModified('name');
            }
        }
    },
    data: {
        theUser: rec
    }
});

viewModel.bind('{isNameModified}', function(modified) {
    console.log(modified);
});
rec.set('name', 'Foo');

Associations

In the same way as fields, the bindings can also traverse associations in a bind statement. The ViewModel will handle the asynchronous loading of data and only present the value once the full path has been loaded. For more information on associations see Ext.data.schema.OneToOne and Ext.data.schema.ManyToOne associations.

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

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

Ext.define('OrderItem', {
    extend: 'Ext.data.Model',
    fields: ['price', 'qty', {
        name: 'orderId',
        reference: 'Order'
    }]
});

var viewModel = new Ext.app.ViewModel({
    links: {
        orderItem: {
            type: 'OrderItem',
            id: 13
        }
    }
});
// The viewmodel will handle both ways of loading the data:
// a) If the data is loaded inline in a nested fashion it will
//    not make requests for extra data
// b) Only loading a single model at a time. So the Order will be loaded once
//    the OrderItem returns. The User will be loaded once the Order loads.
viewModel.bind('{orderItem.order.user.name}', function(name) {
    console.log(name);
});

Stores

Stores can be created as part of the ViewModel definition. The definitions are processed like bindings which allows for very powerful dynamic functionality.

It is important to ensure that you name viewModel's data keys uniquely. If data is not named uniquely, binds and formulas may receive information from an unintended data source. This applies to keys in the viewModel's data block, stores, and links configs.

var viewModel = new Ext.app.ViewModel({
    stores: {
        users: {
            model: 'User',
            autoLoad: true,
            filters: [{
                property: 'createdDate',
                value: '{createdFilter}',
                operator: '>'
            }]
        }
    }
});
// Later on in our code, we set the date so that the store is created.
viewModel.set('createdFilter', Ext.Date.subtract(new Date(), Ext.Date.DAY, 7));

See stores for more detail.

Store Properties

It is possible to bind to the certain state properties of the store. The available options are:

Example:

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: ['name']
});

var viewModel = new Ext.app.ViewModel({
    stores: {
        users: {
            model: 'MyApp.model.User',
            data: [{
                name: 'Foo'
            }, {
                name: 'Bar'
            }]
        }
    }
});

viewModel.bind('{users.first}', function(first) {
    console.log(first ? first.get('name') : 'Nobody');
});

var timer = Ext.interval(function() {
    var store = viewModel.getStore('users');
    if (store.getCount()) {
        store.removeAt(0);
    } else {
        Ext.uninterval(timer);
    }
}, 100);

Advanced Store Binding

For accessing other store information that is not exposed by the binding API, formulas can be used to achieve more advanced operations:

Ext.define('MyApp.model.User', {
    extend: 'Ext.data.Model',
    fields: ['name', 'score']
});

var viewModel = new Ext.app.ViewModel({
    stores: {
        users: {
            model: 'MyApp.model.User',
            data: [{
                name: 'Foo',
                score: 100
            }, {
                name: 'Bar',
                score: 350
            }]
        }
    },
    formulas: {
        totalScore: {
            bind: {
                bindTo: '{users}',
                deep: true
            },
            get: function(store) {
                return store.sum('score');
            }
        }
    }
});

viewModel.bind('{totalScore}', function(score) {
    console.log(score);
});

viewModel.notify();
viewModel.getStore('users').removeAll();

Formulas

Formulas allow for calculated ViewModel data values. The dependencies for these formulas are automatically determined so that the formula will not be processed until the required data is present.

var viewModel = new Ext.app.ViewModel({
    formulas: {
        fullName: function(get) {
            return get('firstName') + ' ' + get('lastName');
        }
    },
    data: {firstName: 'John', lastName: 'Smith'}
});

viewModel.bind('{fullName}', function(v) {
    console.log(v);
});

See formulas for more detail.

Inheriting Data With Nesting

ViewModels can have a parent which allows values to be consumed from a shared base. These values that are available from the parent are not copied, rather they are "inherited" in a similar fashion to a javascript closure scope chain. This is demonstrated in the example below:

var parent = new Ext.app.ViewModel({
    data: {
        foo: 3
    }
});
var child = new Ext.app.ViewModel({
    parent: parent
});

This is analogous to the following javascript closure:

var foo = 3;
Ext.Ajax.request({
    success: function() {
        // foo is available here
    }
});

Climbing/Inheriting

In line with the above, the default behaviour when setting the value of a child ViewModel (either) through set or Ext.app.bind.Binding#method-setValue is to climb to where the value is "owned" and set the value there:

var parent = new Ext.app.ViewModel({
    data: {
        foo: 3
    }
});
var child = new Ext.app.ViewModel({
    parent: parent
});

child.set('foo', 100); // Climbs to set the value on parent
console.log(parent.get('foo')); // 100
parent.set('foo', 200);
console.log(child.get('foo')); // 200, inherited from the parent

Any subsequent sets are also inherited in the same fashion. The inheriting/climbing behavior occurs for any arbitrary depth, climbing/inherting can owned by a parent at any level above.

function log() {
    console.log([a, b, c, d, e].map(function(vm) {
        return vm.get('foo');
    }));
}

var a = new Ext.app.ViewModel({data: {foo: 3}}),
    b = new Ext.app.ViewModel({parent: a}),
    c = new Ext.app.ViewModel({parent: b}),
    d = new Ext.app.ViewModel({parent: c}),
    e = new Ext.app.ViewModel({parent: d});

log(); // [3, 3, 3, 3, 3]

e.set('foo', 100);
log(); // [100, 100, 100, 100, 100]

This same climbing behavior applies when setting a value on a binding. The climbing begins from the ViewModel where the binding was attached:

function log() {
    console.log([a, b, c].map(function(vm) {
        return vm.get('foo');
    }));
}

var a = new Ext.app.ViewModel({data: {foo: 3}}),
    b = new Ext.app.ViewModel({parent: a}),
    c = new Ext.app.ViewModel({parent: b});

var bind = c.bind('{foo}', function() {});

bind.setValue(100);
log(); // [100, 100, 100]

The exception to this rule is when there is nothing above to climb to. If a value is set and there is no parent above to hold it, then the value is set where it was called:

function log() {
    console.log([a, b, c].map(function(vm) {
        return vm.get('foo');
    }));
}

var a = new Ext.app.ViewModel(),
    b = new Ext.app.ViewModel({parent: a}),
    c = new Ext.app.ViewModel({parent: b});

c.set('foo', 3);
log(); // [null, null, 3]

b.set('foo', 2);
log(); // [null, 2, 3]

a.set('foo', 1);
log(); // [1, 2, 3]

These values are called local values, which are discussed below.

Local Values

If the child ViewModel is declared with top level data that also exists in the parent, then that child is considered to own that local value, so no value is inherited from the parent, nor does the climbing behaviour occur.

var parent = new Ext.app.ViewModel({
    data: {
        foo: 3
    }
});
var child = new Ext.app.ViewModel({
    parent: parent,
    data: {
        foo: 5
    }
});

console.log(parent.get('foo'), child.get('foo')); // 3, 5
child.set('foo', 100);
console.log(parent.get('foo'), child.get('foo')); // 3, 100
parent.set('foo', 200);
console.log(parent.get('foo'), child.get('foo')); // 200, 100

The inheriting/climbing behavior is limited to local values:

function log() {
    console.log([a, b, c, d, e].map(function(vm) {
        return vm.get('foo');
    }));
}

var a = new Ext.app.ViewModel({data: {foo: 1}}),
    b = new Ext.app.ViewModel({parent: a}),
    c = new Ext.app.ViewModel({parent: b, data: {foo: 2}}),
    d = new Ext.app.ViewModel({parent: c}),
    e = new Ext.app.ViewModel({parent: d, data: {foo: 3}});

log(); // [1, 1, 2, 2, 3]

e.set('foo', 100);
log(); // [1, 1, 2, 2, 100]

d.set('foo', 200);
log(); // [1, 1, 200, 200, 100]

c.set('foo', 201);
log(); // [1, 1, 201, 201, 100]

b.set('foo', 300);
log(); // [300, 300, 201, 201, 100]

a.set('foo', 301);
log(); // [301, 301, 201, 201, 100]

Attaching/Clearing Local Values Dynamically

To bypass the climbing behaviour and push a value into a particular point in the hierarchy, the setData method should be used. Once a local value is set, it will be used as such in the future.

function log() {
    console.log([a, b, c, d, e].map(function(vm) {
        return vm.get('foo');
    }));
}

var a = new Ext.app.ViewModel({data: {foo: 3}}),
    b = new Ext.app.ViewModel({parent: a}),
    c = new Ext.app.ViewModel({parent: b}),
    d = new Ext.app.ViewModel({parent: c}),
    e = new Ext.app.ViewModel({parent: d});

log(); // [3, 3, 3, 3, 3]

c.setData({
    foo: 100
});

log(); // [3, 3, 100, 100, 100]

d.set('foo', 200); // Climbs to new local value
log(); // [3, 3, 200, 200, 200]

Similarly, data can be cleared from being a local value by setting the value to undefined:

function log() {
    console.log([a, b, c, d].map(function(vm) {
        return vm.get('foo');
    }));
}

var a = new Ext.app.ViewModel({data: {foo: 3}}),
    b = new Ext.app.ViewModel({parent: a}),
    c = new Ext.app.ViewModel({parent: b, data: {foo: 100}}),
    d = new Ext.app.ViewModel({parent: c});

log(); // [3, 3, 100, 100]

c.setData({
    foo: undefined
});
log([3, 3, 3, 3]);
No members found using the current filters

configs

Optional Configs

data : Object

This object holds the arbitrary data that populates the ViewModel and is then available for binding.

Defaults to:

true

Available since: 5.0.0

getData : Object

Returns the value of data

Returns

Object

setData ( data )

Sets data directly at the level of this viewmodel. This method does not climb to set data on parent view models. Passing undefined will clear the value in this viewmodel, which means that this viewmodel is free to inherit data from a parent. See "Inheriting Data" in the class introduction for more information.

Parameters

data :  Object

The new data to set.

formulas : Object

An object that defines named values whose value is managed by function calls. The names of the properties of this object are assigned as values in the ViewModel.

For example:

 formulas: {
     xy: function (get) { return get('x') * get('y'); }
 }

For more details about defining a formula, see Ext.app.bind.Formula.

Defaults to:

null

Available since: 5.0.0

getFormulas : Object

Returns the value of formulas

Returns

Object

setFormulas (formulas)

Sets the value of formulas

Parameters

formulas :  Object

parent : Ext.app.ViewModel
readonly ro

The parent ViewModel of this ViewModel. Once set, this cannot be changed.

Defaults to:

null

Available since: 5.0.0

getParent : Ext.app.ViewModel

Returns the value of parent

Returns

Ext.app.ViewModel

setParent (parent)

Sets the value of parent

Parameters

parent :  Ext.app.ViewModel

root : Ext.app.bind.RootStub
private pri

A reference to the root "stub" (an object that manages bindings).

Defaults to:

true

Available since: 5.0.0

getRoot : Ext.app.bind.RootStub

Returns the value of root

Returns

Ext.app.bind.RootStub

setRoot (root)

Sets the value of root

Parameters

root :  Ext.app.bind.RootStub

scheduler : Ext.util.Scheduler
readonly ro private pri

The scheduler used to schedule and manage the delivery of notifications for all connections to this ViewModel and any other attached to it. The normal process to initialize the scheduler is to get the scheduler used by the parent or session and failing either of those, create one.

Defaults to:

null

Available since: 5.0.0

getScheduler : Ext.util.Scheduler

Returns the value of scheduler

Returns

Ext.util.Scheduler

setScheduler (scheduler)

Sets the value of scheduler

Parameters

scheduler :  Ext.util.Scheduler

schema : String / Ext.data.schema.Schema

The schema to use for getting information about entities.

Defaults to:

'default'

getSchema : String / Ext.data.schema.Schema

Returns the value of schema

Returns

String / Ext.data.schema.Schema

setSchema (schema)

Sets the value of schema

Parameters

schema :  String / Ext.data.schema.Schema

session : Ext.data.Session

The session used to manage the data model (records and stores).

Defaults to:

null

Available since: 5.0.0

getSession Ext.data.Session

Gets the session attached to this (or a parent) ViewModel. See the session configuration.

Returns

:Ext.data.Session

The session. null if no session exists.

setSession (session)

Sets the value of session

Parameters

session :  Ext.data.Session

stores : Object

A declaration of Ext.data.Store configurations that are first processed as binds to produce an effective store configuration.

A simple store definition. We can reference this in our bind statements using the {users} as we would with other data values.

new Ext.app.ViewModel({
    stores: {
        users: {
            model: 'User',
            autoLoad: true
        }
    }
});

This store definition contains a dynamic binding. The store will not be created until the initial value for groupId is set. Once that occurs, the store is created with the appropriate filter configuration. Subsequently, once we change the group value, the old filter will be overwritten with the new value.

var viewModel = new Ext.app.ViewModel({
    stores: {
        users: {
            model: 'User',
            filters: [{
                property: 'groupId',
                value: '{groupId}'
            }]
        }
    }
});
viewModel.set('groupId', 1); // This will trigger the store creation with the filter.
viewModel.set('groupId', 2); // The filter value will be changed.

This store uses Ext.data.ChainedStore to create a store backed by the data in another store. By specifying a string as the store, it will bind our creation and backing to the other store. This functionality is especially useful when wanting to display a different "view" of a store, for example a different sort order or different filters.

var viewModel = new Ext.app.ViewModel({
    stores: {
        allUsers: {
            model: 'User',
            autoLoad: true
        },
        children: {
            source: '{allUsers}',
            filters: [{
                property: 'age',
                value: 18,
                operator: '<'
            }]
        }
    }
});

Defaults to:

null

Available since: 5.0.0

setStores (stores)

Sets the value of stores

Parameters

stores :  Object

view : Ext.Container

The Container that owns this ViewModel instance.

Defaults to:

null

Available since: 5.0.0

getView : Ext.Container

Returns the value of view

Returns

Ext.Container

setView (view)

Sets the value of view

Parameters

view :  Ext.Container

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

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

Defaults to:

true

Available since: 5.0.0

$configStrict : Boolean
private pri

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.

Defaults to:

true

Available since: 5.0.0

clearPropertiesOnDestroy : Boolean / "async"
protected pro

Setting this property to false will prevent nulling object references on a Class instance after destruction. Setting this to "async" will delay the clearing for approx 50ms.

Defaults to:

true

Available since: 6.2.0

clearPrototypeOnDestroy : Boolean
private pri

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.

Defaults to:

false

Available since: 6.2.0

data : Object
readonly ro private pri

This object holds all of the properties of this ViewModel. It is prototype chained to the linkData which is, in turn, prototype chained to (if present) the data object of the parent ViewModel.

Defaults to:

Ext.Object.chain(linkData)

Available since: 5.0.0

destroyed : Boolean
protected pro

This property is set to true after the destroy method is called.

Defaults to:

false

factoryConfig : Object

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

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

linkData : Object
readonly ro private pri

This object is used to hold the result of a linked value. This is done so that the data object hasOwnProperty equates to whether or not this property is owned by this instance or inherited.

Defaults to:

linkData = parent ? Ext.Object.chain(parent.getData()) : {}

Available since: 5.0.0

self : Ext.Class
protected pro

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

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Defaults to:

Base

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

bind ( descriptor, callback, [scope], [options] ) : Ext.app.bind.BaseBinding/Ext.app.bind.Binding

This method requests that data in this ViewModel be delivered to the specified callback. The data desired is given in a "bind descriptor" which is the first argument.

A simple call might look like this:

var binding = vm.bind('{foo}', this.onFoo, this);

binding.destroy();  // when done with the binding

Options for the binding can be provided in the last argument:

var binding = vm.bind('{foo}', this.onFoo, this, {
    deep: true
});

Alternatively, bind options can be combined with the bind descriptor using only the first argument:

var binding = vm.bind({
    bindTo: '{foo}',  // the presence of bindTo identifies this form
    deep: true
}, this.onFoo, this);

See the class documentation for more details on Bind Descriptors and options.

Parameters

descriptor :  String/Object/Array

The bind descriptor. See class description for details.

callback :  Function

The function to call with the value of the bound property.

scope :  Object (optional)

The scope (this pointer) for the callback.

options :  Object (optional)

Additional options to configure the Ext.app.bind.Binding. If this parameter is provided, the bindTo form of combining options and bind descriptor is not recognized.

Returns

:Ext.app.bind.BaseBinding/Ext.app.bind.Binding

The binding.

callOverridden ( args ) : Object
deprecated dep protected pro

Call the original method that was previously overridden with Ext.Base#override

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.callOverridden();

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the overridden method

Deprecated since version 4.1.0
Use method-callParent instead.

callParent ( args ) : Object
protected pro

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static and private methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10));     // alerts 10
 alert(My.Derived2.method(10)); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use method-callSuper. This is often done to patch a method to fix a bug.

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

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.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     extend: 'Ext.some.Class',

     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.patches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

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)

Returns

:Object

Returns the result of calling the superclass method

destroy

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further in any way, including access to its methods and properties.

To prevent potential memory leaks, all object references will be nulled at the end of destruction sequence, unless clearPropertiesOnDestroy is set to false.

destroyMembers ( args )

Destroys member properties by name.

If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.

The property will be destroyed, and the corrected name (if the property is a config and config names are prefixed) will set to null in this object's dictionary.

Parameters

args :  String...

One or more names of the properties to destroy and remove from the object.

get ( path ) : Object

Get a value from the data for this viewmodel.

Parameters

path :  String

The path of the data to retrieve.

var value = vm.get('theUser.address.city');

Returns

:Object

The data stored at the passed path.

getConfig ( [name], [peek], [ifInitialized] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

true to peek at the raw value without calling the getter.

Defaults to: false

ifInitialized :  Boolean (optional)

true to only return the initialized property value, not the raw config value, and not to trigger initialization. Returns undefined if the property has not yet been initialized.

Defaults to: false

Returns

:Object

The config property value.

getId String

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

:String

id

getInitialConfig ( [name] ) : Object/Mixed

Returns the initial configuration passed to the constructor when instantiating this class.

Given this example Ext.button.Button definition and instance:

Ext.define('MyApp.view.Button', {
    extend: 'Ext.button.Button',
    xtype: 'mybutton',

    scale: 'large',
    enableToggle: true
});

var btn = Ext.create({
    xtype: 'mybutton',
    renderTo: Ext.getBody(),
    text: 'Test Button'
});

Calling btn.getInitialConfig() would return an object including the config options passed to the create method:

xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'

Calling btn.getInitialConfig('text')returns 'Test Button'.

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed

The full config object or a single config value when name parameter specified.

getRecord ( type, id ) : Ext.data.Model
private pri

Get a record instance given a reference descriptor. Will ask the session if one exists.

Parameters

type :  String/Ext.Class

The model type.

id :  Object

The model id.

Returns

:Ext.data.Model

The model instance.

getStore ( key ) : Ext.data.Store

Gets a store configured via the stores configuration.

Parameters

key :  String

The name of the store.

Returns

:Ext.data.Store

The store. null if no store exists.

getStub ( bindDescr ) : Ext.app.bind.AbstractStub
private pri

This method looks up the Stub for a single bind descriptor.

Parameters

bindDescr :  String/Object

The bind descriptor.

Returns

:Ext.app.bind.AbstractStub

The Stub associated to the bind descriptor.

hasConfig ( name )
private pri

Parameters

name :  String

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

linkTo ( key, reference )

Create a link to a reference. See the links configuration.

Parameters

key :  String

The name for the link.

reference :  Object

The reference descriptor.

notify

Forces all bindings in this ViewModel hierarchy to evaluate immediately. Use this to do a synchronous flush of all bindings.

set ( path, value )

Set a value in the data for this viewmodel. This method will climb to set data on a parent view model if appropriate. See "Inheriting Data" in the class introduction for more information.

Parameters

path :  Object/String

The path of the value to set, or an object literal to set at the root of the viewmodel.

value :  Object

The data to set at the value. If the value is an object literal, any required paths will be created.

// Set a single property at the root level
viewModel.set('expiry', Ext.Date.add(new Date(), Ext.Date.DAY, 7));
console.log(viewModel.get('expiry'));
// Sets a single property in user.address, does not overwrite any hierarchy.
viewModel.set('user.address.city', 'London');
console.log(viewModel.get('user.address.city'));
// Sets 2 properties of "user". Overwrites any existing hierarchy.
viewModel.set('user', {firstName: 'Foo', lastName: 'Bar'});
console.log(viewModel.get('user.firstName'));
// Sets a single property at the root level. Overwrites any existing hierarchy.
viewModel.set({rootKey: 1});
console.log(viewModel.get('rootKey'));

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

name :  String/Object

The name of the property to set, or a set of key value pairs to set.

value :  Object (optional)

The value to set for the name parameter.

Returns

:Ext.Base

this

statics Ext.Class
protected pro

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

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self();   // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Returns

:Ext.Class
Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat();
 kitty.meow();

Parameters

members :  Object

The members to add to this class.

isStatic :  Boolean (optional)

Pass true if the members are static.

Defaults to: false

privacy :  Boolean (optional)

Pass true if the members are private. This only has meaning in debug mode and only for methods.

Defaults to: false

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base

this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Returns

:Object

the created instance.

createAlias ( alias, origin )
static sta

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

escape ( value ) : Object/String
static sta private pri

Escape bind strings so they are treated as literals.

Available since: 6.5.2

Parameters

value :  Object/String

The value to escape. If the value is an object, any strings will be recursively escaped.

Returns

:Object/String

The escaped value. Matches the type of the passed value.

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Returns

:String

className

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch static sta

Override members of this class. Overridden methods can be invoked via 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

triggerExtended
static sta private pri

Ext JS 6.7.0-CE - Modern Toolkit