Skip to content

Commit 3e40c30

Browse files
(DOCSP-5112): Boolean filter updates (#172)
* (DOCSP-5112): Boolean filter updates * Minor tweak * Updates per Ravind's feedback
1 parent d3110bc commit 3e40c30

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

source/filter-documents.txt

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ options. You can filter fields with the following data types:
4848

4949
- :ref:`Date <filter-date>`
5050

51+
- :ref:`Boolean <filter-boolean>`
52+
5153
.. note::
5254

5355
You cannot use the same field for multiple filters.
@@ -237,6 +239,39 @@ To define an upper bound for your absolute date filter:
237239

238240
The date and time formats used in your bounds depend
239241
on your location, as determined from your browser settings.
242+
243+
244+
.. _filter-boolean:
245+
246+
Filter Boolean Fields
247+
~~~~~~~~~~~~~~~~~~~~~
248+
249+
You can filter the chart data based on the boolean value of a specific
250+
field. Drag a boolean field to the filter panel to view the available
251+
options:
252+
253+
- :guilabel:`True` displays documents where the field value is ``true``.
254+
255+
- :guilabel:`False` displays documents where the field value is
256+
``false``.
257+
258+
- :guilabel:`NULL / MISSING` displays documents where the field is
259+
``null`` or does not exist.
260+
261+
All options are selected by default. The chart preview updates as you
262+
modify the selected options. Deselecting all options renders a blank
263+
chart.
264+
265+
.. example::
266+
267+
A chart using the following filter only displays documents where the
268+
``passed`` field is ``true``. The chart does not display documents
269+
where the ``passed`` field is ``false``, ``null``, or does not
270+
exist.
271+
272+
.. figure:: /images/charts/boolean-filter.png
273+
:scale: 60%
274+
:alt: Image showing boolean filter
240275

241276
.. _query-bar:
242277

26.1 KB
Loading

0 commit comments

Comments
 (0)