@arcgis/charts-components 5.0.0-next.68 → 5.0.0-next.69

package/dist/docs/web-types.json

@@ -1,14 +1,14 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@arcgis/charts-components",
-  "version": "5.0.0-next.68",
+  "version": "5.0.0-next.69",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "name": "arcgis-chart",
-          "description": "The Chart component renders a chart based on the provided model. Get started by reading the [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) page.\n\nSupported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.\n--\n\n### Events\n- **arcgisAxesMinMaxChange** - Event triggered once the chart axes min/max values are computed\n- **arcgisBadDataWarningRaise** - Event triggered when an error is detected with the data set\n- **arcgisChartNotFoundWarning** - Event triggered when the chart is not found for the given `chartIndex` property.\n- **arcgisConfigChange** - Event triggered when the chart config is changed\n- **arcgisDataFetchComplete** - Event triggered once the chart data has been fetched but not yet fully processed.\nOnly supported for pie chart at the moment.\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n- **arcgisDataProcessComplete** - Event triggered once the chart data has been processed\n- **arcgisDataProcessError** - Event triggered when an error occurred while fetching of processing the data for the chart\n- **arcgisLegendItemVisibilityChange** - Event triggered once a legend item visibility has been changed\n- **arcgisNoRenderPropChange** - Event triggered when a no-render prop is changed\n- **arcgisRuntimeError** - Event triggered when an error occurred that prevents the chart from being created or updated\n- **arcgisSelectionComplete** - Event triggered when a selection is applied to the chart\n- **arcgisSeriesColorChange** - Event triggered once the chart series color have been assigned\n- **arcgisSeriesOrder** - Event carrying the series id as they have been sorted following the `orderOptions` instructions\n- **arcgisUpdateComplete** - Event triggered once the chart is updated\n\n### Methods\n- `clearSelection(): Promise<void>` - Clears all selection on the chart.\n\n**Note**: Not applicable to gauge.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `errorAlert(errorMessage?: string): Promise<void>` - Triggers an alert to display an error message.\n- `exportAsCSV(options?: CSVOptions): Promise<void>` - Export the current chart's data as a CSV file.\n\nThe `Options` object can contain the following properties:\n- `columns`: An array of column to include in the CSV file.\n- `delimiter`: The delimiter to use in the CSV file. Default is `,`.\n- `includeHeader`: Whether to include the header row in the CSV file. Default is `true`.\n- `quoteAll`: Whether to quote all values in the CSV file. Default is `false`.\n- `locale`: The locale to use when formatting the CSV file. Default is `en`.\n   * * Locale supported are: \"ar\", \"ar-u-nu-latn\", \"bs\", \"bg\", \"ca\", \"cs\", \"da\", \"de\", \"el\", \"en\", \"en-US\", \"es\", \"et\", \"fi\", \"fr\", \"he\", \"hr\", \"hu\", \"id\", \"it\", \"ja\", \"ko\", \"lt\", \"lv\", \"no\", \"nl\", \"pl\", \"pt-BR\", \"pt-PT\", \"ro\", \"ru\", \"sr\", \"sl\", \"sk\", \"sv\", \"th\", \"tr\", \"uk\", \"vi\", \"zh-CN\", \"zh-HK\", \"zh-TW\"\n\n**Note**: The chart types supported by this method are:\n- Bar chart\n- Box plot\n- Combo bar and line chart\n- Histogram\n- Line chart\n- Pie chart\n- `exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>` - Exports the current chart as an image. The default format is PNG, with SVG and JPEG available as alternatives.\n- `loadModel(): Promise<void>` - Returns a promise that resolves when the chart model is fully loaded.\n- `notify(message?: string, heading?: string, options?: NotifyOptions): Promise<void>` - Notify method allows passing external messages to the chart component.\nIt can be used to pass validation or information messages.\nIn a situation where a config update is overriding your notification modal, consider waiting for the `arcgisUpdateComplete` event.\n- `refresh(props?: { updateData?: boolean; resetAxesBounds?: boolean; }): Promise<void>` - Re-render the chart.\n- `resetZoom(): Promise<void>` - Resets the chart zoom to bring it back to full extent\n\n**Note**: Applicable to XY charts only.\n- `switchSelection(): Promise<void>` - Switches the selection on the chart.\n\n**Note**: Not applicable to gauge.\n\n### Slots\n- **action-bar** - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.",
+          "description": "The Chart component renders a chart based on the provided model. Get started by reading the [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) page.\n\nSupported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.\n--\n\n### Events\n- **arcgisAxesMinMaxChange** - Event triggered once the chart axes min/max values are computed\n- **arcgisBadDataWarningRaise** - Event triggered when an error is detected with the data set\n- **arcgisChartNotFoundWarning** - Event triggered when the chart is not found for the given `chartIndex` property.\n- **arcgisConfigChange** - Event triggered when the chart config is changed\n- **arcgisDataFetchComplete** - Event triggered once the chart data has been fetched but not yet fully processed.\nOnly supported for pie chart at the moment.\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n- **arcgisDataProcessComplete** - Event triggered once the chart data has been processed\n- **arcgisDataProcessError** - Event triggered when an error occurred while fetching of processing the data for the chart\n- **arcgisLegendItemVisibilityChange** - Event triggered once a legend item visibility has been changed\n- **arcgisNoRenderPropChange** - Event triggered when a no-render prop is changed\n- **arcgisRenderingComplete** - Event triggered once the chart rendering is complete\n- **arcgisRuntimeError** - Event triggered when an error occurred that prevents the chart from being created or updated\n- **arcgisSelectionComplete** - Event triggered when a selection is applied to the chart\n- **arcgisSeriesColorChange** - Event triggered once the chart series color have been assigned\n- **arcgisSeriesOrder** - Event carrying the series id as they have been sorted following the `orderOptions` instructions\n- **arcgisUpdateComplete** - Event triggered once the chart is updated\n\n### Methods\n- `clearSelection(): Promise<void>` - Clears all selection on the chart.\n\n**Note**: Not applicable to gauge.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `errorAlert(errorMessage?: string): Promise<void>` - Triggers an alert to display an error message.\n- `exportAsCSV(options?: CSVOptions): Promise<void>` - Export the current chart's data as a CSV file.\n\nThe `Options` object can contain the following properties:\n- `columns`: An array of column to include in the CSV file.\n- `delimiter`: The delimiter to use in the CSV file. Default is `,`.\n- `includeHeader`: Whether to include the header row in the CSV file. Default is `true`.\n- `quoteAll`: Whether to quote all values in the CSV file. Default is `false`.\n- `locale`: The locale to use when formatting the CSV file. Default is `en`.\n   * * Locale supported are: \"ar\", \"ar-u-nu-latn\", \"bs\", \"bg\", \"ca\", \"cs\", \"da\", \"de\", \"el\", \"en\", \"en-US\", \"es\", \"et\", \"fi\", \"fr\", \"he\", \"hr\", \"hu\", \"id\", \"it\", \"ja\", \"ko\", \"lt\", \"lv\", \"no\", \"nl\", \"pl\", \"pt-BR\", \"pt-PT\", \"ro\", \"ru\", \"sr\", \"sl\", \"sk\", \"sv\", \"th\", \"tr\", \"uk\", \"vi\", \"zh-CN\", \"zh-HK\", \"zh-TW\"\n\n**Note**: The chart types supported by this method are:\n- Bar chart\n- Box plot\n- Combo bar and line chart\n- Histogram\n- Line chart\n- Pie chart\n- `exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>` - Exports the current chart as an image. The default format is PNG, with SVG and JPEG available as alternatives.\n- `loadModel(): Promise<void>` - Returns a promise that resolves when the chart model is fully loaded.\n- `notify(message?: string, heading?: string, options?: NotifyOptions): Promise<void>` - Notify method allows passing external messages to the chart component.\nIt can be used to pass validation or information messages.\nIn a situation where a config update is overriding your notification modal, consider waiting for the `arcgisUpdateComplete` event.\n- `refresh(props?: { updateData?: boolean; resetAxesBounds?: boolean; }): Promise<void>` - Re-render the chart.\n- `resetZoom(): Promise<void>` - Resets the chart zoom to bring it back to full extent\n\n**Note**: Applicable to XY charts only.\n- `switchSelection(): Promise<void>` - Switches the selection on the chart.\n\n**Note**: Not applicable to gauge.\n\n### Slots\n- **action-bar** - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/",
           "attributes": [
             {
@@ -433,6 +433,11 @@
               "type": "{\n    propName: string;\n    value: number | boolean | WebChartLegendPositions | MapView | SceneView | undefined;\n    model: ChartModel | undefined;\n}",
               "description": "Event triggered when a no-render prop is changed"
             },
+            {
+              "name": "arcgisRenderingComplete",
+              "type": "void",
+              "description": "Event triggered once the chart rendering is complete"
+            },
             {
               "name": "arcgisRuntimeError",
               "type": "void",
@@ -813,6 +818,11 @@
                 "type": "{\n    propName: string;\n    value: number | boolean | WebChartLegendPositions | MapView | SceneView | undefined;\n    model: ChartModel | undefined;\n}",
                 "description": "Event triggered when a no-render prop is changed"
               },
+              {
+                "name": "arcgisRenderingComplete",
+                "type": "void",
+                "description": "Event triggered once the chart rendering is complete"
+              },
               {
                 "name": "arcgisRuntimeError",
                 "type": "void",

package/dist/index.d.ts

@@ -41,6 +41,7 @@ declare global {
     "arcgisDataProcessError": ArcgisChart["arcgisDataProcessError"]["detail"];
     "arcgisLegendItemVisibilityChange": ArcgisChart["arcgisLegendItemVisibilityChange"]["detail"];
     "arcgisNoRenderPropChange": ArcgisChart["arcgisNoRenderPropChange"]["detail"];
+    "arcgisRenderingComplete": ArcgisChart["arcgisRenderingComplete"]["detail"];
     "arcgisRuntimeError": ArcgisChart["arcgisRuntimeError"]["detail"];
     "arcgisSelectionComplete": ArcgisChart["arcgisSelectionComplete"]["detail"];
     "arcgisSeriesColorChange": ArcgisChart["arcgisSeriesColorChange"]["detail"];

package/dist/index.js

@@ -16,7 +16,7 @@ import { B as Vo, a as ko, C as Ho, H as Ko, L as qo, P as Go, S as Qo } from ".
 import { g as Uo, s as _o } from "./chunks/runtime.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.68 */
+v5.0.0-next.69 */
 function v(a) {
   let o;
   switch (a.length) {

package/dist/loader.js

@@ -2,7 +2,7 @@ import { r as e } from "./chunks/runtime.js";
 import { makeDefineCustomElements as t } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.68 */
+v5.0.0-next.69 */
 const o = t(e, {
   "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,allowUsingObjectIdStat,autoDestroyDisabled,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableBetaFeatures,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,ignoreSmoothRenderingLimit,ignoreViewExtent,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerItemId,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,loaderColors:,messageOverrides:,model:,nullAsValid,placeholder,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionTheme:,setTimeBinningInfoWhenNotProvided,showUIMessages,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,errorAlert,exportAsCSV,exportAsImage,loadModel,notify,refresh,resetZoom,switchSelection"],
   "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,disableCSVExportForChartTypes:,editChartState,editChartTitle,editChartToggle,expanded,exportActionState,exportAsCSVState,exportAsCSVTitle,exportAsImageState,exportAsImageTitle,filterByExtentState,filterByExtentTitle,filterByExtentToggle,filterBySelectionState,filterBySelectionTitle,filterBySelectionToggle,forceDisableActions,fullExtentState,fullExtentTitle,fullExtentToggle,hiddenActions:,legendState,legendTitle,legendToggle,messageOverrides:,rotateChartState,rotateChartTitle,rotateChartToggle,selectionState,selectionTitle,selectionToggle,switchSelectionState,switchSelectionTitle,switchSelectionToggle,zoomState,zoomTitle,zoomToggle"],

package/dist/model.js

@@ -4,7 +4,7 @@ import { s as r, t as s, u as n } from "./chunks/type-guards.js";
 import { a as B, e as P, i as S, g as x, b as W, r as v, h as G, l as K, m as D, p as F, j as H, k as O, q as R, n as A, o as E, d as X, f as Y, c as $ } from "./chunks/type-guards.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.68 */
+v5.0.0-next.69 */
 async function c(t) {
   const o = "config" in t ? r(t.config) : t.chartType;
   let a;

package/dist/types/lumina.d.ts

@@ -13,6 +13,7 @@ interface LuminaArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'al
   onarcgisDataProcessError?: EventHandler<HTMLArcgisChartElement["arcgisDataProcessError"]>;
   onarcgisLegendItemVisibilityChange?: EventHandler<HTMLArcgisChartElement["arcgisLegendItemVisibilityChange"]>;
   onarcgisNoRenderPropChange?: EventHandler<HTMLArcgisChartElement["arcgisNoRenderPropChange"]>;
+  onarcgisRenderingComplete?: EventHandler<HTMLArcgisChartElement["arcgisRenderingComplete"]>;
   onarcgisRuntimeError?: EventHandler<HTMLArcgisChartElement["arcgisRuntimeError"]>;
   onarcgisSelectionComplete?: EventHandler<HTMLArcgisChartElement["arcgisSelectionComplete"]>;
   onarcgisSeriesColorChange?: EventHandler<HTMLArcgisChartElement["arcgisSeriesColorChange"]>;

package/dist/types/preact.d.ts

@@ -14,6 +14,7 @@ interface PreactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'al
   onarcgisDataProcessError?: EventHandler<HTMLArcgisChartElement["arcgisDataProcessError"]>;
   onarcgisLegendItemVisibilityChange?: EventHandler<HTMLArcgisChartElement["arcgisLegendItemVisibilityChange"]>;
   onarcgisNoRenderPropChange?: EventHandler<HTMLArcgisChartElement["arcgisNoRenderPropChange"]>;
+  onarcgisRenderingComplete?: EventHandler<HTMLArcgisChartElement["arcgisRenderingComplete"]>;
   onarcgisRuntimeError?: EventHandler<HTMLArcgisChartElement["arcgisRuntimeError"]>;
   onarcgisSelectionComplete?: EventHandler<HTMLArcgisChartElement["arcgisSelectionComplete"]>;
   onarcgisSeriesColorChange?: EventHandler<HTMLArcgisChartElement["arcgisSeriesColorChange"]>;

package/dist/types/preact10.d.ts

@@ -15,6 +15,7 @@ interface PreactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'al
   onarcgisDataProcessError?: EventHandler<HTMLArcgisChartElement["arcgisDataProcessError"]>;
   onarcgisLegendItemVisibilityChange?: EventHandler<HTMLArcgisChartElement["arcgisLegendItemVisibilityChange"]>;
   onarcgisNoRenderPropChange?: EventHandler<HTMLArcgisChartElement["arcgisNoRenderPropChange"]>;
+  onarcgisRenderingComplete?: EventHandler<HTMLArcgisChartElement["arcgisRenderingComplete"]>;
   onarcgisRuntimeError?: EventHandler<HTMLArcgisChartElement["arcgisRuntimeError"]>;
   onarcgisSelectionComplete?: EventHandler<HTMLArcgisChartElement["arcgisSelectionComplete"]>;
   onarcgisSeriesColorChange?: EventHandler<HTMLArcgisChartElement["arcgisSeriesColorChange"]>;

package/dist/types/react.d.ts

@@ -14,6 +14,7 @@ interface ReactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'all
   onarcgisDataProcessError?: EventHandler<HTMLArcgisChartElement["arcgisDataProcessError"]>;
   onarcgisLegendItemVisibilityChange?: EventHandler<HTMLArcgisChartElement["arcgisLegendItemVisibilityChange"]>;
   onarcgisNoRenderPropChange?: EventHandler<HTMLArcgisChartElement["arcgisNoRenderPropChange"]>;
+  onarcgisRenderingComplete?: EventHandler<HTMLArcgisChartElement["arcgisRenderingComplete"]>;
   onarcgisRuntimeError?: EventHandler<HTMLArcgisChartElement["arcgisRuntimeError"]>;
   onarcgisSelectionComplete?: EventHandler<HTMLArcgisChartElement["arcgisSelectionComplete"]>;
   onarcgisSeriesColorChange?: EventHandler<HTMLArcgisChartElement["arcgisSeriesColorChange"]>;

package/dist/types/stencil.d.ts

@@ -14,6 +14,7 @@ interface StencilArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'a
   onArcgisDataProcessError?: EventHandler<HTMLArcgisChartElement["arcgisDataProcessError"]>;
   onArcgisLegendItemVisibilityChange?: EventHandler<HTMLArcgisChartElement["arcgisLegendItemVisibilityChange"]>;
   onArcgisNoRenderPropChange?: EventHandler<HTMLArcgisChartElement["arcgisNoRenderPropChange"]>;
+  onArcgisRenderingComplete?: EventHandler<HTMLArcgisChartElement["arcgisRenderingComplete"]>;
   onArcgisRuntimeError?: EventHandler<HTMLArcgisChartElement["arcgisRuntimeError"]>;
   onArcgisSelectionComplete?: EventHandler<HTMLArcgisChartElement["arcgisSelectionComplete"]>;
   onArcgisSeriesColorChange?: EventHandler<HTMLArcgisChartElement["arcgisSeriesColorChange"]>;

package/dist/utils/misc/interfaces.d.ts

@@ -1,4 +1,4 @@
-import { ISimpleFillSymbol, ISimpleMarkerSymbol, ISimpleLineSymbol, Color, WebChartDataItem, WebChartPieChartGroupSlice, WebChartPieChartSlice } from '../../spec';
+import { ISimpleFillSymbol, ISimpleMarkerSymbol, ISimpleLineSymbol, Color, WebChartDataItem, WebChartPieChartGroupSlice, WebChartPieChartSlice, WebChartHeatChartHeatRulesTypes } from '../../spec';
 export declare const ChartSubType: {
     readonly NonSpecific: "nonSpecific";
     readonly BarAndLineNoAggregation: "barAndLineNoAggregation";
@@ -53,6 +53,18 @@ export interface LoaderColors {
     curtainColor?: Color;
     spinnerColor?: Color;
 }
+export interface HeatSeriesColorChangePayload {
+    heatRulesType: WebChartHeatChartHeatRulesTypes | undefined;
+    seriesColors: HeatSeriesColorChangePayloadClassSymbols[] | HeatSeriesColorChangePayloadGradient | undefined;
+}
+export interface HeatSeriesColorChangePayloadGradient {
+    startColor: readonly [number, number, number, number];
+    endColor: readonly [number, number, number, number];
+}
+export type HeatSeriesColorChangePayloadClassSymbols = {
+    label: string;
+    symbol: ISimpleFillSymbol;
+};
 export type BoxPlotSymbols = {
     fillSymbol?: ISimpleFillSymbol;
 } | {

package/dist/utils/types/index.d.ts

@@ -61,6 +61,7 @@ export declare const ChartComponentEvents: {
     readonly SeriesOrder: "arcgisSeriesOrder";
     readonly RuntimeError: "arcgisRuntimeError";
     readonly ConfigChange: "arcgisConfigChange";
+    readonly RenderingComplete: "arcgisRenderingComplete";
 };
 export declare const DefaultChartActions: {
     readonly FilterBySelection: "filterBySelection";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/charts-components",
-  "version": "5.0.0-next.68",
+  "version": "5.0.0-next.69",
   "description": "Reusable ArcGIS charting Web Components.",
   "type": "module",
   "main": "dist/index.js",
@@ -28,8 +28,8 @@
   "dependencies": {
     "@amcharts/amcharts4": "^4.10.31",
     "@amcharts/amcharts5": "~5.14.4",
-    "@arcgis/lumina": "5.0.0-next.68",
-    "@arcgis/toolkit": "5.0.0-next.68",
+    "@arcgis/lumina": "5.0.0-next.69",
+    "@arcgis/toolkit": "5.0.0-next.69",
     "ajv": "6.12.6",
     "d3-array": "^3.2.1",
     "d3-shape": "^3.2.0",