Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/assets/js/search.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/interfaces/categoricaldomain.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/tableau.filterdomaintype.html" class="tsd-signature-type">FilterDomainType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:170</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:175</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -118,7 +118,7 @@ <h3>values</h3>
<div class="tsd-signature tsd-kind-icon">values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="datavalue.html" class="tsd-signature-type">DataValue</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:174</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:179</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
17 changes: 11 additions & 6 deletions docs/interfaces/categoricalfilter.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,15 @@ <h3>applied<wbr>Values</h3>
<div class="tsd-signature tsd-kind-icon">applied<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="datavalue.html" class="tsd-signature-type">DataValue</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:53</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:55</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>returns</dt>
<dd><p>A list of values applied to this categorical filter</p>
<dd><p>A list of values applied to this categorical filter. Notice that if this is a
dependent filter, the current relavent values can be fetched by calling
<code>getDomainAsync(tableau.FilterDomainType.Relevant)</code>.</p>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -209,13 +211,13 @@ <h3>is<wbr>Exclude<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Exclude<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:58</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:60</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>returns</dt>
<dd><p>True if this filter is an exlucde filter, false if include filter.</p>
<dd><p>True if this filter is an exclude filter, false if an include filter.</p>
</dd>
</dl>
</div>
Expand Down Expand Up @@ -251,7 +253,7 @@ <h3>get<wbr>Domain<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:63</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:68</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -263,7 +265,10 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> domainType: <a href="
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="categoricaldomain.html" class="tsd-signature-type">CategoricalDomain</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>a promise containing the categorical domain for the filter</p>
<p>a promise containing the categorical domain for the filter. Note if a filter contains
multiple fields (such as a filter action with multiple fields), the values array in the returned
CategoricalDomain (<a href="categoricaldomain.html#values">CategoricalDomain.values</a>) will be empty. If there are multiple fields
in the filter, the results need to be represented by a table, which is not currently supported.</p>
</li>
</ul>
</section>
Expand Down
35 changes: 0 additions & 35 deletions docs/interfaces/datasource.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ <h3>Methods</h3>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="datasource.html#getlogicaltabledataasync" class="tsd-kind-icon">get<wbr>Logical<wbr>Table<wbr>Data<wbr>Async</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="datasource.html#getlogicaltablesasync" class="tsd-kind-icon">get<wbr>Logical<wbr>Tables<wbr>Async</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="datasource.html#getunderlyingdataasync" class="tsd-kind-icon">get<wbr>Underlying<wbr>Data<wbr>Async</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="datasource.html#publishedurl" class="tsd-kind-icon">published<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="datasource.html#refreshasync" class="tsd-kind-icon">refresh<wbr>Async</a></li>
</ul>
</section>
Expand Down Expand Up @@ -419,37 +418,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="publishedurl" class="tsd-anchor"></a>
<h3>published<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">published<wbr>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:44</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>1.7.0 and Tableau 2021.4</p>
</dd>
<dt>hide</dt>
<dd><p>For first class extensions only</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">undefined</span>
</h4>
<p>URL of data source if published to server, undefined otherwise. Always undefined prior to Tableau 2021.4.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="refreshasync" class="tsd-anchor"></a>
<h3>refresh<wbr>Async</h3>
Expand Down Expand Up @@ -531,9 +499,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="datasource.html#getunderlyingdataasync" class="tsd-kind-icon">get<wbr>Underlying<wbr>Data<wbr>Async</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="datasource.html#publishedurl" class="tsd-kind-icon">published<wbr>Url</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="datasource.html#refreshasync" class="tsd-kind-icon">refresh<wbr>Async</a>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/filteroptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3>is<wbr>Exclude<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Exclude<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:123</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:128</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/rangedomain.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3>max</h3>
<div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <a href="datavalue.html" class="tsd-signature-type">DataValue</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:160</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:165</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -119,7 +119,7 @@ <h3>min</h3>
<div class="tsd-signature tsd-kind-icon">min<span class="tsd-signature-symbol">:</span> <a href="datavalue.html" class="tsd-signature-type">DataValue</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:156</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:161</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -136,7 +136,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/tableau.filterdomaintype.html" class="tsd-signature-type">FilterDomainType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:152</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:157</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/rangefilter.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ <h3>include<wbr>Null<wbr>Values</h3>
<div class="tsd-signature tsd-kind-icon">include<wbr>Null<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:83</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:88</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -190,7 +190,7 @@ <h3>max<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Value<span class="tsd-signature-symbol">:</span> <a href="datavalue.html" class="tsd-signature-type">DataValue</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:78</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:83</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -207,7 +207,7 @@ <h3>min<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">min<wbr>Value<span class="tsd-signature-symbol">:</span> <a href="datavalue.html" class="tsd-signature-type">DataValue</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:73</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:78</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -249,7 +249,7 @@ <h3>get<wbr>Domain<wbr>Async</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:89</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:94</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/rangefilteroptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max</h3>
<div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:131</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:136</li>
</ul>
</aside>
</section>
Expand All @@ -112,7 +112,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> min</h3>
<div class="tsd-signature tsd-kind-icon">min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:130</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:135</li>
</ul>
</aside>
</section>
Expand All @@ -122,7 +122,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> null<wbr>Option</h3>
<div class="tsd-signature tsd-kind-icon">null<wbr>Option<span class="tsd-signature-symbol">:</span> <a href="../enums/tableau.filternulloption.html" class="tsd-signature-type">FilterNullOption</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:132</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:137</li>
</ul>
</aside>
</section>
Expand Down
8 changes: 4 additions & 4 deletions docs/interfaces/relativedatefilter.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h3>anchor<wbr>Date</h3>
<div class="tsd-signature tsd-kind-icon">anchor<wbr>Date<span class="tsd-signature-symbol">:</span> <a href="datavalue.html" class="tsd-signature-type">DataValue</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:96</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:101</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -183,7 +183,7 @@ <h3>period<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">period<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/tableau.periodtype.html" class="tsd-signature-type">PeriodType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:101</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:106</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -200,7 +200,7 @@ <h3>rangeN</h3>
<div class="tsd-signature tsd-kind-icon">rangeN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:111</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:116</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -217,7 +217,7 @@ <h3>range<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">range<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/tableau.daterangetype.html" class="tsd-signature-type">DateRangeType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:106</li>
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:111</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading