@arcgis/charts-components 5.0.0-next.90 → 5.0.0-next.91

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

@@ -196,34 +196,39 @@ export declare function getOrderByComponents(stringToParse: string, useDefault?:
 };
 /**
  * Gets the fields listed in the `orderByFields` property of a chart config.
- * @param {WebChart} chartConfig -  The chart config
- * @returns {string[]} The list of fields to sort by
+ *
+ * @param chartConfig -  The chart config
+ * @returns The list of fields to sort by
  */
 export declare function getOrderByFields(chartConfig: WebChart): string[];
 /**
  * Determines if certain chart subtype is a split by chart.
- * @param chartSubType The chart subtype
- * @returns true if the chart subtype is a split by chart, false otherwise
+ *
+ * @param chartSubType - The chart subtype
+ * @returns `true` if the chart subtype is a split by chart, `false` otherwise
  */
 export declare function isSplitByChart(chartSubType: ChartSubType): boolean;
 /**
  * Util function to know if the selection data changed.
  * The selection items and selection OIDs are compared, not the selection source nor the selection indexes.
- * @param selectionA The first selection data
- * @param selectionB The second selection data
+ *
+ * @param selectionA - The first selection data
+ * @param selectionB - The second selection data
  * @returns a boolean indicating whether the two selections are equal
  */
 export declare function hasSelectionChanged(selectionA?: SelectionData, selectionB?: SelectionData): boolean;
 /**
  * Indicates whether the selection data is empty.
- * @param selectionData The selection data to check
+ *
+ * @param selectionData - The selection data to check
  */
 export declare function isSelectionEmpty(selectionData: SelectionData | undefined): boolean;
 /**
- * Sorts arrayA based on the indexes of the elements in arrayB
- * @param {T[]} props.arrayA - The array to be sorted
- * @param {T[]} props.arrayB - The array to be used for sorting
- * @param {function} props.getKey - The function to get the key of an item
+ * Sorts `arrayA` based on the indexes of the elements in `arrayB`.
+ *
+ * @param props.arrayA - The array to be sorted
+ * @param props.arrayB - The array to be used for sorting
+ * @param props.getKey - The function to get the key of an item
  */
 export declare function sortArrayAUsingArrayB<T, K>(props?: {
     arrayA: T[];

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

@@ -10,7 +10,8 @@ export type WebChartSeriesWithRotatedProp = WebChartSeries & {
     rotated?: boolean;
 };
 /**
- * Check if the chart config supports rotation or not
+ * Check if the chart config supports rotation or not.
+ *
  * @param config - the chart config
  */
 export declare function isRotationSupported(config: WebChart): config is WebChart & {
@@ -23,35 +24,31 @@ type WebChartSeriesWithStackedTypeProp = WebChartSeries & {
     stackedType?: WebChartStackedKinds;
 };
 /**
- * Check if the chart config supports rotation or not
+ * Check if the chart config supports rotation or not.
+ *
  * @param config - the chart config
  */
 export declare function isStackedTypeSupported(config: WebChart): config is WebChart & {
     series: WebChartSeriesWithStackedTypeProp[];
 };
 /**
- * Type guard for ISimpleFillSymbol
- * @param symbol
+ * Type guard for `ISimpleFillSymbol`
  */
 export declare function isSFS(symbol: any): symbol is ISimpleFillSymbol;
 /**
- * Type guard for ISimpleLineSymbol
- * @param symbol
+ * Type guard for `ISimpleLineSymbol`
  */
 export declare function isSLS(symbol: any): symbol is ISimpleLineSymbol;
 /**
- * Type guard for ISimpleMarkerSymbol
- * @param symbol
+ * Type guard for `ISimpleMarkerSymbol`
  */
 export declare function isSMS(symbol: any): symbol is ISimpleMarkerSymbol;
 /**
- * Type guard for WebChartTextSymbol
- * @param symbol
+ * Type guard for `WebChartTextSymbol`
  */
 export declare function isWebChartTextSymbol(symbol: any): symbol is WebChartTextSymbol;
 /**
  * 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 : T extends "heatChart" ? WebHeatChart : WebChart>;
 export declare function hasILayer(config: WebChart | undefined): config is WebChart & {
@@ -59,66 +56,80 @@ export declare function hasILayer(config: WebChart | undefined): config is WebCh
 };
 /**
  * Determines if the provided `config` is the specified chart type `T`.
- * @param config The chart config to check.
- * @param chartType The chart type to check against.
+ *
+ * @param config - The chart config to check.
+ * @param chartType - The chart type to check against.
  */
 export declare function isChartType<T extends ChartConfig>(config: WebChart | undefined, chartType: ChartTypes | undefined): config is T;
 /**
  * Determines if the series is a box plot series.
- * @param series The series to check.
+ *
+ * @param series - The series to check.
  */
 export declare function isBoxPlotSeries(series: WebChartSeries | undefined): series is WebChartBoxPlotSeries;
 /**
  * Determines if the series is a line chart series.
- * @param series The series to check.
+ *
+ * @param series - The series to check.
  */
 export declare function isLineChartSeries(series: WebChartSeries | undefined): series is WebChartLineChartSeries;
+/**
+ * Determines if the series is a radar chart series.
+ *
+ * @param series - The series to check.
+ */
 export declare function isRadarChartSeries(series: WebChartSeries | undefined): series is WebChartRadarChartSeries;
 /**
  * Determines if the series is a bar chart series.
- * @param series The series to check.
+ *
+ * @param series - The series to check.
  */
 export declare function isBarChartSeries(series: WebChartSeries | undefined): series is WebChartBarChartSeries;
 /**
- * Type guard to check if the series is a BarChartSeries.
- * @param {WebChartSeries[]} series - The series to check.
- * @returns {series is WebChartBarChartSeries[]}
+ * Type guard to check if the series is a `BarChartSeries`.
+ *
+ * @param series - The series to check.
  */
 export declare const isBarChartSeriesArray: (series: WebChartSeries[]) => series is WebChartBarChartSeries[];
 /**
- * Type guard to check if the series is a LineChartSeries.
- * @param {WebChartSeries[]} series - The series to check.
- * @returns {series is WebChartLineChartSeries[]}
+ * Type guard to check if the series is a `LineChartSeries`.
+ *
+ * @param series - The series to check.
  */
 export declare const isLineChartSeriesArray: (series: WebChartSeries[]) => series is WebChartLineChartSeries[];
 /**
- * Type guard to check if the series is a RadarChartSeries.
- * @param {WebChartSeries[]} series - The series to check.
- * @returns {series is WebChartLineChartSeries[]}
+ * Type guard to check if the series is a `RadarChartSeries`.
+ *
+ * @param series - The series to check.
  */
 export declare const isRadarChartSeriesArray: (series: WebChartSeries[]) => series is WebChartRadarChartSeries[];
 /**
  * Determines if the series array is of type box plot series.
- * @param series The series to check.
+ *
+ * @param series - The series to check.
  */
 export declare function isBoxPlotSeriesArray(series: WebChartSeries[]): series is WebChartBoxPlotSeries[];
 /**
- * Type guard for axis format being NumberFormatOptions
+ * Type guard for axis format being `NumberFormatOptions`
+ *
  * @param valueFormat - valueFormat to check
  */
 export declare function isNumberFormatOptions(valueFormat: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined): valueFormat is NumberFormatOptions;
 /**
- * Type guard for WebChartDataTypes being WebChartHistogramDataItem
+ * Type guard for `WebChartDataTypes` being `WebChartHistogramDataItem`.
+ *
  * @param data - dataItem to check
  */
 export declare function isWebChartHistogramDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartHistogramDataItem | undefined;
 /**
- * Type guard for WebChartDataTypes being WebChartGenericDataItem
+ * Type guard for `WebChartDataTypes` being `WebChartGenericDataItem`.
+ *
  * @param data - dataItem to check
  */
 export declare function isWebChartGenericDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartGenericDataItem | undefined;
 /**
- * Type guard for WebChartDataTypes being WebChartScatterplotDataItem
+ * Type guard for `WebChartDataTypes` being `WebChartScatterplotDataItem`.
+ *
  * @param data - dataItem to check
  */
 export declare function isWebChartScatterplotDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartScatterplotDataItem | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/charts-components",
-  "version": "5.0.0-next.90",
+  "version": "5.0.0-next.91",
   "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.90",
-    "@arcgis/toolkit": "5.0.0-next.90",
+    "@arcgis/lumina": "5.0.0-next.91",
+    "@arcgis/toolkit": "5.0.0-next.91",
     "ajv": "6.12.6",
     "d3-array": "^3.2.1",
     "d3-shape": "^3.2.0",