(DOCSP-6315): Enable/disable filters (#227)

Author: jeff-allen-mongo

source/filter-documents.txt

@@ -193,7 +193,7 @@ Select the appropriate tab for more information on the date filter:
          ago from the current date:
 
          .. figure:: /images/charts/relative-date.png
-            :scale: 100%
+            :scale: 70%
             :alt: Image showing relative date filter
 
    .. tab:: Absolute Date Filter
@@ -247,7 +247,7 @@ Select the appropriate tab for more information on the date filter:
          ``2018``:
 
          .. figure:: /images/charts/absolute-date.png
-            :scale: 60%
+            :scale: 70%
             :alt: Image showing absolute date filter
 
          |
@@ -313,6 +313,24 @@ chart.
       :scale: 100%
       :alt: Image showing boolean filter
 
+.. _enable-disable-filter:
+
+Enable or Disable a Filter
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can toggle whether a filter in the :guilabel:`Filter` tab
+is enabled or disabled. Disabled filters do not affect the documents
+which appear in the chart. Disabled filters are grayed out and cannot
+be edited until they are enabled.
+
+To toggle whether a filter is enabled, hover over a filter and
+set the appearing toggle at the top of the filter to the desired
+setting.
+
+.. figure:: /images/charts/filter-tab-disable-toggle.png
+   :scale: 70%
+   :alt: Image showing filter toggle
+
 .. _query-bar:
 
 Query Bar
@@ -322,9 +340,6 @@ The :guilabel:`Query` bar supports more complex queries than
 the filter panel. Additionally, you can use the query bar to create
 :manual:`aggregation pipelines </core/aggregation-pipeline/>` to
 process your data before it is rendered.
-
-Filter Data using the Query Bar
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To filter data using the :guilabel:`Query` bar:
 
@@ -336,28 +351,8 @@ To filter data using the :guilabel:`Query` bar:
 
 #. Click :guilabel:`Apply`.
 
-.. admonition:: Considerations
-   :class: note
-
-   - Filters on large collections may encounter performance issues if
-     the collection is not appropriately :manual:`indexed <indexes>`.
-
-   - The date functions utilized in the |charts| query bar are
-     consistent and compatible with the date functions used in the
-     :manual:`mongo shell </mongo>`. As a result, you can use:
-
-     - ``new Date()``,
-     - ``ISODate()``, or
-     - ``new ISODate()``.
-
-     |
-
-     The ``Date()`` function (as opposed to the ``new Date()``
-     constructor) returns the current date as a string, so it cannot be
-     used for querying dates in |charts-short|.
-
 Element Query Example
-`````````````````````
+~~~~~~~~~~~~~~~~~~~~~
 
 The following chart shows the average Metacritic ratings of movies
 over time :ref:`binned <charts-bin-data>` by 5 year periods.
@@ -380,7 +375,7 @@ checking that the second array element exists.
 .. _regex-filter:
 
 Regular Expression (RegEx) Query Example
-````````````````````````````````````````
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. _`regular expression`: :manual:`
 
@@ -413,7 +408,7 @@ letter ``A`` or ``a``, you would write the following in the
    { "jobs" : { $regex : "^A", $options : "i" } }
 
 Date Query Example
-``````````````````
+~~~~~~~~~~~~~~~~~~
 
 The following chart shows total sale amounts from an office supply
 company, categorized by purchase method:
@@ -443,26 +438,44 @@ This query restricts the documents shown to only those with
 a ``saleDate`` equal to or more recent than ``January 1, 2017`` with at
 least 5 elements in the ``items`` array.
 
+Considerations
+~~~~~~~~~~~~~~
+
+- Filters on large collections may encounter performance issues if
+  the collection is not appropriately :manual:`indexed <indexes>`.
+
+- The date functions utilized in the |charts| query bar are
+  consistent and compatible with the date functions used in the
+  :manual:`mongo shell </mongo>`. As a result, you can use:
+
+  - ``new Date()``,
+  - ``ISODate()``, or
+  - ``new ISODate()``.
+
+  The ``Date()`` function (as opposed to the ``new Date()``
+  constructor) returns the current date as a string, so it cannot be
+  used for querying dates in |charts-short|.
+
 .. _charts-agg-pipeline:
 
 Create Aggregation Pipelines
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+----------------------------
 
 :manual:`Aggregation pipelines </core/aggregation-pipeline/>` transform
 your documents into an aggregated set of results. In |charts|,
 aggregation pipelines are commonly used to visualize new fields created
 from calculated results of pre-existing fields, but also have many other
 applications.
 
-To create an aggregation pipeline in the :guilabel:`Query` bar:
+To create an aggregation pipeline:
 
 1. In the :guilabel:`Query` bar, input an aggregation pipeline. Your
    pipeline must be in square brackets.
 
 #. Click :guilabel:`Apply` to execute your pipeline.
 
-Aggregation Pipeline Example
-````````````````````````````
+Example
+~~~~~~~
 
 The following chart shows total sale amounts from an office supply
 company, categorized by store location. The chart utilizes the
@@ -506,7 +519,7 @@ chart displays the the :guilabel:`Sum` of all
 ``saleAmounts`` categorized by store location.
 
 Limitations
-```````````
+~~~~~~~~~~~
 
 The :pipeline:`$lookup` operator is not supported in the
 aggregation pipeline builder.