@arcgis/charts-components 5.1.0-next.65 → 5.1.0-next.67

package/dist/utils/chart-config/utils/index.d.ts

@@ -7,6 +7,7 @@ import type { DataUpdateDetails } from "../../data/interfaces.js";
 import type { QueryObjectOrRaster as QueryObject } from "../../layer/interfaces.js";
 import type { ChartSubType } from "../../misc/interfaces.js";
 import type { WebChartSeriesSupportingTemporalBinning } from "./interfaces.js";
+import type { DataOrderParameters } from "../../../chart-rendering/common/data/utils/summarize-data/interfaces.js";
 
 /**
  * Retrieve and construct chart version information based on the input version and the currently supported ArcGIS Chart versions
@@ -427,4 +428,24 @@ export function doesConfigChangeRequireNewData(props: {
  * @returns The updated chart config with the series sorted, or undefined if the input config is undefined
  * @internal
  */
-export function sortConfigSeries<T extends WebChart | undefined>(chartConfig: T, chartContainer?: HTMLElement): T;
+export function sortConfigSeries<T extends WebChart | undefined>(chartConfig: T, chartContainer?: HTMLElement): T;
+
+/**
+ * Constructs the `sortingField`, `orderBy`, and/or optionally `preferLabel` for sorting the chart data.
+ *
+ * @param chartConfig - The chart configuration
+ * @returns An array of objects with sortingField, optionally an orderBy and preferLabel, or undefined.
+ */
+export function getDataOrderParameters(chartConfig: WebChart): DataOrderParameters[] | undefined;
+
+/**
+ * Returns true if the data order instructions (orderType or sortingField, orderBy, and/or preferLabel) have changed, or
+ * the data update is needed.
+ *
+ * @param props - The previous chart config
+ */
+export function isNewSortNeeded(props: {
+    oldConfig: WebChart;
+    newConfig: WebChart;
+    dataWasUpdated: boolean;
+}): boolean;

package/dist/utils/chart-config/validator/index.d.ts

@@ -1,4 +1,4 @@
-import type { QueryObjectOrRaster as QueryObject } from "../../layer/interfaces.js";
+import type { QueryObjectOrRaster } from "../../layer/interfaces.js";
 import type { ValidationStatus } from "./interfaces.js";
 import type { WebChart, WebGaugeChart } from "../../../spec/web-chart.js";
 
@@ -13,7 +13,7 @@ import type { WebChart, WebGaugeChart } from "../../../spec/web-chart.js";
  */
 export function validateWebChart(props: {
     input?: WebChart | WebGaugeChart;
-    queryObject?: QueryObject;
+    queryObject?: QueryObjectOrRaster;
     allowUsingObjectIdStat?: boolean;
 }): Promise<ValidationStatus>;
 

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

@@ -172,6 +172,42 @@ export function whetherLogScaleIsDataCompatible(props: {
     chartData?: WebChartBin[] | WebChartDataItem[];
 }): boolean;
 
