Login Register

Documentation

I'm working on doing some documenting/visualizing of the Grid design for both pedagogical and organizational reasons.

I'm attaching my first breakdown of the grid modules here. It's imperfect, but I don't want to hesitate on sharing information.

AttachmentSize
GridModules.png85.39 KB

Dojo grid data providers

Thanks to sjmiles for posting few weeks ago this excellent cross section of the Dojo grid components. The section illustrates nicely the integral parts of the grid. But in order to use the grid in practice, you need to wire it with the data. So I wanted to extend this thread to document some aspects of the data provider components that are often used with the grid. Working with Dojo data stores should be straightforward thanks to APIs, but working with their internals is still a gray area for many of us using Dojo.

The grid enables different abstraction levels:

  1. VirtualGrid: no model, no store — user implements get-method to feed data
  2. Grid with default model (table) (see data): model, no store — input two-dimensional arrays
  3. Grid with DojoData model and store: model, store — model connects to a store that takes input depending on the store type (json, csv, xml)

Two of these use data providers: model and store. These components should be documented as well in connection to the grid. Plus also naturally their internals for people who are working with them.

Edit: I refactored my post by splitting it into two - see Roles of DojoData model and store, now and in future?.