@arcgis/charts-components 5.0.0-next.136 → 5.0.0-next.138

package/dist/model/shared/type-guards.d.ts

@@ -1,130 +1,172 @@
-import { ChartModelBase } from '../chart-model/chart-model-base';
-import { HeatChartModel } from '../heat-chart-model/heat-chart-model';
-import { BarChartModel } from '../bar-chart-model/bar-chart-model';
-import { BoxPlotModel } from '../box-plot-model/box-plot-model';
-import { ChartModel } from '../chart-model/chart-model';
-import { ComboBarLineChartModel } from '../combo-bar-line-chart-model/combo-bar-line-chart-model';
-import { GaugeModel } from '../gauge-model/gauge-model';
-import { HistogramModel } from '../histogram-model/histogram-model';
-import { ModelTypes, ModelOfType } from '../interfaces/common';
-import { LineChartModel } from '../line-chart-model/line-chart-model';
-import { PieChartLegendModel } from '../pie-chart-model/pie-chart-legend-model';
-import { PieChartModel } from '../pie-chart-model/pie-chart-model';
-import { ScatterplotModel } from '../scatterplot-model/scatterplot-model';
-import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
-import { WebChart } from '../../spec/web-chart';
-import { ModelWithMultiAxes } from '../mixins/model-with-multi-axes';
-import { ModelWithLineMarkerStyling } from '../mixins/model-with-line-marker-styling';
-import { ModelWithTooltips } from '../mixins/model-with-tooltips';
-import { ModelWithGuides } from '../mixins/model-with-guides';
-import { ModelWithXGuides } from '../mixins/model-with-x-guides';
-import { ModelWithYGuides } from '../mixins/model-with-y-guides';
-import { ModelWithLegend } from '../mixins/model-with-legend';
-import { ModelWithTemporalBinning } from '../mixins/model-with-temporal-binning';
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+import type { HeatChartModel } from "../heat-chart-model/heat-chart-model.js";
+import type { BarChartModel } from "../bar-chart-model/bar-chart-model.js";
+import type { BoxPlotModel } from "../box-plot-model/box-plot-model.js";
+import type { ChartModel } from "../chart-model/chart-model.js";
+import type { ComboBarLineChartModel } from "../combo-bar-line-chart-model/combo-bar-line-chart-model.js";
+import type { GaugeModel } from "../gauge-model/gauge-model.js";
+import type { HistogramModel } from "../histogram-model/histogram-model.js";
+import type { ModelTypes, ModelOfType } from "../interfaces/common.js";
+import type { LineChartModel } from "../line-chart-model/line-chart-model.js";
+import type { PieChartLegendModel } from "../pie-chart-model/pie-chart-legend-model.js";
+import type { PieChartModel } from "../pie-chart-model/pie-chart-model.js";
+import type { ScatterplotModel } from "../scatterplot-model/scatterplot-model.js";
+import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
+import type { WebChart } from "../../spec/web-chart.js";
+import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
+import type { ModelWithLineMarkerStyling } from "../mixins/model-with-line-marker-styling.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
+import type { ModelWithGuides } from "../mixins/model-with-guides.js";
+import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
+import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
+import type { ModelWithLegend } from "../mixins/model-with-legend.js";
+import type { ModelWithTemporalBinning } from "../mixins/model-with-temporal-binning.js";
+
 /**
  * Determines if the provided model or config is a `ChartModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isChartModel(model: ChartModel | WebChart | undefined): model is ChartModel;
+export function isChartModel(model: ChartModel | WebChart | undefined): model is ChartModel;
+
 /**
  * Determines if the provided `model` is of type `BarChartModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isBarChartModel(model: ChartModelBase | undefined): model is BarChartModel;
+export function isBarChartModel(model: ChartModelBase | undefined): model is BarChartModel;
+
 /**
  * Determines if the provided `model` is of type `LineChartModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isLineChartModel(model: ChartModelBase | undefined): model is LineChartModel;
+export function isLineChartModel(model: ChartModelBase | undefined): model is LineChartModel;
+
 /**
  * Determines if the provided `model` is of type `ComboBarLineChartModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isComboBarLineChartModel(model: ChartModelBase | undefined): model is ComboBarLineChartModel;
+export function isComboBarLineChartModel(model: ChartModelBase | undefined): model is ComboBarLineChartModel;
+
 /**
  * Determines if the provided `model` is of type `SerialChartModel`.
  * This includes LineSeries, BarSeries, ComboLineAndBarSeries, and RadarSeries.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isSerialChartModel(model: ChartModelBase | undefined): model is SerialChartModel;
+export function isSerialChartModel(model: ChartModelBase | undefined): model is SerialChartModel;
+
 /**
  * Determines if the provided `model` is of type `PieChartModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isPieChartModel(model: ChartModelBase | undefined): model is PieChartModel;
+export function isPieChartModel(model: ChartModelBase | undefined): model is PieChartModel;
+
 /**
  * Determines if the provided `model` is of type `BoxPlotModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isBoxPlotModel(model: ChartModelBase | undefined): model is BoxPlotModel;
+export function isBoxPlotModel(model: ChartModelBase | undefined): model is BoxPlotModel;
+
 /**
  * Determines if the provided `model` is of type `ScatterplotModel`.
- * @param model The model to check.
  *
+ * @param model - The model to check.
  */
