@arcgis/charts-components 4.34.0-next.83 → 4.34.0-next.85

package/dist/utils/layer/query-features/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-import { WebChartCalendarBasedBinning, WebChartDataItem, WebChartFixedDateBinning, WebChartQuery } from '@arcgis/charts-spec';
+import { WebBoxPlot, WebChart, WebChartCalendarBasedBinning, WebChartDataItem, WebChartFixedDateBinning, WebChartQuery, WebHeatChart } from '@arcgis/charts-spec';
 import { default as AttributeBinsFeatureSet } from '@arcgis/core/rest/support/AttributeBinsFeatureSet.js';
 import { ChartSubType } from '../../misc/interfaces';
 import { QueryObject } from '../interfaces';
@@ -30,6 +30,19 @@ export declare function getQueryAttributeBinsForScatterplotFieldsAlias(x: string
     upperBoundaryAlias: string;
     stackAlias: string;
 };
+/**
+ * Fetches and returns the heat chart data using query(Attribute)Bins
+ * @param props.chartConfig The chart configuration
+ * @param props.queryObject The object used to query (FL or FLV)
+ * @param props.queryConfig The query configuration
+ * @param props.errorStrings The t9n error strings
+ */
+export declare function queryAttributeBinsForHeatChart(props: {
+    chartConfig: WebBoxPlot | WebChart | WebHeatChart;
+    queryObject: QueryObject;
+    queryConfig: WebChartQuery;
+    errorStrings: ErrorStrings;
+}): Promise<AttributeBinsFeatureSet | undefined>;
 /**
  * Uses query(Attribute)Bins to fetch the aggregated scatterplot data
  * @param props.queryObject The object used to query (FL or FLV)

package/dist/utils/layer/query-parser/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-import { SupportedLayer, WebChartCalendarBasedBinning, WebChartFixedDateBinning, WebChartQuery } from '@arcgis/charts-spec';
+import { SupportedLayer, WebChartCalendarBasedBinning, WebChartFixedDateBinning, WebChartHeatChartSeries, WebChartQuery } from '@arcgis/charts-spec';
 import { default as Geometry } from '@arcgis/core/geometry/Geometry';
 import { default as AttributeBinsQuery } from '@arcgis/core/rest/support/AttributeBinsQuery.js';
 import { default as Query } from '@arcgis/core/rest/support/Query.js';
@@ -69,6 +69,23 @@ export declare function mapAttributeBinsQueryForTemporalData(props: {
     dateField: string;
     splitByField?: string;
 }): Promise<AttributeBinsQuery>;
+/**
+ * Maps properties from a WebChartQuery and properties specific to heat chart into an AttributeBinsQuery object.
+ * @param props.queryObject The layer or feature layer view
+ * @param props.queryConfig The query configuration
+ * @param props.x The x field
+ * @param props.y The y field
+ * @param props.xTemporalBinning The x temporal binning configuration
+ * @param props.yTemporalBinning The y temporal binning configuration
+ */
+export declare function mapAttributeBinsQueryForHeatChart(props: {
+    queryObject?: QueryObject;
+    queryConfig?: WebChartQuery;
+    x: string;
+    y: string;
+    xTemporalBinning?: WebChartHeatChartSeries["xTemporalBinning"];
+    yTemporalBinning?: WebChartHeatChartSeries["yTemporalBinning"];
+}): Promise<AttributeBinsQuery>;
 /**
  * Maps properties from a WebChartQuery and properties specific to temporal binning into an AttributeBinsQuery object.
  * @param props.queryObject The layer or feature layer view

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

@@ -49,6 +49,12 @@ export declare function getMainLayer(layer: SupportedLayer | undefined): Feature
  * @returns A boolean
  */
 export declare function doesLayerSupportQueryWithDistance(layer: SupportedLayer): boolean;
