1.29 release (#516)

* (DOCSP-18613) (DOCSP-18614) (DOCSP-18615) (DOCSP-18616) (DOCSP-19011) (DOCSP-19074) Interactive filtering (#510)

* (DOCSP-18613-fix) Fix a typo (#512)

* (DOCSP-19586) Improve Handle Click Events page (#514)

* (DOCSP-19871) New interactive filtering options (#515)

* (DOCSP-19625) 1.29 release notes (#513)

Author: zach-carr

source/dashboard-filtering.txt

@@ -40,10 +40,10 @@ default filter values.
    :alt: An image of a dashboard. The :guilabel:`Dashboard Filters`
          pane is highlighted. 
 
-If one or more dashboard filters are applied to a chart, a 
+If one or more dashboard filters affect the data a chart displays, an 
 :icon-fa5:`filter` icon displays in the bottom left corner of that 
 chart. Hover over the :icon-fa5:`filter` icon for a list of the 
-filtered fields on that chart.
+filtered fields impacting that chart.
 
 .. note::
 
@@ -85,15 +85,15 @@ unless you :ref:`reset a filter <revert-dashboard-filters>`.
 
    |charts-short| doesn't persist filter states or values for users who
    open a dashboard using a public link. |charts-short| reverts to the 
-   initial default filter values after refreshing the page or starting a 
-   new session.
+   initial default filter values after refreshing the page or starting 
+   a new session.
 
 The :guilabel:`Dashboard Filters` Pane
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The :guilabel:`Dashboard Filters` icon indicates the number of active 
 filters. Click the icon to expand the :guilabel:`Dashboard Filters` 
-pane. 
+pane.
 
 .. figure:: /images/charts/expand-filter-pane.png
    :figwidth: 720px
@@ -267,34 +267,34 @@ Disable Dashboard Filters for a Chart
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can disable filtering for a specific chart if you create at least 
-one dashboard filter on the chart's data source. If you disable 
-filtering, the chart is exempted from all dashboard filters. The 
-default selection for all charts is 
-:guilabel:`Respond to dashboard filters`.
+one dashboard filter on the chart's data source. If you disable
+filtering, the chart is exempted from all dashboard filters and 
+highlighting. The default selection for all charts is 
+:guilabel:`Filter or highlight`.
 
 To disable dashboard filtering for a chart:
 
 1. Hover over the chart on the dashboard to reveal four buttons in the 
    upper right corner of the chart.
 #. Click the second button (for :guilabel:`Interactive Filters`) and
-   select :guilabel:`Ignore dashboard filters` from the dropdown. 
+   select :guilabel:`Ignore` from the dropdown. 
 
 .. note::
 
    You can't change this setting until you've created at least one 
    dashboard filter on the chart's data source.
 
-Once you disable filtering, the :guilabel:`Interactive Filters`
+Once you ignore filtering, the :guilabel:`Interactive Filters`
 button icon on the chart changes for all users. Users with the 
 ``Viewer`` role can also see a tooltip if they click the 
-:guilabel:`Interactive Filters` button, which says 
-":guilabel:`The dashboard owner has not enabled filtering for
+:guilabel:`Interactive Filters` button,
+which says ":guilabel:`The dashboard owner has not enabled filtering for
 this chart`."
 
 To reenable dashboard filtering for a chart:
 
 1. Click the :guilabel:`Interactive Filters` button.
-2. Select :guilabel:`Respond to dashboard filters` from the dropdown. 
+2. Select :guilabel:`Filter` from the dropdown.
 
 Use Dashboard Filters
 ----------------------

source/handle-click-events.txt

@@ -15,9 +15,8 @@ Handle Click Events
 .. note:: 
 
    Click Events in the `Charts Embedding SDK
-   <https://github.com/mongodb-js/charts-embed-sdk>`__ is available as 
-   a beta feature. It is only available with Charts Embedding 
-   JavaScript SDK v2.1.0-beta.1.
+   <https://github.com/mongodb-js/charts-embed-sdk>`__ 
+   is available in version 2.1.0 and later.
 
 The Charts Embedding JavaScript SDK includes a click event handler that 
 allows you to subscribe to click events. When you click on a particular 
@@ -34,8 +33,8 @@ experiences similar to the following in your application:
 Prerequisites 
 -------------
 
-Before you begin, :ref:`install <embedding-charts-sdk>` the Charts 
-Embedding JavaScript SDK. 
+Before you begin, :ref:`install <embedding-charts-sdk>` version 2.1.0 
+or later of the Charts Embedding JavaScript SDK. 
 
 .. _click-event-syntax:
 
@@ -209,16 +208,34 @@ contains:
 - The lower bound for numeric or date binning only
 
 For :ref:`data tables <data-table-ref>`, the Charts Embedding 
+JavaScript SDK click event handler captures click events for fields 
+that represent the channel data for the clicked element:
+  
+- ``groups`` field, which contains all Groups channels including 
+  label and value
+- ``cell`` field, which contains the column header label and value of 
+  the clicked cell
+
+For :ref:`geospatial charts <geo-spatial>`, the Charts Embedding 
 JavaScript SDK click event handler captures click events for the 
-following elements: 
+following elements:
 
-- Chart title 
-- Fields that represent the channel data for the clicked element: 
-  
-  - ``groups`` field, which contains all Groups channels including 
-    label and value
-  - ``cell`` field, which contains the column header label and value of 
-    the clicked cell
+- For :ref:`choropleth charts <choropleth-ref>`, the click event 
+  handler captures the fields that represent the channel data for the 
+  clicked element:
+
+  - ``lat`` field, which contains latitude
+  - ``lng`` field, which contains longitude
+  - ``location`` field, which contains the field label and value of the 
+    clicked geospatial area
+
+- For :ref:`geospatial scatter charts <scatter-ref>`, the click event 
+  handler captures the fields that represent the channel data for the 
+  clicked element:
+
+  - ``geopoint`` field, which contains the field 
+    name, value in GeoJSON format, and the coordinates of the clicked 
+    point
 
 .. _click-event-payload-selection-filter:
 
@@ -298,8 +315,10 @@ The ``target`` element of the :ref:`payload <click-event-payload>`
 contains information about the clicked target including: 
 
 - The type of mark, such as ``rect``, ``line``, ``arc``, ``symbol``, 
-  etc.
-- The role of mark, such as ``mark``, ``legend``, ``axis-label``, etc.
+  ``group``, or ``area``
+- The role of mark, such as ``mark``, ``legend``, ``axis-label``, 
+  ``axis-title``, ``tick-label``, ``legend-entry``, ``legend-title``, 
+  or ``frame``
 - The fill color of the mark
 
 For :ref:`data tables <data-table-ref>`, the Charts Embedding 
@@ -311,6 +330,13 @@ JavaScript SDK click event handler payload captures the following:
   ``column-total-cell``, ``header-column-total-cell``, and
   ``grand-total-cell``
 
+For :ref:`geospatial charts <geo-spatial>`, the Charts Embedding 
+JavaScript SDK click event handler payload captures the following:
+
+- The type of mark, such as ``polygon``, ``map``, or ``symbol``
+- The role of mark, such as ``mark`` or ``map``
+- The fill color of the mark
+
 The Charts Embedding JavaScript SDK click event handler does not 
 capture click events on column headers.
 

source/highlight-chart-elements.txt

@@ -21,8 +21,8 @@ highlight specific elements and :ref:`clicked events
 Prerequisites 
 -------------
 
-Before you begin, :ref:`install <embedding-charts-sdk>` the Charts 
-Embedding JavaScript SDK. 
+Before you begin, :ref:`install <embedding-charts-sdk>` version 2.1.0 
+or later of the Charts Embedding JavaScript SDK.
 
 .. _highlight-chart-syntax:
 
@@ -93,8 +93,9 @@ Chart Types
 
 The following chart types support programmatic highlighting: 
 
-- :ref:`line-area-chart-ref`
+- :ref:`choropleth-ref`
 - :ref:`column-bar-chart-ref` 
-- Non-geo :ref:`heatmap-chart-ref`
+- :ref:`data-table-ref`
 - :ref:`donut-chart-ref`
-- :ref:`choropleth-ref`
+- :ref:`line-area-chart-ref`
+- Non-geo :ref:`heatmap-chart-ref`

source/interact-with-charts.txt

@@ -12,6 +12,128 @@ Interact with Charts on a Dashboard
    :depth: 2
    :class: singlecol
 
+.. _interactive-filtering:
+
+Interactive Filtering
+---------------------
+
+On a dashboard, you can interact with a chart that has 
+:guilabel:`Filter or highlight` enabled to filter data 
+in other charts.
+
+With :guilabel:`Filter or highlight` enabled, clicking a chart element 
+with an associated  :ref:`dashboard filter <dashboard-filtering>` 
+temporarily reconfigures the scope of that dashboard filter to a single 
+chart series, category or field value.
+
+Interactive filtering is useful for getting quick insights into 
+subcategories of your data on dashboards with multiple charts. 
+Interactive filtering is temporary; you can revert to your original 
+dashboard filter at any time.
+
+To enable :guilabel:`Filter or highlight`:
+
+1. Hover over the chart on the dashboard to reveal four buttons in the 
+   upper right corner of the chart.
+#. Click the second button for :guilabel:`Interactive Filters`.
+#. Select :guilabel:`Filter or highlight` from the dropdown.
+
+.. note::
+   
+   By default, charts set :guilabel:`Interactive Filters` to 
+   :guilabel:`Filter or highlight`.
+
+   Setting a chart's :guilabel:`Interactive Filters` to 
+   :guilabel:`Filter` reflects dashboard filters 
+   and temporary interactive filters. That chart cannot be highlighted 
+   to set interactive filters on other charts.
+
+   Setting a chart's :guilabel:`Interactive Filters` to 
+   :guilabel:`Ignore` ignores any dashboard or interactive filters.
+
+.. example::
+   
+   On the |charts| :ref:`Sample Dashboard <sample-dashboard>`, movie 
+   statistics are displayed across a range of chart types.
+
+   If you create a dashboard filter for ``rated``, the content rating 
+   of a movie (e.g. G, PG-13, R), you can click a specific movie rating 
+   on any one of your charts to temporarily reconfigure the scope of 
+   your dashboard filter to that specific movie rating.
+
+   If you click on the PG-13 rating section of the 
+   :guilabel:`Movie Ratings` donut chart, the rest of the charts on 
+   your dashboard update to display only data for PG-13 movies. When 
+   you :ref:`clear the selection <remove-interactive-filter>` of the 
+   PG-13 rating, your dashboard reverts to displaying charts according 
+   to the ``rated`` dashboard filter.
+
+The chart upon which you set an interactive filter is highlighted, 
+*not* filtered. It :ref:`emphasizes <emphasize-series>` the element for 
+which your other charts are filtered. You can 
+:ref:`clear the selection <remove-interactive-filter>` from that 
+highlighted chart.
+
+A highlighted chart displays a status icon in the bottom left corner.
+
+Filtered charts display the :icon-fa5:`filter` icon.
+
+You can apply an interactive filter to all chart types *except*:
+
+- :ref:`Number Charts <number-chart-ref>` 
+- :ref:`Gauge Charts <gauge-chart-ref>`
+- :ref:`Top Item Charts <top-item-ref>`
+- :ref:`Geospatial Scatter Charts <geospatial-scatter-type>`
+- :ref:`Geospatial Heatmaps <geospatial-heatmap-type>`
+
+Filter a Dashboard by a Chart Element
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To interactively filter a dashboard based on a chart element, you must 
+first create a dashboard filter for the field that you want to filter 
+by.
+
+.. example::
+   
+   To filter the :ref:`Sample Dashboard <sample-dashboard>` to only 
+   English movies, you must have a dashboard filter on the ``language`` 
+   field.
+
+To filter a dashboard by a chart element, you can click on:
+
+- a legend entry
+- a chart category, such as an X or Y series label
+- a chart mark, such as a bar segment or line chart node
+
+When you hover over a chart element with an associated dashboard 
+filter, your cursor displays the :icon-fa4:`hand-pointer-o` icon. 
+
+If a chart element isn't filterable, your cursor displays the 
+:icon-fa4:`mouse-pointer` icon. You might be able to add a dashboard 
+filter for that value's field to make that element filterable.
+
+.. note::
+   
+   If the dashboard filter card associated with a clicked element is 
+   disabled, |charts-short| enables it temporarily until you 
+   :ref:`clear the selection <remove-interactive-filter>` of that 
+   element.
+
+When you filter a dashboard by a chart element, |charts-short| disables 
+all other dashboard filters until you clear the selection.
+
+.. _remove-interactive-filter:
+
+Remove an Interactive Filter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can remove an interactive dashboard filter by: 
+
+- Clicking the whitespace on the highlighted chart upon which you set 
+  the interactive filter, or
+
+- Changing the associated dashboard filter.
+
 .. _emphasize-series:
 
 Click to Emphasize Series
@@ -51,7 +173,7 @@ the selected data series from de-emphasized to emphasized.
    :alt: Emphasize multiple data series
 
 
-Emphasize all Data Series
+Emphasize All Data Series
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To restore the opacity of all data series to the default emphasized 

source/release-notes.txt

@@ -10,6 +10,41 @@ MongoDB Charts Cloud Release Notes
    :depth: 1
    :class: twocols
 
+|charts| v1.29
+--------------
+
+*Released December 6, 2021*
+
+Improvements in this release:
+
+- :ref:`Interactive Filtering <interactive-filtering>` is now 
+  available.
+
+- Improves the query editor, including a new button to collapse 
+  the editor.
+
+Bug fixes in this release:
+
+- Fixes an issue where :ref:`importing a dashboard <import-dashboard>`
+  did not work for some users.
+
+- Fixes an issue where sharing a dashboard with 
+  :ref:`Everyone <dashboard-access-everyone>` allowed them to make 
+  changes to existing roles.
+
+- Fixes an issue where negative numbers were incorrectly binned.
+
+- The :guilabel:`Edit Chart` button is now disabled for viewers.
+
+- :guilabel:`Show Data` now correctly displays in table and JSON format.
+
+- Data source names can now be 64 characters long.
+
+- Fixes an issue with donut charts having boolean values.
+
+- Click events now correctly pass event data when clicked in embedded 
+  charts.
+
 |charts| v1.27.0
 ----------------