Opened 12 years ago

Closed 12 years ago

#5841 closed defect (fixed)

Documentation for retrieving the model from the Grid is incorrect

Reported by: benschell Owned by: Neil Roberts
Priority: high Milestone:
Component: Doc parser Version: 1.0
Keywords: Cc:
Blocked By: Blocking:

Description

On the 'Model Options' page in the book (http://www.dojotoolkit.org/book/dojo-book-0-9/docx-documentation-under-development/grid/model-options), it is stated that the model can be retrieved from the grid by calling grid.getModel(). This is incorrect. I propose changing the documentation as follows:

dojox.grid.data.Model
The raw data behind a grid. Can be retrieved from a grid by accessing the
grid's public 'model' attribute.  The model can be set for a grid by calling
setModel(newModel).

Additionally, I believe the get/set limitations aren't properly outlined on the 'grid tag' page (http://www.dojotoolkit.org/book/dojo-book-0-9/docx-documentation-under-development/grid/grid-tag) either. Specifically, perhaps the model attribute should be reworded:

model: Current grid data model.  Should only be used for retrieving
the model. Setting should be accomplished using setModel(newModel) as 
outlined below.

...or something similar.

Change History (1)

comment:1 Changed 12 years ago by Jared Jurkiewicz

Resolution: fixed
Status: newclosed

Docs updated, therefore closing.

Note: See TracTickets for help on using tickets.