-export declare function isScatterplotModel(model: ChartModelBase | undefined): model is ScatterplotModel;
+export function isScatterplotModel(model: ChartModelBase | undefined): model is ScatterplotModel;
+
 /**
  * Determines if the provided `model` is of type `HistogramModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isHistogramModel(model: ChartModelBase | undefined): model is HistogramModel;
+export function isHistogramModel(model: ChartModelBase | undefined): model is HistogramModel;
+
 /**
  * Determines if the provided `model` is of type `HeatChartModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isHeatChartModel(model: ChartModelBase | undefined): model is HeatChartModel;
+export function isHeatChartModel(model: ChartModelBase | undefined): model is HeatChartModel;
+
 /**
  * Determines if the provided `model` is of type `GaugeModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isGaugeModel(model: ChartModelBase | undefined): model is GaugeModel;
+export function isGaugeModel(model: ChartModelBase | undefined): model is GaugeModel;
+
 /**
  * Type guard for ModelWithMultiAxes
+ *
  * @param model
  */
-export declare function isModelWithMultiAxes(model: ChartModel | undefined): model is ModelWithMultiAxes;
+export function isModelWithMultiAxes(model: ChartModel | undefined): model is ModelWithMultiAxes;
+
 /**
  * Type guard for ModelWithLineMarkerStyling
+ *
  * @param model
  */
-export declare function isModelWithLineMarkerStyling(model: ChartModel | undefined): model is ModelWithLineMarkerStyling;
+export function isModelWithLineMarkerStyling(model: ChartModel | undefined): model is ModelWithLineMarkerStyling;
+
 /**
  * Type guard for ModelWithTooltips
+ *
  * @param model
  */
-export declare function isModelWithTooltips(model: ChartModel | undefined): model is ModelWithTooltips;
+export function isModelWithTooltips(model: ChartModel | undefined): model is ModelWithTooltips;
+
 /**
  * Determines if the provided `model` is of type `ModelWithGuides`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isModelWithGuides(model: ChartModel | undefined): model is ModelWithGuides;
+export function isModelWithGuides(model: ChartModel | undefined): model is ModelWithGuides;
+
 /**
  * Determines if the provided `model` is of type `ModelWithXGuides`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isModelWithXGuides(model: ChartModel | undefined): model is ModelWithXGuides;
+export function isModelWithXGuides(model: ChartModel | undefined): model is ModelWithXGuides;
+
 /**
  * Determines if the provided `model` is of type `ModelWithYGuides`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isModelWithYGuides(model: ChartModel | undefined): model is ModelWithYGuides;
+export function isModelWithYGuides(model: ChartModel | undefined): model is ModelWithYGuides;
+
 /**
  * Determines if the provided `model` is of type `ModelWithLegend`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isModelWithLegend(model: ChartModel | undefined): model is ModelWithLegend;
+export function isModelWithLegend(model: ChartModel | undefined): model is ModelWithLegend;
+
 /**
  * Determines if the provided `model` is of type `PieChartLegendModel`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isPieChartLegendModel(model: ChartModel | undefined): model is PieChartLegendModel;
+export function isPieChartLegendModel(model: ChartModel | undefined): model is PieChartLegendModel;
+
 /**
  * Determines if the provided `model` is of type `ModelWithTemporalBinning`.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
  */
