(DOCSP-39067) Adds pre-filters to embedded charts and dashboards and fixes the TOC (#665)

* (DOCSP-39067) Adds pre-filters to embedded charts and dashboards

Author: JuliaMongo

snooty.toml

@@ -6,14 +6,20 @@ intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv",
 
 toc_landing_pages = ["/installation", "/dashboards", 
                      "/data-sources", 
-                     "/administration", "/build-charts", "/launch-charts", 
+                     "/administration", "/build-charts", "/launch-charts",
+                     "/tutorials",
+                     "/reshape-data",
+                     "/build-charts-reference",
                      "/tutorial/order-data/order-data-tutorial-overview", 
                      "/tutorial/movie-details/movie-details-tutorial-overview", 
                      "/chart-types", "/chart-type-reference/data-table", 
                      "/chart-type-reference/geo-spatial", 
                      "/chart-type-reference/column-bar-chart",
                      "/chart-type-reference/choropleth",
-                     "/customize-charts", 
+                     "/chart-type-reference/circular-charts",
+                     "/chart-type-reference/grid-charts",
+                     "/chart-type-reference/text-charts",
+                     "/customize-charts",
                      "/customize-charts/conditional-formatting",
                      "/dashboards/view-dashboard-data",
                      "/embed-charts-and-dashboards",

source/aggregation-pipeline-generation.txt

@@ -6,33 +6,42 @@ Backing Aggregation Pipeline
 
 .. default-domain:: mongodb
 
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
 To get the data needed to render a chart, |charts-short| creates a
-MongoDB Aggregation Pipeline which is executed on the MongoDB database
+MongoDB Aggregation Pipeline and runs the pipeline on the MongoDB database
 server. The pipeline consists of multiple stages, each of which is
 generated based on different settings specified by the chart's author.
+
 This document explains how the various Chart Builder settings are used
 to construct the Aggregation Pipeline. You can view the pipeline used to
 create a chart by choosing the :guilabel:`View Aggregation Pipeline`
 option in the Chart Builder's ellipsis dropdown on the top right.
 
-
-The pipeline constructed by |charts| consists of the following segments in the following order:
+|charts| construct a pipeline that consists of the following segments in
+the following order:
 
 1. :ref:`Charts views <data-sources-pipeline>`
+#. :ref:`Pre-filters in embedding charts <embed-options-pre-filter>`
 #. :ref:`Dashboard filters <filter-dashboards>`
 #. :ref:`Chart query <query-bar>`
 #. :ref:`Lookup fields <add-lookup-field>`
 #. :ref:`Calculated fields <calculated-fields>`
-#. :ref:`Embedding filters <embedded-chart-options>`
+#. :ref:`Embedding filters, including injected filters <embedded-chart-options>`
 #. :ref:`Chart filters <charts-filter-documents>`
 #. :ref:`Encoded fields <encoding-channels>`
 #. :ref:`Sorting <charts-sort-data>`
-#. Maximum document limit
+#. :ref:`Maximum document limit <max-documents-limit>`
 
 .. note::
-   You do not need to configure all of the above settings when creating
-   a chart. Unspecified settings are skipped when generating the
-   aggregation pipeline.
+
+   When creating a chart, you can configure some but not all of the previous
+   chart segments. When |charts-short| generates the aggregation pipeline,
+   it skips unspecified segments.
 
 Example 
 -------

source/chart-type-reference/circular-charts.txt

@@ -6,6 +6,12 @@ Circular Charts
 
 .. default-domain:: mongodb
 
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
 :doc:`/chart-type-reference/donut-chart/`
    .. include:: /includes/donut-blurb.rst
 

source/chart-type-reference/data-table.txt

@@ -13,11 +13,12 @@ Table
    :class: singlecol
 
 Tables represent data in a tabular view, similar to a
-`spreadsheet <https://en.wikipedia.org/wiki/Spreadsheet>`_. Tables
-split your data into categories, with each categorization field
-represented in the table columns. The unique categories are represented
-as the table rows, and |charts-short| displays aggregated values in the
-table body based on the fields selected.
+`spreadsheet <https://en.wikipedia.org/wiki/Spreadsheet>`_. In |charts-short|,
+tables split your data into categories, where:
+
+- Table columns represent categorization fields.
+- Table rows represent unique categories.
+- Table body displays aggregated values based on the selected categorization fields.
 
 Table Encoding Channels
 -----------------------
@@ -85,7 +86,7 @@ Tables are also useful for showing precise data values, rather
 than comparing approximate values. Comparing approximate values is
 best done with a visual representation, instead of text.
 
-You can use tables to show:
+For example, you can use tables to show:
 
 - The total cost to rent an apartment, including rent, cleaning fees,
   and security deposits organized by location and total area of the

source/chart-type-reference/grid-charts.txt

@@ -6,6 +6,14 @@ Grid Charts
 
 .. default-domain:: mongodb
 
+:ref:`heatmap-chart-ref`
+  Learn how |charts| represents data in a tabular format as a range of color
+  on a heatmap.
+
+:ref:`scatter-chart-ref`
+  Learn how |charts| creates scatter charts to plot data with individual
+  data points placed along the X and Y axes.
+
 .. toctree::
    :titlesonly:
 

source/chart-type-reference/text-charts.txt

@@ -8,6 +8,20 @@ Text Charts
 
 .. default-domain:: mongodb
 
+:ref:`data-table-ref`
+  Use tables to represent data in a tabular view, similar to a spreadsheet.
+
+:ref:`number-chart-ref`
+  Use number charts to display a single aggregated value from a data field.
+
+:ref:`word-cloud-ref`
+  Use word clouds to visually represent text data, highlighting prevalent
+  keywords and phrases.
+
+:ref:`top-item-ref`
+  Use Top Item charts to show information from the document with the
+  greatest or smallest value for a specified field.
+
 .. toctree::
    :titlesonly:
 

source/chart-types.txt

@@ -146,6 +146,8 @@ other forms of data to create map-based charts.
    :figwidth: 525px
    :alt: Geospatial heatmap example
 
+.. _max-documents-limit:
+
 Maximum Document Limit
 ----------------------
 

source/charts-embedding-sdk.txt

@@ -18,6 +18,7 @@ adjustments to chart settings and rendering.
 
 You can use the embedding SDK to do the following tasks:
 
+- Add pre-filters before building charts
 - Add filters dynamically
 - Change the size, style, and axes of the chart
 - Change the legend position and legend angle
@@ -34,7 +35,7 @@ To embed a chart with the SDK, you need to:
 #. Allow :ref:`embedded chart filtering <embed-options-filter>` on 
    certain fields by :ref:`specifying filterable fields 
    <specify-filter-fields>`. Don't include fields that may reveal 
-   sensitive data. 
+   sensitive data.
 #. Have the chart ID and base URL strings.
 
 To learn more, see :ref:`get-started-embedding-sdk`.

source/embedded-charts-options/embedded-sdk.txt

@@ -110,6 +110,11 @@ The ``createChart()`` method takes the following options:
      - Unique identifier of the chart.
      - yes
 
+   * - ``preFilter``
+     - object
+     - :ref:`Pre-Filter <embed-options-pre-filter>` to apply to the chart. Pre-filters run before the chart's query execution starts.
+     - no
+
    * - ``filter``
      - object
      - :ref:`Filter <embed-options-filter>` to apply to the chart.
@@ -221,6 +226,19 @@ omitted, charts don't automatically refresh.
 Use this method with the ``setMaxDataAge`` method to
 configure how often the chart refreshes.
 
+``setPreFilter(object)``
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Applies a :ref:`query pre-filter <pre-filter-embedded-charts>` to the
+embedded chart or chart within an :ref:`embedded dashboard <embedding-dashboards>`.
+This method takes an object with valid query operators. Add fields
+referenced in this pre-filter to the :guilabel:`Allowed filter fields` list
+in the ``Embed Chart`` modal window. An empty document ``{}`` means you
+omit the pre-filter.
+
+To learn more about enabling embedding for a chart and applying pre-filters,
+see the :ref:`Embedding Tutorials <embedding-tutorials>`.
+
 ``setFilter(object)``
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -233,9 +251,8 @@ added to the :guilabel:`Allowed filter fields`
 list in the ``Embed Chart`` modal window.
 An empty document ``{}`` is equivalent to no filter.
 
-See the :ref:`Embedding Tutorials <embedding-tutorials>` for
-more information about enabling embedding for a chart 
-and allowing fields for filter use.
+To learn more about enabling embedding for a chart and applying filters,
+see the :ref:`Embedding Tutorials <embedding-tutorials>`.
 
 ``setMaxDataAge(number)``
 ~~~~~~~~~~~~~~~~~~~~~~~~~