Learn from Saki

Knowledge is power

Hello! To access your account, please Log in. Not a member? Sign up

On ExtJS 5 Chained Stores

by 17 Comments

I’ve started to look into new features of ExtJS 5 and today I have picked Chained Stores that solve, or they should, the problem of multiple views using the same store. If you list a store in stores:[] array of application or controller, Ext instantiates the store and registers it to Store Manager. Configuration option store in view usually points to this one global instance of the store. It’s fine because it saves the server round trips but the main drawback is that if you sort or filter the store in one view (clicking a column in a grid) then the global instance gets sorted so are all view using it. That is not desirable. Chained Stores, new in Ext 5, alleviate this problem, however, we must understand how they work, what they are good for and when they cannot be used.

What is a Chained Store

Chained Store is a special kind of store that cannot access the data source directly but via its source store. It maintains its own data snapshots, filters and sorters linking records to its source.

Hence, a record in all chained stores is the same thing as the same record in the source store. Only filters and sorters are unlinked. chained-store

What we should know about Chained Stores?

  1. they have their own links to source store data
  2. if data in the real store change (create, read, update, delete), chained store data also change
  3. updating record in a chained store actually updates the record in the source store, consequently in all chained stores with the same source
  4. if an update causes the main store re-filtering, re-sorting, all stores are affected
  5. sorting and filtering of the main store does not trigger filtering and sorting of chained stores
  6. filtering and sorting of chained stores is independent from each other and from the source store
  7. chained stores do not have load method
  8. they cannot talk to servers directly, they don’t have their own proxies and readers
  9. they cannot be used together with paging
  10. they can be used with buffered renderer plugin
That is what I have found so far. If you have any other interesting findings, do not hesitate to post a comment below this post.

Playground

You can play with the chained stores below. Both grid and data view link to the real store with store id ActorStore, so you can get a hold of it from the command-line by calling Ext.getStore('ActorStore').
Download the example code:
 
Follow me:
Latest posts by saki (see all)

Comments

  1. Thank you, very good explanation especially with diagrams and clarifying some things I wouldn’t have thought of e.g. chained stores don’t have their own load method.

    Rabia

  2. The filtering doesn’t seem to behave consistently. If you filter for ‘Hall’ on the Main Store you get 3 records. If you apply the same filter to the Chained Stores you only get 1. How come?
    Are the filters set up in a different way?

    Roger

  3. The reason I looked at this is I have a scenario where I have a tree where the nodes relate to grids, updating the grid should update the tree and vice versa. There is multiple grids/views linked to the tree.
    What is the best method for refreshing the views ? I looked at events and store listeners but it’s starting to get messy and so I’m thinking it’s not the right approach.

    I was thinking that my tree could be the main store with the various grids as chained stores?

    As always your advice is appreciated.

    Dave

    • Hello Dave,

      this is not a bona fide example, it is a playground to test the filtering behavior of normal and chained stores so that you can make a qualified decision which one to use.

      BTW, the code is nothing special, the grid uses normal store and the data view chained store.

      Best,
      Saki

      • Got you.. so the example for ExtJS5 complex data binding is essentially the same thing?

        Keep up the good work…. 🙂 it’s helped my immensely !

  5. Saki,
    Another great article, just used a chained store to create an associations between (2) data tables. Very nice way to show a grid or data view of associated tables.

    • Hello Siva,

      as a free member, you can purchase the code for $9.90. If you want to download the code for free, you need monthly/annual subscription.

  7. I notice that there is no code shown here (I like that code shown, very helpful).

    Also, shouldn’t source:’ActorStore’ be source:'{ActorStore}’?

    • Peter, in this case the configuration is correct so source should really be ‘ActorStore’. The reason for that is that we are not binding but only configuring the reference to the source store. ActorStore is referenced normally in Application::stores[‘ActorStore’] hence the name.

      As a subscriber, you can download the complete code, cannot you? If not, let us know, we fix it.

We will be happy to hear back from you

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Want to collaborate on an upcoming project?