-export declare function isModelWithTemporalBinning(model: ChartModel | undefined): model is ModelWithTemporalBinning;
+export function isModelWithTemporalBinning(model: ChartModel | undefined): model is ModelWithTemporalBinning;
+
 /**
  * Determines if the provided model's type matches the `type` argument.
- * @param model The model to check.
+ *
+ * @param model - The model to check.
+ * @param type
  */
-export declare function isModelOfType<T extends ModelTypes | undefined>(model: ChartModel | undefined, type: T): model is ModelOfType<T>;
+export function isModelOfType<T extends ModelTypes | undefined>(model: ChartModel | undefined, type: T): model is ModelOfType<T>;

package/dist/model/shared/utils.d.ts

@@ -1,58 +1,4 @@
-import { SupportedLayer } from '../../interfaces';
-import { IField, WebChart, WebChartAxis, WebChartGaugeAxis, WebHeatChart } from '../../spec';
-import { ChartConfig } from '../../utils';
-import { LayerInfo, SplitByFieldInfos } from '../interfaces/common';
-/**
- * Returns the necessary information for building series based on a split-by field.
- *
- * @param props.config The chart config
- * @param props.layer The layer instance
- * @param props.layerFieldsInfo Fields Information of the layer
- * @param props.splitByField Split-By field
- * @param props.aggregationFields Numerical fields
- * @param props.aggregationType Aggregation type
- * @param props.fetchNullValues Whether to fetch null values
- */
-export declare function getSplitByFieldInfos(props: {
-    config?: WebChart;
-    layer?: SupportedLayer;
-    layerFieldsInfo: IField[];
-    xAxisField?: string;
-    splitByField: string;
-    aggregationFields: string[];
-    fetchNullValues?: boolean;
-}): Promise<SplitByFieldInfos>;
-export declare function isWebGaugeChartAxis(params: WebChartAxis[] | [WebChartGaugeAxis] | undefined): params is [WebChartGaugeAxis];
-export declare function isValidSplitByField(layerFieldsInfo: IField[], splitByField: string): boolean;
-export declare function isValidNumericFields(layerFieldsInfo: IField[], numericFields: string[]): boolean;
-type AbstractConstructor = abstract new (...args: any) => any;
 export type MixinInstances<T extends readonly AbstractConstructor[]> = T extends readonly [infer H, ...infer R] ? H extends AbstractConstructor ? R extends readonly AbstractConstructor[] ? InstanceType<H> & MixinInstances<R> : InstanceType<H> : unknown : unknown;
-/**
- * Runtime helper that copies prototype members from each mixin constructor onto the target.
- *
- * Accepts a readonly tuple so it lines up with the typed mixin lists used in MixinInstances.
- *
- * [source](https://www.typescriptlang.org/docs/handbook/mixins.html)
- */
-export declare function applyMixins(derivedCtor: any, constructors: readonly AbstractConstructor[]): void;
-/**
- * Get the list of category's values or labels from the layer.
- *
- * @param props.layerInfo The layer information
- * @param props.config The chart configuration
- * @param props.category The category
- */
-export declare function getCategoryLabels(props: {
-    layerInfo: LayerInfo;
-    config: WebChart;
-    category: string;
-}): Promise<string[]>;
-/**
- * Checks if the given chart config is a matrix heat chart.  A matrix heat chart is defined as a heat chart with
- * both axes using a category value format.
- *
- * @param chartConfig The chart config
- * @returns True if the chart is a matrix heat chart, false otherwise
- */
-export declare function isMatrixHeatChart(chartConfig?: ChartConfig | WebHeatChart): boolean;
-export {};
+
+/** @param args */
+export type AbstractConstructor = abstract new(...args: any) => any;

package/dist/model.js

@@ -4,7 +4,7 @@ import { v as r, w as s, x as n } from "./chunks/type-guards.js";
 import { a as P, f as B, i as x, c as v, k as G, j as H, h as K, b as W, u as D, o as F, r as O, m as E, l as R, t as Y, n as $, p as j, q, s as A, e as X, g as z, d as I } 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.136 */
+v5.0.0-next.138 */
 async function c(t) {
   const o = "config" in t ? r(t.config) : t.chartType;
   let a;