Skip to content

Commit ba3f387

Browse files
authored
docs: note vf() view filters are exact-match only (#1835)
1 parent c9dbe91 commit ba3f387

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

docs/api-ref.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5595,6 +5595,8 @@ You can use the `Sort` and `RequestOptions` classes to filter and sort the follo
55955595

55965596
You can use the `ImageRequestOptions` and `PDFRequestOptions` to set options for views returned as images and PDF files.
55975597

5598+
**Note**: View filters set via `vf()` on `CSVRequestOptions`, `ImageRequestOptions`, or `PDFRequestOptions` apply exact-match only. Operators like greater-than, less-than, contains, or value ranges are not supported by the underlying REST endpoint. See the Tableau REST API [filtering documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm) for the server-side detail. If you need range filtering for exports, expose the range bounds as workbook parameters and use `.parameter()` to set them.
5599+
55985600
For more information about filtering and sorting, see [Filter and Sort](filter-sort).
55995601

56005602

0 commit comments

Comments
 (0)