knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[doc][s]: minor correction to model docs.

Browse Source
This commit is contained in:
Rufus Pollock
2012-03-15 00:47:32 +00:00
parent 8762b9a862
commit 93d4b84080
2 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/model.html
View File

@@ -3,15 +3,14 @@
<span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">$</span><span class="p">,</span> <span class="nx">my</span><span class="p">)</span> <span class="p">{</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h2>A Dataset model</h2> <span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">$</span><span class="p">,</span> <span class="nx">my</span><span class="p">)</span> <span class="p">{</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h2>A Dataset model</h2>
<p>A model must have the following (Backbone) attributes:</p> <p>A model has the following (non-Backbone) attributes:</p>
<ul> <ul>
<li>fields: (aka columns) is a FieldList listing all the fields on this <li>fields: (aka columns) is a FieldList listing all the fields on this
Dataset (this can be set explicitly, or, on fetch() of Dataset Dataset (this can be set explicitly, or, will be set by Dataset.fetch() or Dataset.query()</li>
information from the backend, or as is perhaps most common on the first <li>currentDocuments: a DocumentList containing the Documents we have
query)</li> currently loaded for viewing (you update currentDocuments by calling query)</li>
<li>currentDocuments: a DocumentList containing the Documents we have currently loaded for viewing (you update currentDocuments by calling getRows)</li> <li>docCount: total number of documents in this dataset</li>
<li>docCount: total number of documents in this dataset (obtained on a fetch for this Dataset)</li>
</ul> </td> <td class="code"> <div class="highlight"><pre><span class="nx">my</span><span class="p">.</span><span class="nx">Dataset</span> <span class="o">=</span> <span class="nx">Backbone</span><span class="p">.</span><span class="nx">Model</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span> </ul> </td> <td class="code"> <div class="highlight"><pre><span class="nx">my</span><span class="p">.</span><span class="nx">Dataset</span> <span class="o">=</span> <span class="nx">Backbone</span><span class="p">.</span><span class="nx">Model</span><span class="p">.</span><span class="nx">extend</span><span class="p">({</span>
<span class="nx">__type__</span><span class="o">:</span> <span class="s1">&#39;Dataset&#39;</span><span class="p">,</span> <span class="nx">__type__</span><span class="o">:</span> <span class="s1">&#39;Dataset&#39;</span><span class="p">,</span>
<span class="nx">initialize</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">model</span><span class="p">,</span> <span class="nx">backend</span><span class="p">)</span> <span class="p">{</span> <span class="nx">initialize</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">model</span><span class="p">,</span> <span class="nx">backend</span><span class="p">)</span> <span class="p">{</span>

11
src/model.js
View File

@@ -6,14 +6,13 @@ this.recline.Model = this.recline.Model || {};
// ## A Dataset model // ## A Dataset model
// //
// A model must have the following (Backbone) attributes: // A model has the following (non-Backbone) attributes:
// //
// * fields: (aka columns) is a FieldList listing all the fields on this // * fields: (aka columns) is a FieldList listing all the fields on this
// Dataset (this can be set explicitly, or, on fetch() of Dataset // Dataset (this can be set explicitly, or, will be set by Dataset.fetch() or Dataset.query()
// information from the backend, or as is perhaps most common on the first // * currentDocuments: a DocumentList containing the Documents we have
// query) // currently loaded for viewing (you update currentDocuments by calling query)
// * currentDocuments: a DocumentList containing the Documents we have currently loaded for viewing (you update currentDocuments by calling getRows) // * docCount: total number of documents in this dataset
// * docCount: total number of documents in this dataset (obtained on a fetch for this Dataset)
my.Dataset = Backbone.Model.extend({ my.Dataset = Backbone.Model.extend({
__type__: 'Dataset', __type__: 'Dataset',
initialize: function(model, backend) { initialize: function(model, backend) {