+/**
+ * Indicates whether a layer supports the queryBins operation for the heat chart use case.
+ * @param layer The layer to test
+ * @returns A boolean indicating whether the operation is supported
+ */
+export declare function doesLayerSupportsQueryBinsForHeatChart(layer: SupportedLayer): boolean;
 /**
  * Indicates whether a layer supports the queryBins operation for the temporal data use case.
  * We currently only use the "date" operation.

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

@@ -1,10 +1,10 @@
 import { IField, LegendItemVisibility, WebBoxPlot, WebChart, WebChartDataItem, WebChartDataItemValue, WebChartSeries, WebChartStackedKinds, OverlayTerms, WebChartSortOrderKinds, WebChartTemporalBinningUnits, WebChartTypes } from '@arcgis/charts-spec';
 import { ChartElementLimit } from '../defaults/interfaces';
 import { SelectionData, ChartSubType } from './interfaces';
-type WebChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.GaugeSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
+type WebChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.GaugeSeries | typeof WebChartTypes.HeatChartSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
 type XYChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
 type SerialChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries;
-type SupportedChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
+type SupportedChartType = typeof WebChartTypes.BarSeries | typeof WebChartTypes.BoxPlotSeries | typeof WebChartTypes.HeatChartSeries | typeof WebChartTypes.HistogramSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.PieSeries | typeof WebChartTypes.RadarSeries | typeof WebChartTypes.ScatterSeries;
 export type ChartTypes = Extract<WebChartTypes, WebChartType>;
 export type XYChartTypes = Extract<WebChartTypes, XYChartType>;
 export type SerialChartTypes = Extract<WebChartTypes, SerialChartType>;

package/dist/utils/type-guards/index.d.ts

@@ -1,7 +1,7 @@
-import { CategoryFormatOptions, DateTimeFormatOptions, IFeatureLayer, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, NumberFormatOptions, WebBoxPlot, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartDataTypes, WebChartGenericDataItem, WebChartHistogramDataItem, WebChartLineChartSeries, WebChartRadarChartSeries, WebChartScatterplotDataItem, WebChartSeries, WebChartStackedKinds, WebChartTextSymbol, WebGaugeChart } from '@arcgis/charts-spec';
+import { CategoryFormatOptions, DateTimeFormatOptions, IFeatureLayer, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, NumberFormatOptions, WebBoxPlot, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartDataTypes, WebChartGenericDataItem, WebChartHistogramDataItem, WebChartLineChartSeries, WebChartRadarChartSeries, WebChartScatterplotDataItem, WebChartSeries, WebChartStackedKinds, WebChartTextSymbol, WebGaugeChart, WebHeatChart } from '@arcgis/charts-spec';
+import { ModelTypes } from '../../model';
 import { ChartTypes } from '../misc';
 import { ChartConfig } from '../types';
-import { ModelTypes } from '../../model';
 export type StringIndexable<T> = Record<string, unknown> & T;
 /**
  * Web chart series with rotated property
@@ -53,7 +53,7 @@ export declare function isWebChartTextSymbol(symbol: any): symbol is WebChartTex
  * Determines if the provided `config` has a `iLayer` property.
  * @param config
  */
-export declare function hasILayer<T extends ModelTypes>(config: ChartConfig<T> | undefined): config is ChartConfig<T, T extends "boxPlot" ? WebBoxPlot : T extends "gauge" ? WebGaugeChart : WebChart>;
+export declare function hasILayer<T extends ModelTypes>(config: ChartConfig<T> | undefined): config is ChartConfig<T, T extends "boxPlot" ? WebBoxPlot : T extends "gauge" ? WebGaugeChart : T extends "heatChart" ? WebHeatChart : WebChart>;
 export declare function hasILayer(config: WebChart | undefined): config is WebChart & {
     iLayer: IFeatureLayer;
 };

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

@@ -1,4 +1,4 @@
-import { WebBoxPlot, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHistogramSeries, WebChartLegend, WebChartLineChartSeries, WebChartPieChartLegend, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebGaugeChart } from '@arcgis/charts-spec';
+import { WebBoxPlot, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHistogramSeries, WebChartLegend, WebChartLineChartSeries, WebChartPieChartLegend, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries, WebGaugeChart, WebHeatChart } from '@arcgis/charts-spec';
 import { ModelTypes, ModelTypeToSeriesType } from '../../model/interfaces/common';
 /**
  * Interface to hold action bar props
@@ -112,7 +112,7 @@ export type SupportedChartSeries = WebChartBarChartSeries | WebChartBoxPlotSerie
  * @template T - The series type. It can be any of the supported chart series types.
  * @template V - The chart type. This acts as the base type for the configuration. Default type is derived from the series type.
  */
