@arcgis/charts-components 5.0.0-next.17 → 5.0.0-next.171

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

@@ -1,5 +1,9 @@
-import { ISimpleFillSymbol, ISimpleMarkerSymbol, ISimpleLineSymbol, Color, WebChartDataItem, WebChartPieChartGroupSlice, WebChartPieChartSlice } from '../../spec';
-export declare const ChartSubType: {
+import type { WebChartHeatChartHeatRulesTypes } from "../../spec/chart-object-literals.js";
+import type { WebChartDataItem } from "../../spec/data-source.js";
+import type { Color, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol } from "../../spec/rest-js-types.js";
+import type { WebChartPieChartGroupSlice, WebChartPieChartSlice } from "../../spec/web-chart.js";
+
+export const ChartSubType: {
     readonly NonSpecific: "nonSpecific";
     readonly BarAndLineNoAggregation: "barAndLineNoAggregation";
     readonly BarAndLineMonoField: "barAndLineMonoField";
@@ -18,70 +22,95 @@ export declare const ChartSubType: {
     readonly BoxPlotMultiFieldsAndSplitBy: "boxPlotMultiFieldsAndSplitBy";
     readonly BoxPlotMonoFieldAndCategoryAndSplitBy: "boxPlotMonoFieldAndCategoryAndSplitBy";
 };
+
 export type ChartSubType = (typeof ChartSubType)[keyof typeof ChartSubType];
-export declare const SelectionSource: {
+
+export const SelectionSource: {
     readonly SelectionByClick: "SelectionByClick";
     readonly SelectionByRange: "SelectionByRange";
     readonly ProgrammaticSelection: "ProgrammaticSelection";
     readonly ClearSelection: "ClearSelection";
 };
+
 export type SelectionSource = (typeof SelectionSource)[keyof typeof SelectionSource];
-export type SelectionIndexes = Map<number, {
-    indexesToSelect?: number[];
-}>;
+
+export type SelectionIndexes = Map<number, { indexesToSelect?: number[]; }>;
+
 export interface SelectionData {
-    selectionItems?: WebChartDataItem[];
-    selectionIndexes?: SelectionIndexes;
-    selectionOIDs?: number[];
-    selectionSource?: SelectionSource;
+  selectionItems?: WebChartDataItem[];
+  selectionIndexes?: SelectionIndexes;
+  selectionOIDs?: (number | string)[];
+  selectionSource?: SelectionSource;
 }
+
 export interface SelectionThemeProperties {
-    elementColor?: Color;
-    elementOutlineColor?: Color;
-    elementOutlineWidth?: number;
-    rotation?: number;
-    transformation?: {
-        opacity?: number;
-        scale?: number;
-    };
+  elementColor?: Color;
+  elementOutlineColor?: Color;
+  elementOutlineWidth?: number;
+  rotation?: number;
+  transformation?: {
+      opacity?: number;
+      scale?: number;
+  };
 }
+
 export interface SelectionTheme {
-    selectedElementsTheme?: SelectionThemeProperties;
-    nonSelectedElementsTheme?: SelectionThemeProperties;
+  selectedElementsTheme?: SelectionThemeProperties;
+  nonSelectedElementsTheme?: SelectionThemeProperties;
 }
+
 export interface LoaderColors {
-    curtainColor?: Color;
-    spinnerColor?: Color;
+  curtainColor?: Color;
+  spinnerColor?: Color;
 }
-export type BoxPlotSymbols = {
-    fillSymbol?: ISimpleFillSymbol;
-} | {
+
+export interface HeatSeriesColorChangePayload {
+  heatRulesType?: WebChartHeatChartHeatRulesTypes;
+  seriesColors?: HeatSeriesColorChangePayloadClassSymbols[] | HeatSeriesColorChangePayloadGradient;
+}
+
+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; } | {
     lineSymbol: ISimpleLineSymbol;
     markerSymbol?: ISimpleMarkerSymbol;
 };
+
 export type LineChartSymbols = {
-    lineSymbol: ISimpleLineSymbol;
-    markerSymbol?: ISimpleMarkerSymbol;
+  lineSymbol: ISimpleLineSymbol;
+  markerSymbol?: ISimpleMarkerSymbol;
 };
+
 export type SeriesSymbols = BoxPlotSymbols | ISimpleFillSymbol | ISimpleLineSymbol | ISimpleMarkerSymbol | LineChartSymbols | PieSlicesSymbols;
+
 /**
  * Type used to provide information regarding a pie chart's slices:
- * - `slices` contains an array of `WebChartPieChartSlice` related to the non-grouped slices
- * - `groupedSlices` contains an array of `WebChartPieChartSlice` related to the non-visible grouped slices
- * - `groupOfSlices` contains a `WebChartPieChartSlice`related to the group of slices
+ * - `slices` contains an array of `WebChartPieChartSlice` related to the non-grouped slices.
+ * - `groupedSlices` contains an array of `WebChartPieChartSlice` related to the non-visible grouped slices.
+ * - `groupOfSlices` contains a `WebChartPieChartSlice`related to the group of slices.
+ *
  * The `WebChartPieChartSlice` contains information regarding a slice's id, symbol and label.
  */
 export type PieSlicesSymbols = {
-    slices: WebChartPieChartSlice[];
-    groupedSlices?: WebChartPieChartSlice[];
-    groupOfSlices?: WebChartPieChartGroupSlice;
+  slices: WebChartPieChartSlice[];
+  groupedSlices?: WebChartPieChartSlice[];
+  groupOfSlices?: WebChartPieChartGroupSlice;
 };
+
 /**
  * Map containing a chart's series symbols.
  * The numeric key is the series' position in the series array.
  * The value is either:
- *   - a fill symbol (bar chart and histogram)
- *   - a marker symbol (scatterplot)
- *   - an object containing a line symbol and a marker symbol (line chart)
+ *   - A fill symbol (bar chart and histogram).
+ *   - A marker symbol (scatterplot).
+ *   - An object containing a line symbol and a marker symbol (line chart).
  */
-export type SeriesSymbolsMap = Map<number, SeriesSymbols | undefined>;
+export type SeriesSymbolsMap = Map<number, SeriesSymbols | undefined>;

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

@@ -1,128 +1,229 @@
-import { CategoryFormatOptions, DateTimeFormatOptions, IFeatureLayer, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, NumberFormatOptions, WebBoxPlot, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartDataTypes, WebChartGenericDataItem, WebChartHistogramDataItem, WebChartLineChartSeries, WebChartRadarChartSeries, WebChartScatterplotDataItem, WebChartSeries, WebChartStackedKinds, WebChartTextSymbol, WebGaugeChart, WebHeatChart } from '../../spec';
-import { ModelTypes } from '../../model';
-import { ChartTypes } from '../misc';
-import { ChartConfig } from '../types';
-export type StringIndexable<T> = Record<string, unknown> & T;
+import type { ModelTypes } from "../../model/interfaces/common.js";
+import type { WebChartStackedKinds } from "../../spec/chart-object-literals.js";
+import type { WebChartDataTypes, WebChartGenericDataItem, WebChartHistogramDataItem, WebChartScatterplotDataItem } from "../../spec/data-source.js";
+import type { IFeatureLayer, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol } from "../../spec/rest-js-types.js";
+import type { CategoryFormatOptions, DateTimeFormatOptions, NumberFormatOptions, WebBoxPlot, WebChart, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries, WebChartSeries, WebChartTextSymbol, WebGaugeChart, WebHeatChart } from "../../spec/web-chart.js";
+import type { ChartTypes } from "../misc/index.js";
+import type { ChartConfig } from "../types/index.js";
+
+/** @internal */
+export type StringIndexable<T> = Record<string, unknown>
+  & T;
+
 /**
  * Web chart series with rotated property
+ *
+ * @internal
  */
-export type WebChartSeriesWithRotatedProp = WebChartSeries & {
-    rotated?: boolean;
+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
+ * @internal
  */
-export declare function isRotationSupported(config: WebChart): config is WebChart & {
-    series: WebChartSeriesWithRotatedProp[];
-};
+export function isRotationSupported(config: WebChart): config is WebChart & { series: WebChartSeriesWithRotatedProp[]; };
+
 /**
  * Web chart series with stackedType property
+ *
+ * @internal
  */
-type WebChartSeriesWithStackedTypeProp = WebChartSeries & {
-    stackedType?: WebChartStackedKinds;
+export 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
+ * @internal
  */
-export declare function isStackedTypeSupported(config: WebChart): config is WebChart & {
-    series: WebChartSeriesWithStackedTypeProp[];
-};
+export function isStackedTypeSupported(config: WebChart): config is WebChart & { series: WebChartSeriesWithStackedTypeProp[]; };
+
 /**
- * Type guard for ISimpleFillSymbol
+ * Type guard for `ISimpleFillSymbol`
+ *
  * @param symbol
+ * @internal
  */
-export declare function isSFS(symbol: any): symbol is ISimpleFillSymbol;
+export function isSFS(symbol: any): symbol is ISimpleFillSymbol;
+
 /**
- * Type guard for ISimpleLineSymbol
+ * Type guard for `ISimpleLineSymbol`
+ *
  * @param symbol
+ * @internal
  */
-export declare function isSLS(symbol: any): symbol is ISimpleLineSymbol;
+export function isSLS(symbol: any): symbol is ISimpleLineSymbol;
+
 /**
- * Type guard for ISimpleMarkerSymbol
+ * Type guard for `ISimpleMarkerSymbol`
+ *
  * @param symbol
+ * @internal
  */
-export declare function isSMS(symbol: any): symbol is ISimpleMarkerSymbol;
+export function isSMS(symbol: any): symbol is ISimpleMarkerSymbol;
+
 /**
- * Type guard for WebChartTextSymbol
+ * Type guard for `WebChartTextSymbol`
+ *
  * @param symbol
+ * @internal
  */
-export declare function isWebChartTextSymbol(symbol: any): symbol is WebChartTextSymbol;
+export function isWebChartTextSymbol(symbol: any): symbol is WebChartTextSymbol;
+
 /**
  * Determines if the provided `config` has a `iLayer` property.
+ *
  * @param config
+ * @internal
  */
-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;
-};
+export 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>;
+
+/**
+ * @param config
+ * @internal
+ */
+export function hasILayer(config: WebChart | undefined): config is WebChart & { iLayer: IFeatureLayer; };
+
+/**
+ * @param config
+ * @internal
+ */
+export function hasILayer<T extends ModelTypes>(config: ChartConfig<T> | undefined): unknown;
+
 /**
  * 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.
+ * @internal
  */
-export declare function isChartType<T extends ChartConfig>(config: WebChart | undefined, chartType: ChartTypes | undefined): config is T;
+export 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.
+ * @internal
  */
-export declare function isBoxPlotSeries(series: WebChartSeries | undefined): series is WebChartBoxPlotSeries;
+export 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.
+ * @internal
  */
-export declare function isLineChartSeries(series: WebChartSeries | undefined): series is WebChartLineChartSeries;
-export declare function isRadarChartSeries(series: WebChartSeries | undefined): series is WebChartRadarChartSeries;
+export function isLineChartSeries(series: WebChartSeries | undefined): series is WebChartLineChartSeries;
+
+/**
+ * Determines if the series is a radar chart series.
+ *
+ * @param series - The series to check.
+ * @internal
+ */
+export 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.
+ * @internal
  */
-export declare function isBarChartSeries(series: WebChartSeries | undefined): series is WebChartBarChartSeries;
+export 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[]}
+ * Determines if the series is a heat chart series.
+ *
+ * @param series - | undefined} series The series to check.
+ * @internal
  */
-export declare const isBarChartSeriesArray: (series: WebChartSeries[]) => series is WebChartBarChartSeries[];
+export function isHeatChartSeries(series: WebChartSeries | undefined): series is WebChartHeatChartSeries;
+
 /**
- * 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 `BarChartSeries`.
+ *
+ * @param series - The series to check.
+ * @internal
  */
-export declare const isLineChartSeriesArray: (series: WebChartSeries[]) => series is WebChartLineChartSeries[];
+export function isBarChartSeriesArray(series: WebChartSeries[]): series is WebChartBarChartSeries[];
+
 /**
- * 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 `LineChartSeries`.
+ *
+ * @param series - The series to check.
+ * @internal
  */
-export declare const isRadarChartSeriesArray: (series: WebChartSeries[]) => series is WebChartRadarChartSeries[];
+export function isLineChartSeriesArray(series: WebChartSeries[]): series is WebChartLineChartSeries[];
+
+/**
+ * Type guard to check if the series is a `RadarChartSeries`.
+ *
+ * @param series - The series to check.
+ * @internal
+ */
+export function isRadarChartSeriesArray(series: WebChartSeries[]): series is WebChartRadarChartSeries[];
+
+/**
+ * Type guard to check if the series is a HeatChartSeries.
+ *
+ * @param series - series - The series to check.
+ * @returns {series is WebChartHeatChartSeries[]}
+ * @internal
+ */
+export function isHeatChartSeriesArray(series: WebChartSeries[]): series is WebChartHeatChartSeries[];
+
 /**
  * Determines if the series array is of type box plot series.
- * @param series The series to check.
+ *
+ * @param series - The series to check.
+ * @internal
  */
-export declare function isBoxPlotSeriesArray(series: WebChartSeries[]): series is WebChartBoxPlotSeries[];
+export 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
+ * @internal
  */
-export declare function isNumberFormatOptions(valueFormat: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined): valueFormat is NumberFormatOptions;
+export 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
+ * @internal
  */
-export declare function isWebChartHistogramDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartHistogramDataItem | undefined;
+export 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
+ * @internal
  */
-export declare function isWebChartGenericDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartGenericDataItem | undefined;
+export 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
+ * @internal
  */
-export declare function isWebChartScatterplotDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartScatterplotDataItem | undefined;
-export declare function isValueAxisDataItem<T extends object>(axisDataItem: T): axisDataItem is T & {
-    value: number;
-};
-export {};
+export function isWebChartScatterplotDataItemOrUndefined(data: WebChartDataTypes | undefined): data is WebChartScatterplotDataItem | undefined;
+
+/**
+ * TODO: Once charts-shared-utils is merged into charts-components, we can create a more official version of this type-guard using the AmCharts types.
+ *
+ * @param axisDataItem
+ * @internal
+ */
+export function isValueAxisDataItem<T extends object>(axisDataItem: T): axisDataItem is T & { value: number; };

package/dist/utils/type-guards/series-types.d.ts

@@ -1,31 +1,38 @@
-import { WebChartCalendarDatePartsBinning, WebChartHeatChartSeries, WebChartSeries, WebChartTemporalBinning } from '../../spec';
-import { ChartTypes } from '../misc';
+import type { WebChartCalendarDatePartsBinning, WebChartHeatChartSeries, WebChartSeries, WebChartTemporalBinning } from "../../spec/web-chart.js";
+import type { ChartTypes } from "../misc/index.js";
+
 /**
  * Determines if a Set of series type matches a combo bar-line chart
- * @param uniqueTypes The set of unique series types
+ *
+ * @param uniqueTypes - The set of unique series types
+ * @internal
  */
-declare function isComboLineAndBarChart(uniqueTypes: Set<string>): boolean | undefined;
+export function isComboLineAndBarChart(uniqueTypes: Set<string>): boolean | undefined;
+
 /**
  * Determines if a Set of series type matches a box plot
- * @param uniqueTypes The set of unique series types
+ *
+ * @param uniqueTypes - The set of unique series types
+ * @internal
  */
-declare function isBoxPlotChart(uniqueTypes: Set<string>): boolean;
+export function isBoxPlotChart(uniqueTypes: Set<string>): boolean;
+
 /**
  * Getting the type of a chart or series. If the input parameters are incorrect (empty array of series, or a mix of unknown/unallowed series types) the function returns `undefined`.
  * To get the series type, a valid seriesIndex is required. Otherwise, the type of a chart is determined and returned.
- * @param chartSeries The array of chart's series
- * @param seriesIndex An index to get a specific series' type.  A valid index is required if the goal is to get the type of the series.
+ *
+ * @param chartSeries - The array of chart's series
+ * @param seriesIndex - An index to get a specific series' type.  A valid index is required if the goal is to get the type of the series.
+ * @internal
  */
-export declare function getChartOrSeriesType(chartSeries: WebChartSeries[] | undefined, seriesIndex?: number): ChartTypes | undefined;
+export function getChartOrSeriesType(chartSeries: WebChartSeries[] | undefined, seriesIndex?: number): ChartTypes | undefined;
+
 /**
  * Gets the binning type for a heat chart from the provided chart series.
- * @param chartSeries The heat chart series to check
- * @param isXAxis An indicator to find the associated binning type for the x-axis or y-axis
+ *
+ * @param chartSeries - The heat chart series to check
+ * @param isXAxis - An indicator to find the associated binning type for the x-axis or y-axis
  * @returns The binning type for the specified axis
+ * @internal
  */
-export declare function getHeatChartBinningType(chartSeries: WebChartHeatChartSeries | undefined, isXAxis?: boolean): WebChartCalendarDatePartsBinning | WebChartTemporalBinning | undefined;
-export declare const typeGuardsPrivateFunctions: {
-    isComboLineAndBarChart: typeof isComboLineAndBarChart;
-    isBoxPlotChart: typeof isBoxPlotChart;
-};
-export {};
+export function getHeatChartBinningType(chartSeries: WebChartHeatChartSeries | undefined, isXAxis?: boolean): WebChartCalendarDatePartsBinning | WebChartTemporalBinning | undefined;