@arcgis/charts-components 5.2.0-next.126 → 5.2.0-next.128

package/dist/components/arcgis-chart/customElement.d.ts

@@ -941,11 +941,11 @@ export abstract class ArcgisChart extends LitElement {
    */
   accessor ignoreSmoothRenderingLimit: boolean;
   /**
-   * When `true`, it signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.
+   * When `true`, it signals the queries to ignore the view's [`extent`](/references/core/views/MapView/#extent), whether an additional geometry filter is provided or not.
    *
    * This property will be effective when the component's [view](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#view) property is provided or when the [layer](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#layer) property is set to [ChartLayerView](https://developers.arcgis.com/javascript/latest/references/charts-components/interfaces/#ChartLayerView).
    *
-   * By default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any
+   * By default the queries made by the chart will consider the view's [`extent`](/references/core/views/MapView/#extent) as the unique geometry filter applicable. This implies ignoring any
    * geometry filters passed through the [model](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#model) or the [runtimeDataFilters](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#runtimeDataFilters) properties.
    *
    * @default false
@@ -1522,6 +1522,24 @@ export abstract class ArcgisChart extends LitElement {
    *
    * ![selectionOIDs](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionOIDs.avif)
    *
+   * ##### Selection by indexes
+   * When passing in a `selectionIndexes` map, the chart will match the provided indexes with the chart's data items and apply the selection.
+   * @example
+   * ```ts
+   * // This selects the first and third chart data items.
+   * chartElement.selectionData = {
+   *   selectionIndexes: new Map([
+   *     // Selects the first and third data items ("Bronx" and "Manhattan") for the first series ("Entire home/apt").
+   *     [0, { indexesToSelect: [0, 2] }],
+   *     // Selects the second data item ("Brooklyn") for the second series ("Private room").
+   *     [1, { indexesToSelect: [1] }],
+   *     // With no indexesToSelect provided, all data items for the third series ("Shared room") are selected.
+   *     [2, {}],
+   *   ]),
+   * };
+   * ```
+   *
+   * ![selectionIndexes](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionIndexes.avif)
    *
    * ##### Selection by items
    * When passing in a `selectionItems` array, the chart will match the provided items with the chart's data items and apply the selection.
@@ -1546,9 +1564,14 @@ export abstract class ArcgisChart extends LitElement {
    */
   accessor selectionData: SelectionData | undefined;
   /**
-   * Selection manager object used to synchronize the selections with the chart when [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) is `true`.
-   * It has precedence over the layer view's [SelectionManager](/references/core/views/SelectionManager/) when both are available.
+   * Use this property to supply a custom selection manager for charts.
+   * This is useful when applications want to share selection sets between components, without relying on the view's [SelectionManager](/references/core/views/SelectionManager/).
    *
+   * @example
+   * ```ts
+   * // Sync chart's selection manager with another component's selection manager (e.g. feature table)
+   * chartElement.selectionManager = featureTableElement.selectionManager;
+   * ```
    * @since 5.1
    */
   accessor selectionManager: SelectionManager | undefined;
@@ -1666,21 +1689,21 @@ export abstract class ArcgisChart extends LitElement {
    */
   accessor syncSelection: boolean;
   /**
-   * Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.
+   * When `true`, chart selections will be synchronized with the view's [SelectionManager](/references/core/views/SelectionManager/).
    *
    * @deprecated since 5.1. Use [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) prop instead.
    * @default "disabled"
    */
   accessor syncSelectionsBetweenChartAndLayerViewPolicy: SyncSelectionsBetweenChartAndLayerViewPolicy;
   /**
-   * Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.
+   * When `true`, chart selections will be synchronized with the view's [SelectionManager](/references/core/views/SelectionManager/).
    *
    * @default false
    * @since 5.1
    */
   accessor syncViewSelection: boolean;
   /**
-   * Whether the chart should be refreshed when the view's time extent changes.
+   * When `true`, the chart will be refreshed when the view's [`timeExtent`](/references/core/views/MapView/#timeExtent) changes.
    *
    * **Note**: Not supported for histogram.
    *
@@ -1689,10 +1712,10 @@ export abstract class ArcgisChart extends LitElement {
    */
   accessor syncViewTimeExtent: boolean;
   /**
-   * Whether the chart's data should be in sync with the view's [timeZone](/references/core/views/MapView/#timeZone).
+   * When `true`, the chart's data will be in sync with the view's [timeZone](/references/core/views/MapView/#timeZone).
    *
-   * **Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the
-   * capacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the value of this property.
+   * **Note**: Applicable only to bar, line, combo bar-line, heat and radar charts that use temporal data.
+   * For binned data, the layer must support the `/queryBins` operation. Otherwise, the chart ignores the view's time zone.
    *
    * @default false
    * @since 5.1
@@ -1708,11 +1731,21 @@ export abstract class ArcgisChart extends LitElement {
    */
   accessor syncViewTimeZoneInclusionList: (typeof WebChartTypes.BarSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries)[];
   /**
-   * Used to set a custom time zone for the chart.
+   * Defines the time zone used to display date and time values in the chart. The underlying data is not modified.
+   *
+   * | America/New_York | Europe/Helsinki |
+   * |---|---|
+   * |![timeZone_NewYork](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/timeZone_newYork.avif) | ![timeZone_Helsinki](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/timeZone_helsinki.avif) |
+   *
+   * **Note**: Applicable only to bar, line, combo bar-line, and heat and radar charts that use temporal data.
+   * For binned data, the layer must support the `/queryBins` operation. Otherwise, the chart ignores
+   * the view's time zone.
    *
+   * @see [Wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
    * @example
    * ```ts
-   * chartComponent.timeZone = "America/Los_Angeles";
+   * // Display date and time values in the specified time zone.
+   * chartElement.timeZone = "Europe/Helsinki";
    * ```
    */
   accessor timeZone: MapView["timeZone"] | undefined;