@arcgis/charts-components 5.2.0-next.141 → 5.2.0-next.143

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -718,17 +718,43 @@ export abstract class ArcgisChart extends LitElement {
718
718
  /**
719
719
  * Customize the maximum number of data items allowed on the chart.
720
720
  *
721
- * The chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation
722
- * or update of the chart, or render the elements up to the given limits.
723
- *
724
- * **Note**: Not applicable to gauges.
721
+ * 1. The chart's behavior once that limit is reached can be adjusted through the [`behaviorAfterLimit`](/references/charts-components/utils/defaults/interfaces/#ChartElementLimit-behaviorAfterLimit) nested property.
722
+ * - `reject`: Reject the creation or update of the chart when the limit is reached.
723
+ * - `renderUpToTheLimit`: Render the elements up to the given limits.
724
+ * 2. Specific limits for each chart type can be defined with the following nested properties.
725
+ * - [`serialChart`](/references/charts-components/utils/defaults/interfaces/#ChartElementLimit-serialChart): Bar chart, line chart, combo bar line chart and radar chart.
726
+ * - [`series`](/references/charts-components/utils/defaults/interfaces/#SerialChartLimit-series), [`elements`](/references/charts-components/utils/defaults/interfaces/#SerialChartLimit-elements) and [`categories`](/references/charts-components/utils/defaults/interfaces/#SerialChartLimit-categories) limits can be specified.
727
+ * - [`boxPlot`](/references/charts-components/utils/defaults/interfaces/#ChartElementLimit-boxPlot): [`series`](/references/charts-components/utils/defaults/interfaces/#SerialChartLimit-series), [`elements`](/references/charts-components/utils/defaults/interfaces/#SerialChartLimit-elements), [`categories`](/references/charts-components/utils/defaults/interfaces/#SerialChartLimit-categories) and `outliers` limits can be specified.
728
+ * - [`heatChart`](/references/charts-components/utils/defaults/interfaces/#ChartElementLimit-heatChart): `cells` limits can be specified.
729
+ * - [`scatterplot`](/references/charts-components/utils/defaults/interfaces/#ChartElementLimit-scatterplot): `aggregationThreshold` and `markersAfterAggregation` limits can be specified.
730
+ * - [`pieChart`](/references/charts-components/utils/defaults/interfaces/#ChartElementLimit-pieChart): `slices` limits can be specified.
731
+ * - [`gauge`](/references/charts-components/utils/defaults/interfaces/#ChartElementLimit-gauge): `features` limits can be specified.
732
+ *
733
+ * Default limits when `chartLimits` is not set:
734
+ * - Except for scatterplots, limits are enforced by rejecting chart creation or updates. No maximum category count is set by default.
735
+ * - The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event is emitted and, by default, a "Too many features" or "No data available to display" warning message is displayed in the chart container. Set [hideUIMessages](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideUIMessages) to `true` to hide the warning.
736
+ * - Specific limits for each chart type are as follows:
737
+ * - Bar chart, box plot: Up to 100 series. With one series, up to 10,000 elements total; with two series, up to 1,000 per series and 2,000 total; with three or more series, up to 100 per series and 2,000 total. Box plots also allow up to 10,000 outliers.
738
+ * - Line chart, radar chart: Up to 100 series. With one series, up to 10,000 markers total; with two series, up to 5,000 per series and 10,000 total; with three or more series, up to 1,000 per series and 10,000 total.
739
+ * - Histogram: Up to 64 bins, the default is 32 bins.
740
+ * - Pie chart: Up to 300 slices.
741
+ * - Heat chart: Up to 10,000 cells.
742
+ * - Scatterplot: Aggregation starts after 10,000 markers; displays up to 10,000 aggregated markers.
743
+ * - Gauge by feature: Up to 50 features.
725
744
  *
726
745
  * @example
727
746
  * ```ts
747
+ * // Set the maximum number of categories to 15 for the bar chart (part of the serial chart).
728
748
  * chartElement.chartLimits = {
729
- * behaviorAfterLimit: LimitBehavior.RenderUpToTheLimit,
749
+ * behaviorAfterLimit: "renderUpToTheLimit",
730
750
  * serialChart: { categories: 15 }
731
751
  * };
752
+ *
753
+ * // Reject the creation or update of the pie chart when the slices count exceeds 10.
754
+ * chartElement.chartLimits = {
755
+ * behaviorAfterLimit: "reject",
756
+ * pieChart: { slices: 10 }
757
+ * };
732
758
  * ```
733
759
  */
734
760
  accessor chartLimits: ChartElementLimit | undefined;
@@ -918,7 +944,7 @@ export abstract class ArcgisChart extends LitElement {
918
944
  */
919
945
  accessor hideLoaderAnimation: boolean;
920
946
  /**
921
- * When set to `true`, UI messages are hidden. These messages can be no data warnings, any placeholder messages set or invalid chart configuration.
947
+ * When `true`, UI messages are hidden. These messages can be no data warnings, any placeholder messages set or invalid chart configuration.
922
948
  * By default, its value is `false`, which displays the messages on the chart.
923
949
  *
924
950
  * @default false
@@ -1401,8 +1427,8 @@ export abstract class ArcgisChart extends LitElement {
1401
1427
  * When `true`, null values are considered as valid.
1402
1428
  *
1403
1429
  * By default, when the data contains only null values, the chart dataset is considered empty:
1404
- * - The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
1405
- * - The "No data available to display" warning message will be displayed in the chart container.
1430
+ * 1. The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
1431
+ * 2. The "No data available to display" warning message will be displayed in the chart container.
1406
1432
  *
1407
1433
  * @default false
1408
1434
  */
@@ -1502,11 +1528,14 @@ export abstract class ArcgisChart extends LitElement {
1502
1528
  /**
1503
1529
  * Applies runtime data filters to the chart, features will be filtered based on the provided key value pairs.
1504
1530
  *
1505
- * Supported keys are `where`, `objectIds`, `geometry`, `spatialRelationship`, `distance`, `units`, `timeExtent`, and `gdbVersion`.
1531
+ * Supported keys are [`where`](/references/charts-components/spec/web-chart/#WebChartQuery-where), [`objectIds`](/references/charts-components/spec/web-chart/#WebChartQuery-objectIds), [`geometry`](/references/charts-components/spec/web-chart/#WebChartQuery-geometry),
1532
+ * [`spatialRelationship`](/references/charts-components/spec/web-chart/#WebChartQuery-spatialRelationship), [`distance`](/references/charts-components/spec/web-chart/#WebChartQuery-distance),
1533
+ * [`units`](/references/charts-components/spec/web-chart/#WebChartQuery-units), [`timeExtent`](/references/charts-components/spec/web-chart/#WebChartQuery-timeExtent), and [`gdbVersion`](/references/charts-components/spec/web-chart/#WebChartQuery-gdbVersion).
1506
1534
  *
1507
1535
  * @example
1508
1536
  * ```ts
1509
- * // This example filters the chart to show only features with the name "Katrina", object IDs 12, 19, and 27, within a specified geometry, within 10 miles and a specific time extent.
1537
+ * // This example filters the chart to show only features with the name "Katrina",
1538
+ * // object IDs 12, 19, and 27, within a specified geometry, within 10 miles and a specific time extent.
1510
1539
  * const start = new Date(2005, 8, 23).getTime();
1511
1540
  * const end = new Date(2005, 8, 28).getTime();
1512
1541
  *
@@ -1550,10 +1579,11 @@ export abstract class ArcgisChart extends LitElement {
1550
1579
  */
1551
1580
  accessor secondaryYAxisLabelFormatter: AxisLabelFormatCallback | undefined;
1552
1581
  /**
1553
- * Applies a programmatic selection to the chart. The payload can target chart elements by object IDs (`selectionOIDs`), by indexes (`selectionIndexes`), or by items (`selectionItems`).
1582
+ * Applies a programmatic selection to the chart. The payload can target chart elements by [`selectionOIDs`](/references/charts-components/utils/misc/interfaces/#SelectionData-selectionOIDs),
1583
+ * by [`selectionIndexes`](/references/charts-components/utils/misc/interfaces/#SelectionData-selectionIndexes), or by [`selectionItems`](/references/charts-components/utils/misc/interfaces/#SelectionData-selectionItems).
1554
1584
  *
1555
1585
  * ##### Selection by object IDs
1556
- * When passing in a `selectionOIDs` array, the chart will match the provided object IDs with the chart's data items and apply the selection.
1586
+ * When passing in a [`selectionOIDs`](/references/charts-components/utils/misc/interfaces/#SelectionData-selectionOIDs) array, the chart will match the provided object IDs with the chart's data items and apply the selection.
1557
1587
  *
1558
1588
  * @example
1559
1589
  * ```ts
@@ -1566,7 +1596,7 @@ export abstract class ArcgisChart extends LitElement {
1566
1596
  * ![selectionOIDs](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionOIDs.avif)
1567
1597
  *
1568
1598
  * ##### Selection by indexes
1569
- * When passing in a `selectionIndexes` map, the chart will match the provided indexes with the chart's data items and apply the selection.
1599
+ * When passing in a [`selectionIndexes`](/references/charts-components/utils/misc/interfaces/#SelectionData-selectionIndexes) map, the chart will match the provided indexes with the chart's data items and apply the selection.
1570
1600
  * @example
1571
1601
  * ```ts
1572
1602
  * // This selects the first and third chart data items.
@@ -1585,7 +1615,7 @@ export abstract class ArcgisChart extends LitElement {
1585
1615
  * ![selectionIndexes](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionIndexes.avif)
1586
1616
  *
1587
1617
  * ##### Selection by items
1588
- * When passing in a `selectionItems` array, the chart will match the provided items with the chart's data items and apply the selection.
1618
+ * When passing in a [`selectionItems`](/references/charts-components/utils/misc/interfaces/#SelectionData-selectionItems) array, the chart will match the provided items with the chart's data items and apply the selection.
1589
1619
  * @example
1590
1620
  * ```ts
1591
1621
  * // This selects the first chart data item with the matching items.
@@ -1742,6 +1772,19 @@ export abstract class ArcgisChart extends LitElement {
1742
1772
  * When `true`, chart selections will be synchronized with the view's [SelectionManager](/references/core/views/SelectionManager/).
1743
1773
  *
1744
1774
  * @default false
1775
+ * @example
1776
+ * ```html
1777
+ * <!-- Selecting the `Asia` slice on the chart will select the corresponding features on the map. -->
1778
+ * <arcgis-map item-id="87936e6706144627b7c067ebd515da0c">
1779
+ * <arcgis-chart
1780
+ * map-layer-id="1a116fff2bf-layer-2"
1781
+ * chart-index="3"
1782
+ * slot="bottom-right"
1783
+ * sync-view-selection
1784
+ * ></arcgis-chart>
1785
+ * </arcgis-map>
1786
+ * ```
1787
+ * ![syncViewSelection](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/syncViewSelection.avif)
1745
1788
  * @since 5.1
1746
1789
  */
1747
1790
  accessor syncViewSelection: boolean;
@@ -1910,12 +1953,11 @@ export abstract class ArcgisChart extends LitElement {
1910
1953
  */
1911
1954
  accessor yAxisLabelFormatter: AxisLabelFormatCallback | undefined;
1912
1955
  /**
1913
- * When `true`, count=0 is considered a valid statistic.
1956
+ * When `true`, `count=0` is considered a valid statistic.
1914
1957
  *
1915
- * By default, when the aggregation type is "count" and the data contains only values equal to 0, the chart dataset
1916
- * is considered empty:
1917
- * - The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
1918
- * - The "No data available to display" warning message will be displayed in the chart container.
1958
+ * By default, when the aggregation type is "count" and the data contains only values equal to 0, the chart dataset is considered empty:
1959
+ * 1. The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
1960
+ * 2. The "No data available to display" warning message will be displayed in the chart container.
1919
1961
  *
1920
1962
  * @default false
1921
1963
  * @since 5.2
@@ -1962,8 +2004,8 @@ export abstract class ArcgisChart extends LitElement {
1962
2004
  * });
1963
2005
  * ```
1964
2006
  *
2007
+ * The exported CSV file will contain the following data:
1965
2008
  * ```csv
1966
- * // The exported CSV file will contain the following data:
1967
2009
  * sep=|
1968
2010
  * "Bronx"|"Entire home/apt"|"379"
1969
2011
  * "Bronx"|"Private room"|"652"
@@ -1990,7 +2032,7 @@ export abstract class ArcgisChart extends LitElement {
1990
2032
  *
1991
2033
  * @example
1992
2034
  * ```html
1993
- * // Load a chart from a layer item
2035
+ * <!-- Load a chart from a layer item -->
1994
2036
  * <arcgis-chart layer-item-id="8871626e970a4f3e9d6113ec63a92f2f" chart-index="2" />
1995
2037
  * ```
1996
2038
  * ```ts
@@ -2014,6 +2056,7 @@ export abstract class ArcgisChart extends LitElement {
2014
2056
  * @param heading - The heading to display in the chart's container.
2015
2057
  * @example
2016
2058
  * ```html
2059
+ * <!-- Buttons to show and clear notifications -->
2017
2060
  * <button id="show-notification" type="button">Show notification</button>
2018
2061
  * <button id="clear-notification" type="button">Clear notification</button>
2019
2062
  * ```