Skip to content

Commit 78a9a1f

Browse files
authored
v1.8.1 release (#482)
1 parent 1cb4467 commit 78a9a1f

16 files changed

+15440
-181
lines changed

docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/interfaces/categoricaldomain.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h3>type</h3>
101101
<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>
102102
<aside class="tsd-sources">
103103
<ul>
104-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:170</li>
104+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:175</li>
105105
</ul>
106106
</aside>
107107
<div class="tsd-comment tsd-typography">
@@ -118,7 +118,7 @@ <h3>values</h3>
118118
<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>
119119
<aside class="tsd-sources">
120120
<ul>
121-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:174</li>
121+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:179</li>
122122
</ul>
123123
</aside>
124124
<div class="tsd-comment tsd-typography">

docs/interfaces/categoricalfilter.html

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,15 @@ <h3>applied<wbr>Values</h3>
118118
<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>
119119
<aside class="tsd-sources">
120120
<ul>
121-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:53</li>
121+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:55</li>
122122
</ul>
123123
</aside>
124124
<div class="tsd-comment tsd-typography">
125125
<dl class="tsd-comment-tags">
126126
<dt>returns</dt>
127-
<dd><p>A list of values applied to this categorical filter</p>
127+
<dd><p>A list of values applied to this categorical filter. Notice that if this is a
128+
dependent filter, the current relavent values can be fetched by calling
129+
<code>getDomainAsync(tableau.FilterDomainType.Relevant)</code>.</p>
128130
</dd>
129131
</dl>
130132
</div>
@@ -209,13 +211,13 @@ <h3>is<wbr>Exclude<wbr>Mode</h3>
209211
<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>
210212
<aside class="tsd-sources">
211213
<ul>
212-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:58</li>
214+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:60</li>
213215
</ul>
214216
</aside>
215217
<div class="tsd-comment tsd-typography">
216218
<dl class="tsd-comment-tags">
217219
<dt>returns</dt>
218-
<dd><p>True if this filter is an exlucde filter, false if include filter.</p>
220+
<dd><p>True if this filter is an exclude filter, false if an include filter.</p>
219221
</dd>
220222
</dl>
221223
</div>
@@ -251,7 +253,7 @@ <h3>get<wbr>Domain<wbr>Async</h3>
251253
<li class="tsd-description">
252254
<aside class="tsd-sources">
253255
<ul>
254-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:63</li>
256+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:68</li>
255257
</ul>
256258
</aside>
257259
<div class="tsd-comment tsd-typography">
@@ -263,7 +265,10 @@ <h5><span class="tsd-flag ts-flagOptional">Optional</span> domainType: <a href="
263265
</li>
264266
</ul>
265267
<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>
266-
<p>a promise containing the categorical domain for the filter</p>
268+
<p>a promise containing the categorical domain for the filter. Note if a filter contains
269+
multiple fields (such as a filter action with multiple fields), the values array in the returned
270+
CategoricalDomain (<a href="categoricaldomain.html#values">CategoricalDomain.values</a>) will be empty. If there are multiple fields
271+
in the filter, the results need to be represented by a table, which is not currently supported.</p>
267272
</li>
268273
</ul>
269274
</section>

docs/interfaces/datasource.html

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,6 @@ <h3>Methods</h3>
102102
<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>
103103
<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>
104104
<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>
105-
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="datasource.html#publishedurl" class="tsd-kind-icon">published<wbr>Url</a></li>
106105
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="datasource.html#refreshasync" class="tsd-kind-icon">refresh<wbr>Async</a></li>
107106
</ul>
108107
</section>
@@ -419,37 +418,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
419418
</li>
420419
</ul>
421420
</section>
422-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
423-
<a name="publishedurl" class="tsd-anchor"></a>
424-
<h3>published<wbr>Url</h3>
425-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
426-
<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>
427-
</ul>
428-
<ul class="tsd-descriptions">
429-
<li class="tsd-description">
430-
<aside class="tsd-sources">
431-
<ul>
432-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:44</li>
433-
</ul>
434-
</aside>
435-
<div class="tsd-comment tsd-typography">
436-
<dl class="tsd-comment-tags">
437-
<dt>since</dt>
438-
<dd><p>1.7.0 and Tableau 2021.4</p>
439-
</dd>
440-
<dt>hide</dt>
441-
<dd><p>For first class extensions only</p>
442-
</dd>
443-
</dl>
444-
</div>
445-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span>
446-
<span class="tsd-signature-symbol"> | </span>
447-
<span class="tsd-signature-type">undefined</span>
448-
</h4>
449-
<p>URL of data source if published to server, undefined otherwise. Always undefined prior to Tableau 2021.4.</p>
450-
</li>
451-
</ul>
452-
</section>
453421
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
454422
<a name="refreshasync" class="tsd-anchor"></a>
455423
<h3>refresh<wbr>Async</h3>
@@ -531,9 +499,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
531499
<li class=" tsd-kind-method tsd-parent-kind-interface">
532500
<a href="datasource.html#getunderlyingdataasync" class="tsd-kind-icon">get<wbr>Underlying<wbr>Data<wbr>Async</a>
533501
</li>
534-
<li class=" tsd-kind-method tsd-parent-kind-interface">
535-
<a href="datasource.html#publishedurl" class="tsd-kind-icon">published<wbr>Url</a>
536-
</li>
537502
<li class=" tsd-kind-method tsd-parent-kind-interface">
538503
<a href="datasource.html#refreshasync" class="tsd-kind-icon">refresh<wbr>Async</a>
539504
</li>

docs/interfaces/filteroptions.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3>is<wbr>Exclude<wbr>Mode</h3>
100100
<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>
101101
<aside class="tsd-sources">
102102
<ul>
103-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:123</li>
103+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:128</li>
104104
</ul>
105105
</aside>
106106
<div class="tsd-comment tsd-typography">

docs/interfaces/rangedomain.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>max</h3>
102102
<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>
103103
<aside class="tsd-sources">
104104
<ul>
105-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:160</li>
105+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:165</li>
106106
</ul>
107107
</aside>
108108
<div class="tsd-comment tsd-typography">
@@ -119,7 +119,7 @@ <h3>min</h3>
119119
<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>
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:156</li>
122+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:161</li>
123123
</ul>
124124
</aside>
125125
<div class="tsd-comment tsd-typography">
@@ -136,7 +136,7 @@ <h3>type</h3>
136136
<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>
137137
<aside class="tsd-sources">
138138
<ul>
139-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:152</li>
139+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:157</li>
140140
</ul>
141141
</aside>
142142
<div class="tsd-comment tsd-typography">

docs/interfaces/rangefilter.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ <h3>include<wbr>Null<wbr>Values</h3>
173173
<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>
174174
<aside class="tsd-sources">
175175
<ul>
176-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:83</li>
176+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:88</li>
177177
</ul>
178178
</aside>
179179
<div class="tsd-comment tsd-typography">
@@ -190,7 +190,7 @@ <h3>max<wbr>Value</h3>
190190
<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>
191191
<aside class="tsd-sources">
192192
<ul>
193-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:78</li>
193+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:83</li>
194194
</ul>
195195
</aside>
196196
<div class="tsd-comment tsd-typography">
@@ -207,7 +207,7 @@ <h3>min<wbr>Value</h3>
207207
<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>
208208
<aside class="tsd-sources">
209209
<ul>
210-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:73</li>
210+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:78</li>
211211
</ul>
212212
</aside>
213213
<div class="tsd-comment tsd-typography">
@@ -249,7 +249,7 @@ <h3>get<wbr>Domain<wbr>Async</h3>
249249
<li class="tsd-description">
250250
<aside class="tsd-sources">
251251
<ul>
252-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:89</li>
252+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:94</li>
253253
</ul>
254254
</aside>
255255
<div class="tsd-comment tsd-typography">

docs/interfaces/rangefilteroptions.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max</h3>
102102
<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>
103103
<aside class="tsd-sources">
104104
<ul>
105-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:131</li>
105+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:136</li>
106106
</ul>
107107
</aside>
108108
</section>
@@ -112,7 +112,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> min</h3>
112112
<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>
113113
<aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:130</li>
115+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:135</li>
116116
</ul>
117117
</aside>
118118
</section>
@@ -122,7 +122,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> null<wbr>Option</h3>
122122
<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>
123123
<aside class="tsd-sources">
124124
<ul>
125-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:132</li>
125+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:137</li>
126126
</ul>
127127
</aside>
128128
</section>

docs/interfaces/relativedatefilter.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h3>anchor<wbr>Date</h3>
111111
<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>
112112
<aside class="tsd-sources">
113113
<ul>
114-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:96</li>
114+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:101</li>
115115
</ul>
116116
</aside>
117117
<div class="tsd-comment tsd-typography">
@@ -183,7 +183,7 @@ <h3>period<wbr>Type</h3>
183183
<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>
184184
<aside class="tsd-sources">
185185
<ul>
186-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:101</li>
186+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:106</li>
187187
</ul>
188188
</aside>
189189
<div class="tsd-comment tsd-typography">
@@ -200,7 +200,7 @@ <h3>rangeN</h3>
200200
<div class="tsd-signature tsd-kind-icon">rangeN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
201201
<aside class="tsd-sources">
202202
<ul>
203-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:111</li>
203+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:116</li>
204204
</ul>
205205
</aside>
206206
<div class="tsd-comment tsd-typography">
@@ -217,7 +217,7 @@ <h3>range<wbr>Type</h3>
217217
<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>
218218
<aside class="tsd-sources">
219219
<ul>
220-
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:106</li>
220+
<li>Defined in packages/api-external-contract-js/src/ExternalContract/Shared/FilterInterfaces.ts:111</li>
221221
</ul>
222222
</aside>
223223
<div class="tsd-comment tsd-typography">
File renamed without changes.

0 commit comments

Comments
 (0)