Skip to content

Commit

Permalink
Build updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@jlord
jlord committed Jul 27, 2018
1 parent 8297019 commit 4dd2295
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 14 deletions.
16 changes: 8 additions & 8 deletions docs/sheetsee-core.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h2 id="working-with-your-data">Working With Your Data</h2>
<p>Sheetsee pairs with <a href="https://github.com/jsoma/tabletop">Tabletop.js</a> which will fetch the data from your spreadsheet and return it as an <em>array of objects</em>. You&#39;ll use these methods from Sheetsee after you have that data.</p>
<h2 id="methods">Methods</h2>
<p>Here are the functions you can use!</p>
<h3 id="-sheetsee-getkeywordcount-data-keyword-"><code>Sheetsee.getKeywordCount(data, keyword)</code></h3>
<h3 id="sheetsee-getkeywordcount-data-keyword-"><code>Sheetsee.getKeywordCount(data, keyword)</code></h3>
<ul>
<li><code>data</code> <em>array of objects</em></li>
<li><code>keyword</code> <em>string</em></li>
Expand All @@ -31,7 +31,7 @@ <h3 id="-sheetsee-getkeywordcount-data-keyword-"><code>Sheetsee.getKeywordCount(
<pre><code class="lang-javascript">getGroupCount(data, &#39;cat&#39;)
// returns a number
</code></pre>
<h3 id="-sheetsee-getkeyword-data-keyword-"><code>Sheetsee.getKeyword(data, keyword)</code></h3>
<h3 id="sheetsee-getkeyword-data-keyword-"><code>Sheetsee.getKeyword(data, keyword)</code></h3>
<ul>
<li><code>data</code> <em>array of objects</em></li>
<li><code>keyword</code> <em>string</em></li>
Expand All @@ -41,7 +41,7 @@ <h3 id="-sheetsee-getkeyword-data-keyword-"><code>Sheetsee.getKeyword(data, keyw
<pre><code class="lang-javascript">getKeyword(data, &#39;cat&#39;)
// returns array of objects
</code></pre>
<h3 id="-sheetsee-getcolumntotal-data-column-"><code>Sheetsee.getColumnTotal(data, column)</code></h3>
<h3 id="sheetsee-getcolumntotal-data-column-"><code>Sheetsee.getColumnTotal(data, column)</code></h3>
<ul>
<li><code>data</code> <em>array of objects</em></li>
<li><code>column</code> <em>string</em></li>
Expand All @@ -52,7 +52,7 @@ <h3 id="-sheetsee-getcolumntotal-data-column-"><code>Sheetsee.getColumnTotal(dat
<pre><code class="lang-javascript">getColumnTotal(data, &#39;cuddlability&#39;)
// returns number
</code></pre>
<h3 id="-sheetsee-getcolumnaverage-data-column-"><code>Sheetsee.getColumnAverage(data, column)</code></h3>
<h3 id="sheetsee-getcolumnaverage-data-column-"><code>Sheetsee.getColumnAverage(data, column)</code></h3>
<ul>
<li><code>data</code> <em>array of objects</em></li>
<li><code>column</code> <em>string</em></li>
Expand All @@ -62,7 +62,7 @@ <h3 id="-sheetsee-getcolumnaverage-data-column-"><code>Sheetsee.getColumnAverage
<pre><code class="lang-javascript">getColumnAverage(data, &#39;cuddlability&#39;)
// returns number
</code></pre>
<h3 id="-sheetsee-getmin-data-column-"><code>Sheetsee.getMin(data, column)</code></h3>
<h3 id="sheetsee-getmin-data-column-"><code>Sheetsee.getMin(data, column)</code></h3>
<ul>
<li><code>data</code> <em>array of objects</em></li>
<li><code>column</code> <em>string</em></li>
Expand All @@ -72,7 +72,7 @@ <h3 id="-sheetsee-getmin-data-column-"><code>Sheetsee.getMin(data, column)</code
<pre><code class="lang-javascript">getMin(data, &#39;cuddlability&#39;)
// returns array
</code></pre>
<h3 id="-sheetsee-getmax-data-column-"><code>Sheetsee.getMax(data, column)</code></h3>
<h3 id="sheetsee-getmax-data-column-"><code>Sheetsee.getMax(data, column)</code></h3>
<ul>
<li><code>data</code> <em>array of objects</em></li>
<li><code>column</code> <em>string</em></li>
Expand All @@ -82,7 +82,7 @@ <h3 id="-sheetsee-getmax-data-column-"><code>Sheetsee.getMax(data, column)</code
<pre><code class="lang-javascript">getMin(data, &#39;cuddlability&#39;)
// returns array of objects
</code></pre>
<h3 id="-sheetsee-getmatches-data-filter-column-"><code>Sheetsee.getMatches(data, filter, column)</code></h3>
<h3 id="sheetsee-getmatches-data-filter-column-"><code>Sheetsee.getMatches(data, filter, column)</code></h3>
<ul>
<li><code>data</code> <em>array of objects</em></li>
<li><code>filter</code> <em>string</em></li>
Expand All @@ -94,7 +94,7 @@ <h3 id="-sheetsee-getmatches-data-filter-column-"><code>Sheetsee.getMatches(data
// returns array of objects
// [{&#39;name&#39;: &#39;coco&#39;, &#39;kind&#39;: &#39;dog&#39;...}, {&#39;name&#39;: &#39;wolfgang&#39;, &#39;kind&#39;: &#39;dog&#39;...},{&#39;name&#39;: &#39;cooc&#39;, &#39;kind&#39;: &#39;dog&#39;...} ]
</code></pre>
<h3 id="-sheetsee-getoccurance-data-column-"><code>Sheetsee.getOccurance(data, column)</code></h3>
<h3 id="sheetsee-getoccurance-data-column-"><code>Sheetsee.getOccurance(data, column)</code></h3>
<ul>
<li><code>data</code> <em>array of objects</em></li>
<li><code>column</code> <em>string</em></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/sheetsee-maps.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h2 id="to-use">To Use</h2>
<p>You&#39;ll create a little bit of HTML and then some JavaScript in your HTML to use this. You can customize marker color, popup content and enable/disable clustering in your map.</p>
<h2 id="methods">Methods</h2>
<p>Here are the functions you can use!</p>
<h3 id="-sheetsee-creategeojson-data-optionsjson-"><code>Sheetsee.createGeoJSON(data, optionsJSON)</code></h3>
<h3 id="sheetsee-creategeojson-data-optionsjson-"><code>Sheetsee.createGeoJSON(data, optionsJSON)</code></h3>
<ul>
<li><strong>data</strong> <em>JSON array</em> of data</li>
<li><strong>optionsJSON</strong> <em>array</em> of strings, spreadsheet column title</li>
Expand All @@ -52,7 +52,7 @@ <h3 id="-sheetsee-creategeojson-data-optionsjson-"><code>Sheetsee.createGeoJSON(
var geoJSON = Sheetsee.createGeoJSON(data, optionsJSON)
</code></pre>
<p>It will return an <em>array</em> in the special <a href="http://geojson.org">geoJSON format</a> that map making things love.</p>
<h3 id="-sheetsee-loadmap-options-"><code>Sheetsee.loadMap(options)</code></h3>
<h3 id="sheetsee-loadmap-options-"><code>Sheetsee.loadMap(options)</code></h3>
<p>This method will generate a map for you on the page (it also generates the geoJSON for the map).</p>
<ul>
<li><strong>options</strong> <em>object</em> <strong>required</strong><ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/sheetsee-tables.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ <h2 id="your-script">Your Script</h2>
<p>You&#39;ll want to set your table options and pass them into <code>Sheetsee.makeTable()</code>. If you want to add a search/filter, pass your options into <code>Sheetsee.initiateTableFilter()</code>.</p>
<h2 id="methods">Methods</h2>
<p>Functions for you to use! There are just two, woo!</p>
<h3 id="-sheetsee-maketable-tableoptions-"><code>Sheetsee.makeTable(tableOptions)</code></h3>
<h3 id="sheetsee-maketable-tableoptions-"><code>Sheetsee.makeTable(tableOptions)</code></h3>
<p>You pass in an object containing:</p>
<ul>
<li><code>data</code> <em>array</em> your data from Tabletop.js <strong>required</strong></li>
Expand Down Expand Up @@ -70,7 +70,7 @@ <h4 id="pagination">Pagination</h4>
.pagination-pre {}
.no-pag {}
</code></pre>
<h3 id="-sheetsee-initiatetablefilter-tableoptions-"><code>Sheetsee.initiateTableFilter(tableOptions)</code></h3>
<h3 id="sheetsee-initiatetablefilter-tableoptions-"><code>Sheetsee.initiateTableFilter(tableOptions)</code></h3>
<p>If you want to have an input to allow users to search/filter the data in the table, you&#39;ll add an input to your HTML. Give it an id and if you want add placeholder text. You&#39;ll also need to add a &#39;clear&#39; button using the <code>.clear</code> CSS class.</p>
<pre><code class="lang-javascript">&lt;input id=&quot;tableFilter&quot; type=&quot;text&quot; placeholder=&quot;filter by..&quot;&gt;&lt;/input&gt;
&lt;a href=&quot;#&quot; class=&quot;.clear&quot;&gt;Clear&lt;/a&gt;
Expand Down
3 changes: 1 addition & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,5 @@
"mustache": "^2.3.0",
"path": "~0.4.9"
},
"devDependencies": {
}
"devDependencies": {}
}

0 comments on commit 4dd2295

Please sign in to comment.