-export type ChartConfig<T extends ModelTypes = ModelTypes, V extends WebChart = T extends typeof ModelTypes.BoxPlot ? WebBoxPlot : T extends typeof ModelTypes.Gauge ? WebGaugeChart : WebChart> = Omit<V, "legend" | "series"> & {
+export type ChartConfig<T extends ModelTypes = ModelTypes, V extends WebChart = T extends typeof ModelTypes.BoxPlot ? WebBoxPlot : T extends typeof ModelTypes.Gauge ? WebGaugeChart : T extends typeof ModelTypes.HeatChart ? WebHeatChart : WebChart> = Omit<V, "legend" | "series"> & {
     series: ModelTypeToSeriesType<T>[];
     legend?: T extends typeof ModelTypes.PieChart ? WebChartPieChartLegend : WebChartLegend;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/charts-components",
-  "version": "4.34.0-next.83",
+  "version": "4.34.0-next.85",
   "description": "Reusable ArcGIS charting Web Components.",
   "type": "module",
   "main": "dist/index.js",
@@ -29,9 +29,9 @@
   "dependencies": {
     "@amcharts/amcharts4": "^4.10.31",
     "@amcharts/amcharts5": "^5.13.4",
-    "@arcgis/charts-spec": "4.34.0-next.83",
-    "@arcgis/lumina": "4.34.0-next.83",
-    "@arcgis/toolkit": "4.34.0-next.83",
+    "@arcgis/charts-spec": "4.34.0-next.85",
+    "@arcgis/lumina": "4.34.0-next.85",
+    "@arcgis/toolkit": "4.34.0-next.85",
     "ajv": "6.12.6",
     "d3-array": "^3.2.1",
     "d3-shape": "^3.2.0",

package/dist/cdn/2IX5CZ6W.js

@@ -1,4 +0,0 @@
-/*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
-See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.83 */
-import{a as u}from"./6GKDU24J.js";import{a as f}from"./PWTW5KEN.js";import{a as v}from"./25PLA3VA.js";import a from"./CP73YRYJ.js";import"./UPCSBKAM.js";import{a as g}from"./RITGLDP3.js";import"./6637CXXO.js";import{C as p,E as C,g as d,h as s,l as r,y as m,z as o}from"./XO6F3WZU.js";import"./SK2VKNTD.js";import"./CSJO3HB3.js";export default $arcgis.t(([])=>{var n={addChartContainer:"add-chart-container",viewChartComponent:"view-chart-component",header:"header",dropdownPopup:"dropdown-popup"},$=d`.view-chart-component{width:var(--arcgis-charts-config-panel-width);height:var(--arcgis-charts-config-panel-height)}.add-chart-container{display:flex;justify-content:center;padding:2rem 0;background-color:var(--calcite-color-background)}.header{margin-left:1rem}.dropdown-popup{position:relative}`,l=class extends m{constructor(){super(...arguments),this._messages=g(),this.chartRenamePopover=null,this.popoverClose=()=>{let e=this.modelList?.find(t=>t.getChartId()===this.selectedChartId);this.chartTitle=e?.getTitleText()??"",this.selectedActionChartId="",this.removeChartRenamePopover()},this.onChartRename=e=>{this.disableEditing||(this.chartTitle=e.detail.name,this.modelList?.find(t=>t.getChartId()===this.selectedActionChartId)?.setTitleText(this.chartTitle),this.selectedActionChartId="",this.removeChartRenamePopover())},this.onModelConfigChange=()=>{this.requestUpdate()},this.onCalciteListOrderChange=e=>{if(e.detail!==null&&e.detail!==void 0){let{newIndex:t,oldIndex:i}=e.detail;if(this.modelList!==void 0&&this.modelList?.length>0){let a=[...this.modelList],c=a?.[i],h=a?.[t];c&&h&&(a.splice(i,1),a.splice(t,0,c)),this.arcgisChartsConfigModelListReorder.emit({modelList:a})}}},this.chartTitle="",this.noGroup=!1,this.disableEditing=!1,this.arcgisChartsConfigModelListReorder=r(),this.arcgisChartsConfigViewChartAddChart=r(),this.arcgisChartsConfigViewChartDelete=r(),this.arcgisChartsConfigViewChartEdit=r(),this.arcgisChartsConfigViewChartSelect=r()}static{this.properties={isChartRenamePopoverOpen:16,chartTitle:16,selectedActionChartId:16,messageOverrides:0,selectedChartId:3,layer:0,modelList:2,noGroup:7,disableEditing:7}}static{this.styles=$}willUpdate(e){e.has("modelList")&&this.modelListChange(this.modelList,e.get("modelList"))}disconnectedCallback(){super.disconnectedCallback(),this.removeChartRenamePopover()}modelListChange(e,t){t?.forEach(i=>{i.removeEventListener("arcgisChartsModelConfigChange",this.onModelConfigChange)}),e?.forEach(i=>{i.addEventListener("arcgisChartsModelConfigChange",this.onModelConfigChange)})}onAddChartClick(e){e.stopImmediatePropagation(),this.arcgisChartsConfigViewChartAddChart.emit({referenceElement:e.target,layerId:this.layer?.id.toString()})}buildChartList(){let e=this.modelList?f(this.modelList,t=>t.getChartId(),(t,i)=>{let a=t.getChartId(),c=t.getTitleText(),h=u(t.getConfig());return s`<calcite-list-item .label=${c??a??this._messages.chartTitle} .selected=${this.selectedChartId===(a?.toString()??i.toString())} .value=${a??i.toString()} @click=${this.onChartSelect}><calcite-icon slot=content-start .icon=${h}></calcite-icon>${this.disableEditing?null:s`<calcite-dropdown slot=actions-end overlay-positioning=fixed placement=bottom-end @calciteDropdownClose=${()=>this.chartActionClosed(a??"")} @calciteDropdownOpen=${()=>this.chartActionOpened(a??"")} class=${o(n.dropdownPopup)}><calcite-action scale=l .text=${this._messages.chartActions??""} slot=trigger .active=${a===this.selectedActionChartId}><calcite-icon icon=ellipsis></calcite-icon></calcite-action><calcite-dropdown-group selection-mode=none><calcite-dropdown-item accesskey=edit @calciteDropdownItemSelect=${this.chartEditSelect}>${this._messages.edit}</calcite-dropdown-item><calcite-dropdown-item accesskey=rename @click=${w=>w.stopPropagation()} @calciteDropdownItemSelect=${this.chartRenameSelect}>${this._messages.rename}</calcite-dropdown-item><calcite-dropdown-item accesskey=delete @calciteDropdownItemSelect=${this.chartDeleteSelect}>${this._messages.delete}</calcite-dropdown-item></calcite-dropdown-group></calcite-dropdown>`}</calcite-list-item>`}):null;return this.layer?s`<div>${this.noGroup?null:s`<p class=${o(n.header)}>${this.layer.title??this.layer.id.toString()}</p>`}<calcite-list label .dragEnabled=${!this.disableEditing} selection-mode=single selection-appearance=border @calciteListOrderChange=${this.onCalciteListOrderChange}>${e}${this.disableEditing?null:s`<div class=${o(n.addChartContainer)}><calcite-fab slot=fab appearance=outline-fill kind=neutral text-enabled .text=${this._messages.addChart} .label=${this._messages.addChart} @click=${this.onAddChartClick} scale=s></calcite-fab></div>`}</calcite-list></div>`:null}onChartSelect(e){let t=e.currentTarget,i;t?.localName==="calcite-list-item"?i=t.value:t?.localName==="calcite-icon"&&(i=t.parentNode.value),this.arcgisChartsConfigViewChartSelect.emit({chartId:i})}chartEditSelect(){this.disableEditing||(this.arcgisChartsConfigViewChartEdit.emit({chartId:this.selectedActionChartId}),this.chartActionClosed(this.selectedActionChartId))}chartRenameSelect(e){if(!this.disableEditing){let t=e.target.closest("calcite-list-item"),i=this.modelList?.find(a=>a.getChartId()===this.selectedActionChartId);t!==null&&(this.renameReferenceElement=t),this.arcgisChartsConfigViewChartSelect.emit({chartId:this.selectedActionChartId}),this.chartTitle=i?.getTitleText()??"",this.setupRenamePopover()}}chartDeleteSelect(){this.disableEditing||(this.arcgisChartsConfigViewChartDelete.emit({chartId:this.selectedActionChartId}),this.selectedActionChartId="")}chartActionClosed(e){e===this.selectedActionChartId&&!this.isChartRenamePopoverOpen&&(this.selectedActionChartId="")}chartActionOpened(e){this.selectedActionChartId=e}setupRenamePopover(){this.isChartRenamePopoverOpen=!0,this.chartRenamePopover!==null&&(this.chartRenamePopover.name=this.chartTitle,this.chartRenamePopover.referenceElement=this.renameReferenceElement),this.chartRenamePopover=p(s`<arcgis-charts-config-chart-rename-popover .name=${this.chartTitle} .referenceElement=${this.renameReferenceElement} .open=${this.isChartRenamePopoverOpen} @arcgisChartsConfigPopoverClose=${this.popoverClose} @arcgisChartsConfigChartRenamePopoverChange=${this.onChartRename}></arcgis-charts-config-chart-rename-popover>`),!document.body.contains(this.chartRenamePopover)&&this.chartRenamePopover!==null&&document.body.appendChild(this.chartRenamePopover)}removeChartRenamePopover(){this.chartRenamePopover!==null&&(this.isChartRenamePopoverOpen=!1,this.chartRenamePopover=v(this.chartRenamePopover))}render(){return s`<div class=${o(n.viewChartComponent)}>${this.buildChartList()}</div>`}};C("arcgis-charts-config-view-charts",l);return l},"geometry/support/jsonUtils","rest/support/AttributeBinsQuery","rest/support/Query","rest/support/StatisticDefinition","time/TimeExtent","core/promiseUtils","request",a)