Skip to content

Commit

Permalink
#1464 - docs update for filtering on boolean values (#1471)
Browse files Browse the repository at this point in the history
Add docs mention of boolean values for filtering
jacalata authored Sep 28, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent 6ec632e commit 9a31004
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions tableauserverclient/server/request_options.py
Original file line number Diff line number Diff line change
@@ -164,13 +164,14 @@ def get_query_params(self):
raise NotImplementedError()

def vf(self, name: str, value: str) -> Self:
"""Apply a filter to the view for a filter that is a normal column
within the view."""
"""Apply a filter based on a column within the view.
Note that when filtering on a boolean type field, the only valid values are 'true' and 'false'"""
self.view_filters.append((name, value))
return self

def parameter(self, name: str, value: str) -> Self:
"""Apply a filter based on a parameter within the workbook."""
"""Apply a filter based on a parameter within the workbook.
Note that when filtering on a boolean type field, the only valid values are 'true' and 'false'"""
self.view_parameters.append((name, value))
return self

0 comments on commit 9a31004

Please sign in to comment.