Skip to content

Updating documentation for version 1.2 of the library #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2019
Merged

Updating documentation for version 1.2 of the library #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/interfaces/datasource.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,4 +439,4 @@ <h2>Legend</h2>
ga('send', 'pageview');
</script>
</body>
</html>
</html>
11 changes: 8 additions & 3 deletions docs/interfaces/datavalue.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ <h3>formatted<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">formatted<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:88</li>
<li>Defined in DataTableInterfaces.ts:91</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -110,14 +110,19 @@ <h3>value</h3>
<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:81</li>
<li>Defined in DataTableInterfaces.ts:84</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>1.2.0 Fixes the type to be the raw native value rather than a string.</p>
</dd>
<dt>returns</dt>
<dd><p>Contains the raw native value as a JavaScript type, which is
one of String, Number, Boolean, or Date.</p>
one of String, Number, Boolean, or Date. Please note that special values,
regardless of type, are always returned as a String surrounded by percent signs,
such as &#39;%null%&#39;, or &#39;%no-access%&#39;.</p>
</dd>
</dl>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/getsummarydataoptions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Aliases</h
<div class="tsd-signature tsd-kind-icon">ignore<wbr>Aliases<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:98</li>
<li>Defined in DataTableInterfaces.ts:101</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -119,7 +119,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Selection<
<div class="tsd-signature tsd-kind-icon">ignore<wbr>Selection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:103</li>
<li>Defined in DataTableInterfaces.ts:106</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/getunderlyingdataoptions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Aliases</h
<aside class="tsd-sources">
<p>Inherited from <a href="getsummarydataoptions.html">GetSummaryDataOptions</a>.<a href="getsummarydataoptions.html#ignorealiases">ignoreAliases</a></p>
<ul>
<li>Defined in DataTableInterfaces.ts:98</li>
<li>Defined in DataTableInterfaces.ts:101</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -123,7 +123,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Selection<
<aside class="tsd-sources">
<p>Inherited from <a href="getsummarydataoptions.html">GetSummaryDataOptions</a>.<a href="getsummarydataoptions.html#ignoreselection">ignoreSelection</a></p>
<ul>
<li>Defined in DataTableInterfaces.ts:103</li>
<li>Defined in DataTableInterfaces.ts:106</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -138,7 +138,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> include<wbr>All<wbr>C
<div class="tsd-signature tsd-kind-icon">include<wbr>All<wbr>Columns<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:113</li>
<li>Defined in DataTableInterfaces.ts:116</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -153,7 +153,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Rows</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Rows<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:120</li>
<li>Defined in DataTableInterfaces.ts:123</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
12 changes: 6 additions & 6 deletions docs/interfaces/pageddata.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:145</li>
<li>Defined in DataTableInterfaces.ts:148</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -131,7 +131,7 @@ <h3>has<wbr>More<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">has<wbr>More<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:165</li>
<li>Defined in DataTableInterfaces.ts:168</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -146,7 +146,7 @@ <h3>page</h3>
<div class="tsd-signature tsd-kind-icon">page<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:155</li>
<li>Defined in DataTableInterfaces.ts:158</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -161,7 +161,7 @@ <h3>page<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">page<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:150</li>
<li>Defined in DataTableInterfaces.ts:153</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -176,7 +176,7 @@ <h3>total</h3>
<div class="tsd-signature tsd-kind-icon">total<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:160</li>
<li>Defined in DataTableInterfaces.ts:163</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -198,7 +198,7 @@ <h3>get<wbr>Next<wbr>Page<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:172</li>
<li>Defined in DataTableInterfaces.ts:175</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/interfaces/paginationoptions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ <h3>page<wbr>Number</h3>
<div class="tsd-signature tsd-kind-icon">page<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:135</li>
<li>Defined in DataTableInterfaces.ts:138</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -114,7 +114,7 @@ <h3>page<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">page<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in DataTableInterfaces.ts:130</li>
<li>Defined in DataTableInterfaces.ts:133</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
7 changes: 4 additions & 3 deletions docs/interfaces/worksheet.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@ <h3>select<wbr>Marks<wbr>ByValue<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in SheetInterfaces.ts:373</li>
<li>Defined in SheetInterfaces.ts:374</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -699,11 +699,12 @@ <h5>updateType: <a href="../enums/selectionupdatetype.html" class="tsd-signature
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Empty promise that resolves when the selection is complete.</p>
<p>The following example shows how you might call this method using state names as the <code>SelectionCriteria</code>.
The <code>SelectionUpdateType</code> is replace (<code>SelectionUpdateType.Replace</code>), so these values replace the marks that are currently selected.</p>
The <code>SelectionUpdateType</code> is replace (<code>tableau.SelectionUpdateType.Replace</code>), so these values replace
the marks that are currently selected.</p>
<pre><code> <span class="hljs-selector-tag">worksheet</span><span class="hljs-selector-class">.selectMarksByValueAsync</span>([{
<span class="hljs-attribute">fieldName</span>: <span class="hljs-string">'State'</span>,
<span class="hljs-attribute">value</span>: [<span class="hljs-string">'Texas'</span>, <span class="hljs-string">'Washington'</span>, <span class="hljs-string">'California'</span>]
}], <span class="hljs-selector-tag">SelectionUpdateType</span><span class="hljs-selector-class">.Replace</span> );
}], <span class="hljs-selector-tag">tableau</span><span class="hljs-selector-class">.SelectionUpdateType</span><span class="hljs-selector-class">.Replace</span> );

</code></pre>
</li>
Expand Down