(DOCSP-5346): Each chart type can have a different maximum document count (#310)

tahiya-mongo · jwilliams-mongo · web-flow · commit 4384cb08aa1c · 2020-03-02T17:56:34.000-05:00
* (DOCSP-5346): Each chart type can have a different maximum document count * Update source/chart-types.txt Co-Authored-By: jwilliams-mongo <55147273+jwilliams-mongo@users.noreply.github.com> * Update source/chart-types.txt Co-Authored-By: jwilliams-mongo <55147273+jwilliams-mongo@users.noreply.github.com> * Update source/chart-type-reference/geospatial-scatter.txt Co-Authored-By: jwilliams-mongo <55147273+jwilliams-mongo@users.noreply.github.com> * Update source/chart-types.txt Co-Authored-By: jwilliams-mongo <55147273+jwilliams-mongo@users.noreply.github.com> * Update source/chart-type-reference/choropleth.txt Co-Authored-By: jwilliams-mongo <55147273+jwilliams-mongo@users.noreply.github.com> * Update source/chart-type-reference/geospatial-heatmap.txt Co-Authored-By: jwilliams-mongo <55147273+jwilliams-mongo@users.noreply.github.com> * (DOCSP-5346): Each chart type can have a different maximum document count * (DOCSP-5346): Each chart type can have a different maximum document count Co-authored-by: jwilliams-mongo <55147273+jwilliams-mongo@users.noreply.github.com>
diff --git a/source/chart-type-reference/choropleth.txt b/source/chart-type-reference/choropleth.txt
@@ -89,6 +89,12 @@ A choropleth chart is a good choice to compare:
    a high-level comparison, consider using a
    :ref:`Data Table <data-table-ref>`.
 
+Limitation
+----------
+
+The maximum query response size for a choropleth chart is 5000 documents. 
+
+
 Example
 -------
 
diff --git a/source/chart-type-reference/column-bar-chart.txt b/source/chart-type-reference/column-bar-chart.txt
@@ -184,6 +184,12 @@ may be beneficial to use one over the other:
    - :ref:`Limit Data <charts-limit-data>`
    - :ref:`Bin data <charts-bin-data>`
 
+Limitations
+-----------
+
+The maximum query response size for column and bar charts is 5000 documents. 
+
+
 Examples
 --------
 
@@ -284,3 +290,4 @@ shade of green indicates a longer average runtime:
 .. figure:: /images/charts/colored-bar-chart-reference.png
    :figwidth: 750px
    :alt: Colored Bar Chart Reference
+
diff --git a/source/chart-type-reference/data-table.txt b/source/chart-type-reference/data-table.txt
@@ -95,6 +95,13 @@ You can use data tables to show:
   exercises categorized by the type of exercise and time of day the
   exercised was performed.
 
+
+Limitations
+-----------
+
+The maximum query response size for a data table is 50000 documents. 
+
+
 Examples
 --------
 
@@ -161,6 +168,7 @@ mean weekly price as currency.
    Blank table cells indicate that there are no documents that match
    the corresponding intersection of ``property_type`` and ``suburb``.
 
+
 .. class:: hidden
 
    .. toctree::
diff --git a/source/chart-type-reference/donut-chart.txt b/source/chart-type-reference/donut-chart.txt
@@ -80,6 +80,13 @@ Consider using donut charts to display:
    values as a proportion to a whole, consider using a
    :ref:`column or bar chart <column-bar-chart-ref>`.
 
+
+Limitations
+-----------
+
+The maximum query response size for a donut chart is 5000 documents. 
+
+
 Examples
 --------
 
@@ -135,3 +142,5 @@ documents with the same ``Activity Type`` value.
 
 We see based on the visualization that the activity with the greatest
 total workout time is ``Surf``, followed by ``Bike Ride``.
+
+
diff --git a/source/chart-type-reference/geo-spatial.txt b/source/chart-type-reference/geo-spatial.txt
@@ -63,6 +63,7 @@ indicate data points on a map.
 
 .. _heatmap-description:
 
+
 Heatmap
 -------
 
@@ -73,6 +74,7 @@ intensity to compare concentrations of data points on a map.
    :figwidth: 572px
    :alt: Heatmap chart example
 
+
 .. class:: hidden
 
    .. toctree::
diff --git a/source/chart-type-reference/geospatial-heatmap.txt b/source/chart-type-reference/geospatial-heatmap.txt
@@ -82,3 +82,8 @@ The :guilabel:`Coordinates` channel uses the ``location`` database
 field, which contains arrays of latitude-longitude pairs. The
 :guilabel:`Intensity` field uses the ``monthly_price`` database field,
 which contains monthly rental rates for each property in the database.
+
+Limitation
+----------
+
+The maximum query response size for a geospatial heatmap is 50000 documents. 
diff --git a/source/chart-type-reference/geospatial-scatter.txt b/source/chart-type-reference/geospatial-scatter.txt
@@ -79,11 +79,6 @@ indicates the aggregation value for the different circle sizes.
    If no fields are encoded in the :guilabel:`Size` encoding channel, |charts-short| displays all points with the same size.
 
 
-Limitations
------------
-
-The maximum query response size for Scatter charts is 1000 documents.
-
 Build a Geospatial Scatter Chart
 --------------------------------
 
@@ -118,3 +113,9 @@ To create a geospatial scatter chart:
 #. Click the pencil icon above the chart to give it name.
 
 #. Click :guilabel:`Save and Close`.
+
+
+Limitations
+-----------
+
+The maximum query response size for a geospatial scatter chart is 1000 documents.
diff --git a/source/chart-type-reference/grid-charts.txt b/source/chart-type-reference/grid-charts.txt
@@ -26,6 +26,7 @@ Grid Charts
       .. figure:: /images/charts/scatter-chart-small.png
          :figwidth: 100%
 
+
 .. class:: hidden
 
    .. toctree::
diff --git a/source/chart-type-reference/heatmap.txt b/source/chart-type-reference/heatmap.txt
@@ -72,6 +72,12 @@ choice to display:
    data. With naturally ordered datasets, heatmaps highlight areas of
    concentration within the data.
 
+Limitations
+-----------
+
+The maximum query response size for a heatmap is 5000 documents. 
+
+
 Example
 -------
 
diff --git a/source/chart-type-reference/line-area-chart.txt b/source/chart-type-reference/line-area-chart.txt
@@ -98,6 +98,13 @@ showing relative percentages.
 For a detailed example, see the :ref:`100% Stacked Area Chart Example
 <100-stacked-area-example>`.
 
+
+Limitation
+----------
+
+The maximum document limit for discrete line and area charts is 5000 documents. 
+
+
 .. _continuous-charts:
 
 Continuous Line and Area Charts
@@ -110,6 +117,7 @@ chart would be useful to visualize stock closing prices over time,
 assuming each closing price comes from a distinct document in the
 dataset.
 
+
 Continuous Chart Encoding Channels
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -151,6 +159,12 @@ Continuous line and area charts provide the following
           mapped to the :guilabel:`Y Axis aggregation`
           :ref:`encoding channel <encoding-channels>`.
 
+Limitation
+----------
+
+The maximum document limit for continuous line and area charts is 50000 documents. 
+
+
 Discrete Area Versus Continuous Area Charts Display
 ---------------------------------------------------
 
diff --git a/source/chart-type-reference/number-chart.txt b/source/chart-type-reference/number-chart.txt
@@ -33,6 +33,12 @@ average number of vacant rooms across all hotels, or apply a
 :ref:`filter <charts-filter-documents>` to see the total number of
 vacant rooms in a select region.
 
+Limitations
+-----------
+
+The maximum query response size for a number chart is 5000 documents. 
+
+
 Examples
 --------
 
diff --git a/source/chart-type-reference/scatter-chart.txt b/source/chart-type-reference/scatter-chart.txt
@@ -77,6 +77,13 @@ Consider using a scatter chart to display:
 - Volume of sales data for selected retail outlets
 - Population density figures across several countries
 
+
+Limitations
+-----------
+
+The maximum query response size for a scatter chart is 50000 documents.  
+
+
 Examples
 --------
 
diff --git a/source/chart-type-reference/word-cloud.txt b/source/chart-type-reference/word-cloud.txt
@@ -75,6 +75,13 @@ Consider using a word cloud to:
 
 - Highlight specific customer pain points from aggregated user surveys.
 
+
+Limitations
+-----------
+
+The maximum query response size for a word cloud is 5000 documents. 
+
+
 Example
 -------
 
diff --git a/source/chart-types.txt b/source/chart-types.txt
@@ -88,8 +88,19 @@ keywords and phrases.
 Geospatial charts combine geospatial data with other forms of data to
 create map-based charts.
 
+
 .. figure:: /images/charts/geo-type-heatmap.png
    :figwidth: 525px
+   
+
+Maximum Document Limit
+----------------------
+
+The maximum number of documents a chart displays data from differs based on the chart type.
+The limit is enforced on the server using a ``$limit`` stage at the end of the pipeline. 
+Once this maximum limit is reached, there is no way to determine which documents from the 
+total data set comprise the chart data. A warning message is displayed that 
+specifies the query response limit for that particular chart type. 
 
 .. class:: hidden
 
