@arcgis/charts-components 5.1.0-next.97 → 5.1.0-next.98

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

@@ -8,7 +8,7 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { AxisLabelFormatCallback, ChartOptions, GaugeInnerLabelFormatCallback, GuideTooltipFormatCallback, PieChartLegendValueLabelFormatCallback, PreRenderCallback } from "../../chart-rendering/common/interfaces.js";
 import type { CSVOptions, SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
 import type { ChartModel } from "../../model/chart-model/chart-model.js";
-import type { WebChartLegendPositions } from "../../spec/chart-object-literals.js";
+import type { WebChartTypes, WebChartLegendPositions } from "../../spec/chart-object-literals.js";
 import type { WebChartDataTypes } from "../../spec/data-source.js";
 import type { WebChart, WebChartDataFilters } from "../../spec/web-chart.js";
 import type { DataWarningObject, ValidationStatus } from "../../utils/chart-config/validator/interfaces.js";
@@ -1393,6 +1393,23 @@ export abstract class ArcgisChart extends LitElement {
    * @since 5.1
    */
   accessor syncViewTimeExtent: boolean;
+  /**
+   * Whether the chart's data should be in sync with the view's time zone (`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.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor syncViewTimeZone: boolean;
+  /**
+   * List of chart types to include from syncing the view's time zone (`timeZone`) with the data. Currently heat charts are included by default.
+   * **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 content of this list.
+   *
+   * @deprecated since 5.1. Use [syncViewTimeZone](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewTimeZone) instead.
+   */
+  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.
    *