+/**
+ * This function reassigns the category/field name and stat value to the series x and y, while deleting the
+ * technical field used during the rendering for technical reasons.
+ *
+ * @param modifiedData - The data to revert
+ * @param seriesConfig - The series config
+ */
+export function revertPieFromFieldsProperties<T extends WebChartDataItem[] | WebChartDataTypes>(modifiedData: T, seriesConfig?: WebChart["series"]): T;
+
+/**
+ * This function reverts some changes done to process the chart's data set:
+ * - removes the formatted dates used specifically for the queries
+ * - switches back the values of the modified dates/categories to accommodate the rendering (axis labels, sort...)
+ *
+ * @param data - The data containing modified x or y values
+ * @param seriesConfig - The series config
+ */
+export function revertOriginalXAndYValues<T extends WebChartDataItem[] | WebChartDataTypes>(data: T, seriesConfig?: WebChart["series"]): T;
+
+/**
+ * Removes some technical properties including color ones from a data item
+ *
+ * @param dataItem - The data item to sanitize
+ * @returns The sanitized data item
+ */
+export function removeAdditionalStatisticsPerItem(dataItem: WebChartDataItem): WebChartDataItem;
+
+/**
+ * Before sending the event payload containing the data, we need to revert some changes done to sort the charts.
+ *
+ * @param data - The data set to modify
+ * @param seriesConfig - The series config
+ * @returns The sanitized data
+ */
+export function removeAdditionalStatistics(data: WebChartDataTypes, seriesConfig: WebChartSeriesType[]): WebChartDataTypes;
+
 /**
  * Rounds a number to a given number of decimals
  *
@@ -189,4 +225,15 @@ export const dataPrivateFunctions: {
         chartData: Array<WebChartDataItem> | Array<WebChartBin>;
         axisConfigIndex: number;
     }) => boolean;
-};
+};
+
+/**
+ * Sanitizes data by reverting technical changes made to the data set.
+ * The point is to send meaningful data to the user through events or the `chartWillRender()` function.
+ *
+ * @param props - The data to sanitize
+ */
+export function sanitizeData(props: {
+    data?: WebChartDataTypes;
+    seriesConfig: WebChartSeriesType[];
+}): WebChartDataTypes | undefined;

package/dist/utils/data/pie-chart/index.d.ts

@@ -0,0 +1,31 @@
+import type { WebChartDataItem } from "../../../spec/data-source.js";
+import type { WebChart, WebChartPieChartSeries } from "../../../spec/web-chart.js";
+import type { UtilsStrings } from "../../localization/interfaces.js";
+import type { DataInfo } from "../interfaces.js";
+
+/**
+ * Builds the data necessary for the pie chart group of slices.
+ *
+ * @param props - the dataset
+ * @internal
+ */
+export function getPieChartGroupOfSlicesData(props: {
+    data: WebChartDataItem[];
+    seriesConfig: WebChartPieChartSeries[];
+    utilsStrings: UtilsStrings;
+}): WebChartDataItem[];
+
+/**
+ * Updates the provided dataset with data related to the pie chart group of slices.
+ *
+ * @param props - indicates whether the chart is being created (true) or updated (false)
+ * @internal
+ */
+export function updatePieChartGroupOfSlicesData(props: {
+    creation: boolean;
+    previousConfig: WebChart | undefined;
+    newConfig: WebChart | undefined;
+    dataInfo: DataInfo;
+    dataUpdateNeeded: boolean;
+    utilsStrings: UtilsStrings;
+}): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/charts-components",
-  "version": "5.1.0-next.65",
+  "version": "5.1.0-next.67",
   "description": "Reusable ArcGIS charting Web Components.",
   "type": "module",
   "main": "dist/index.js",
@@ -40,8 +40,8 @@
     "simple-statistics": "^7.8.8",
     "tslib": "^2.8.1",
     "uuid": "^11.1.0",
