@@ -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 "> <</ span > < a href ="datavalue.html " class ="tsd-signature-type "> DataValue</ a > < span class ="tsd-signature-symbol "> ></ 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 "> <</ span > < a href ="categoricaldomain.html " class ="tsd-signature-type "> CategoricalDomain</ a > < span class ="tsd-signature-symbol "> ></ 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 >
0 commit comments