-    "@arcgis/lumina": "5.1.0-next.65",
-    "@arcgis/toolkit": "5.1.0-next.65"
+    "@arcgis/lumina": "5.1.0-next.67",
+    "@arcgis/toolkit": "5.1.0-next.67"
   },
   "peerDependencies": {
     "@arcgis/core": "^5.1.0-next",

package/dist/cdn/2R7GVZ2K.js

@@ -1,2 +0,0 @@
-/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import{p as E}from"./YJXIGYX6.js";import a from"./QQ6DOFHZ.js";import{a as m,b as x,f as h,h as O,y as L}from"./ETLJKITO.js";export default $arcgis.t(([,,,,,,,,,{substitute:P},,,,,,,,,,,{$c:I,Cc:b,Ga:j,Gb:T,Ib:F,Mb:k,Pc:v,R:w,T:A,Ub:C,V:q,gd:M,hd:V,ia:B,le:N,me:H,u:S,ud:$}])=>{function be(a,e,i){let t=a?.axes?.[e];t?.title!==void 0?t.title.content.text=i:t!==void 0&&(t.title=A({text:i,visible:!0,font:w(S.AxisTitle)}))}function ve(a){let{config:e,layerInfo:i,commonStrings:t,numericFields:r,aggregationType:s}=a,o="";if(e)if(T(e)===h.Stacked100)o=t.utilsStrings.statistics.percent;else{let l=j(s,t);if(e.series[0]?.type===m.HeatSeries)o=F(i.layerFieldsInfo,e.series[0].y);else if(r.length===1){let g=F(i.layerFieldsInfo,r[0]),n=I(i.layer).idField;s===x.NoAggregation?o=g:s===x.Count&&n!==void 0&&r[0]===n?o=t.utilsStrings.statistics.count:o=P(t.axisLabels.aggregationOfFieldName,{aggregation:l,fieldName:g})}else r.length>1&&(s===x.NoAggregation?o=t.axisLabels.values:o=P(t.axisLabels.aggregationOfValues,{aggregation:l}))}return o}var G=(a,e,i)=>a.axes?.[e]??B(i,a.type)[e],J=a=>{let{config:e,axis:i,axisIndex:t}=a;e.axes!==void 0&&(e.axes[t]=i)},Ie=a=>{let{config:e,axisIndex:i,isMax:t}=a,r=Number.NaN;return t?r=e.axes?.[i]?.maximum:r=e.axes?.[i]?.minimum,r??Number.NaN},U=a=>{let{config:e,value:i,axisIndex:t,isMax:r}=a,s=e?.axes?.[t];s!==void 0&&(r?s.maximum=i:s.minimum=i)},Ne=a=>a.axes?.[0]?.valueFormat??q(),he=(a,e,i)=>{let t=G(a,0,e);if(t!==void 0&&i!==void 0){let r={...t,valueFormat:i};J({config:a,axis:r,axisIndex:0})}},Oe=(a,e,i)=>{let t=a.axes?.[e];t!==void 0&&(t.integerOnlyValues=i)},W=a=>{let e=L(a.series);return e===m.BarSeries||e===m.ComboLineAndBarSeries||e===m.LineSeries},R=a=>{let{axisIndex:e,config:i,isMultiAxis:t}=a,r=!1;return e===0||e===1&&t?r=!0:e===2&&(r=W(i)),r},Le=a=>{let{axisIndex:e,func:i,config:t}=a;return R({axisIndex:e,config:t,isMultiAxis:!0})?i(e):void 0},D=(a,e)=>{let i,t=e.axes?.[a]?.valueFormat;return(a===0||a>=1&&E(t))&&(i=t),i},Se=a=>{let{config:e,commonStrings:i,valueFormat:t,axisIndex:r=0}=a,s=G(e,r,i);if(s!==void 0&&t!==void 0){let o={...s,valueFormat:t};J({config:e,axis:o,axisIndex:r})}},we=(a,e)=>a.axes?.[e]?.isLogarithmic??!1,Ae=a=>{let{config:e,isLogarithmic:i,axisIndex:t}=a,r=e.axes?.[t];r&&(r.isLogarithmic=i,U({config:e,value:null,axisIndex:t,isMax:!0}),U({config:e,value:null,axisIndex:t,isMax:!1}))},qe=a=>{let{config:e,scrollbar:i,axisIndex:t}=a;e.axes?.[t]!==void 0&&(e.axes[t].scrollbar=i)};async function Be(a){let{config:e,layer:i,xAxisField:t,splitByField:r,layerFieldsInfo:s,aggregationFields:o,fetchNullValues:l}=a,g=s.filter(y=>y.name===r)[0]?.type,n=l!==!0?`${r} IS NOT NULL`:"",d=t&&l!==!0?`${t} IS NOT NULL`:"",{where:u}=e?.dataFilters??{},K={where:v([u,n,d]),orderByFields:k(r)?[]:[`${r} ${O.Ascending}`],geometry:e?.dataFilters?.geometry},p="";o.length===0?p=I(i).idField:[p]=o;let f=i?b(i)?await H({layer:i,category:e?.series[0].x??"",splitByField:r}):await N({queryObject:i,category:e?.series[0].x??"",splitByField:r,queryConfig:K}):[];if(f=f.slice(0,500),e){let y=e?.series.map(c=>$({where:c.query?.where})?.toString()??"").filter(c=>c!==void 0&&c!=="");f=C({arrayA:f,arrayB:y,getKey:c=>c===null?null:c?.toString()})}return{categoriesArray:f,splitByFieldType:g,numericalField:p}}function je(a,e){let i=e==="";for(let t of a)if(e===t.name){i=!0;break}return i}function Te(a,e){let i=M(a),t=e.length===0,r=0;for(let s of e){for(let o of i)if(s===o&&(r+=1),r===e.length){t=!0;break}if(t)break}return t}function ke(a,e){e.forEach(i=>{Object.getOwnPropertyNames(i.prototype).forEach(t=>{Object.defineProperty(a.prototype,t,Object.getOwnPropertyDescriptor(i.prototype,t)||Object.create(null))})})}async function Ce(a){let{layerInfo:e,config:i,category:t}=a,{layer:r}=e,{where:s}=i?.dataFilters??{},{fetchNullValues:o}=i?.series?.[0]?.query??{},l=o!==!0?`${t} IS NOT NULL`:"",g={where:v([s,l]),orderByFields:[],geometry:i?.dataFilters?.geometry},n;return b(r)?n=[]:n=(await N({queryObject:r,category:t,queryConfig:g})).map(d=>{let u=String(d);return V({queryObject:e.layer,fieldName:t,fieldValue:u})??u}),n}function Me(a){return a!==void 0&&D(0,a)?.type===m.CategoryAxisFormat&&D(1,a)?.type===m.CategoryAxisFormat}return{a:be,b:ve,c:Ie,d:U,e:Ne,f:he,g:Oe,h:Le,i:D,j:Se,k:we,l:Ae,m:qe,n:Be,o:je,p:Te,q:ke,r:Ce,s:Me}},"geometry/Point","applications/Components/imageryUtils","geometry/Extent","request","Graphic","renderers/support/jsonUtils","symbols/support/symbolUtils","AttributeBinsGraphic","layers/support/CodedValueDomain","intl","layers/support/FeatureFilter","smartMapping/statistics/histogram","smartMapping/statistics/summaryStatistics","core/sql","core/promiseUtils","geometry/support/jsonUtils","rest/support/AttributeBinsQuery","rest/support/Query","rest/support/StatisticDefinition","time/TimeExtent",a)

package/dist/cdn/3LT2GKQ2.js

@@ -1,2 +0,0 @@
-/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import{b as e,c as l,d as o}from"./S5OM65RV.js";import b from"./WWGW24FD.js";import a from"./QQ6DOFHZ.js";import{d,r as h}from"./TCOJQJAP.js";import{a as n,y as S}from"./ETLJKITO.js";export default $arcgis.t(([,,,,,,,,,,,,,,,,,,,,{Bb:p,Cc:B,Kb:g,Tb:x,ke:y,s:E,wd:C},{a:f}])=>{var w=[e.EditChart,e.Legend,e.RotateChart,e.FilterBySelection,e.FilterByExtent,e.Zoom,e.Selection,e.ClearSelection,e.FullExtent,e.SwitchSelection,e.ExportAsCSV,e.ExportAsImage],L=[e.EditChart,e.Legend,e.RotateChart,e.FilterBySelection,e.FilterByExtent,e.Zoom,e.Selection,e.ClearSelection,e.FullExtent,e.SwitchSelection,e.ExportAsImage,e.ExportAsCSV],T=[e.EditChart,e.Legend,e.RotateChart,e.FilterBySelection,e.FilterByExtent,e.Zoom,e.Selection,e.ClearSelection,e.FullExtent,e.SwitchSelection,e.ExportAsImage,e.ExportAsCSV],V=[e.EditChart,e.Legend,e.FilterBySelection,e.FilterByExtent,e.Selection,e.ClearSelection,e.SwitchSelection,e.ExportAsImage,e.ExportAsCSV],Z=[e.EditChart,e.Legend,e.FilterBySelection,e.FilterByExtent,e.Selection,e.ClearSelection,e.SwitchSelection,e.ExportAsImage],M=[e.EditChart,e.Legend,e.FilterBySelection,e.FilterByExtent,e.Zoom,e.Selection,e.ClearSelection,e.FullExtent,e.SwitchSelection,e.ExportAsImage,e.ExportAsCSV],R=[e.EditChart,e.Legend,e.FilterBySelection,e.FilterByExtent,e.Zoom,e.Selection,e.ClearSelection,e.FullExtent,e.SwitchSelection,e.ExportAsImage,e.ExportAsCSV],P=[e.EditChart,e.Legend,e.RotateChart,e.FilterBySelection,e.FilterByExtent,e.Zoom,e.Selection,e.ClearSelection,e.FullExtent,e.SwitchSelection,e.ExportAsImage,e.ExportAsCSV],H=[e.EditChart,e.FilterByExtent,e.ExportAsImage,e.ExportAsCSV];function me(a){switch(a){case n.BarSeries:return w;case n.LineSeries:return L;case n.ComboLineAndBarSeries:return T;case n.PieSeries:return V;case n.HistogramSeries:return M;case n.ScatterSeries:return R;case n.BoxPlotSeries:return P;case n.GaugeSeries:return H;case n.HeatSeries:return Z;default:return[]}}var Ee=(a,i,t)=>{let r=a.target.assignedNodes().find(c=>"legendToggle"in c),s=S(t?.series);return r&&(r.chartType=s,z({actionBar:r,chartComponent:i,config:t})),r};function z(a){let{actionBar:i,chartComponent:t,config:r,isInfoModalDisplayed:s}=a,c=x(t.selectionData),A=r?.legend?r.legend.visible??!0:!1;if(i.chartType=S(r?.series),t.enableConfiguration){let v=i.hiddenActions??[];i.hiddenActions=v.filter(D=>D!==e.EditChart)}i.editChartState=t.enableConfiguration?o.Enabled:o.Disabled;let m=r&&g(r.series);i.legendState=m?o.Enabled:o.Disabled;let b=d(t?.model)&&h(t?.model)?t.model.legendVisibility:A;i.legendToggle=m&&b?l.Active:l.Inactive;let u=d(t?.model)&&f(t.model)?t.model.rotatedState:r?.rotated;i.rotateChartToggle=u?l.Active:l.Inactive;let F=C(r?.series??[])===p.PieFromFields,I=B(t.layer);i.filterBySelectionState=!I&&!F&&(t.filterBySelection===!0||!c&&t.filterByExtent!==!0)?o.Enabled:o.Disabled,i.filterBySelectionToggle=t.filterBySelection===!0?l.Active:l.Inactive,i.filterByExtentState=t.filterByExtent===!0||t.filterBySelection!==!0?o.Enabled:o.Disabled,i.filterByExtentToggle=t.filterByExtent===!0?l.Active:l.Inactive,i.zoomState=t.filterBySelection?o.Disabled:o.Enabled,i.zoomToggle=t.actionMode===E.Zoom?l.Active:l.Inactive,i.selectionState=t.filterBySelection?o.Disabled:o.Enabled,i.selectionToggle=(t.actionMode??i.actionBarSelectionMode)===i.actionBarSelectionMode?l.Active:l.Inactive,i.clearSelectionState=c?o.Disabled:o.Enabled,i.fullExtentState=t.filterBySelection?o.Disabled:o.Enabled,i.switchSelectionState=t.filterBySelection?o.Disabled:o.Enabled,i.exportActionState=s||y(r)?o.Disabled:o.Enabled}return{a:me,b:Ee,c:z}},"geometry/support/jsonUtils","rest/support/AttributeBinsQuery","rest/support/Query","rest/support/StatisticDefinition","time/TimeExtent","core/promiseUtils","request","applications/Components/imageryUtils","geometry/Extent","geometry/Point","Graphic","renderers/support/jsonUtils","symbols/support/symbolUtils","AttributeBinsGraphic","layers/support/CodedValueDomain","intl","layers/support/FeatureFilter","smartMapping/statistics/histogram","smartMapping/statistics/summaryStatistics","core/sql",a,b)