@arcgis/charts-components 5.0.0-next.149 → 5.0.0-next.150

package/dist/model/scatterplot-model/scatterplot-model.d.ts

@@ -1,4 +1,3 @@
-import type { MixinInstances } from "../shared/utils.js";
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { LayerInfo, ModelTypes } from "../interfaces/common.js";
 import type { ChartModel } from "../chart-model/chart-model.js";
@@ -17,13 +16,14 @@ import type { ChartConfig } from "../../utils/types/index.js";
 import type { ScatterplotOverlays, SizePolicy, WebChart } from "../../spec/web-chart.js";
 import type { XYChartTypes } from "../../utils/misc/index.js";
 import type { ISimpleLineSymbol, ISimpleMarkerSymbol } from "../../spec/rest-js-types.js";
-import type { ModelWithMultiAxes as ModelWithMultiAxes2 } from "../mixins/model-with-multi-axes.js";
-import type { ModelWithLegend as ModelWithLegend2 } from "../mixins/model-with-legend.js";
-import type { ModelWithTooltips as ModelWithTooltips2 } from "../mixins/model-with-tooltips.js";
-import type { ModelWithXGuides as ModelWithXGuides2 } from "../mixins/model-with-x-guides.js";
-import type { ModelWithYGuides as ModelWithYGuides2 } from "../mixins/model-with-y-guides.js";
+import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
+import type { ModelWithLegend } from "../mixins/model-with-legend.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
+import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
+import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
 
-export class ScatterplotModel extends ChartModel {
+export class ScatterplotModel extends ScatterplotModelSuperclass {
+  /** Chart type. */
   protected _chartType: XYChartTypes;
   /** Current configuration used for the scatterplot. */
   protected _config: ChartConfig<typeof ModelTypes.Scatterplot, WebChart>;
@@ -36,6 +36,7 @@ export class ScatterplotModel extends ChartModel {
   set additionalTooltipField(value: string[] | string | undefined);
   /** Marker symbol used for the scatterplot points when using a fixed symbol (i.e. no size policy is set). */
   accessor fixedMarkerSymbol: ISimpleMarkerSymbol;
+  /** Grouping of layer-related properties to be passed to external function more compactly. */
   protected layerInfo: LayerInfo;
   /** Line symbol for the linear trend line. */
   accessor linearTrendSymbol: ISimpleLineSymbol;
@@ -51,30 +52,16 @@ export class ScatterplotModel extends ChartModel {
   accessor yAxisField: string;
   /** Generate the proper chart title given the current config. */
   generateChartTitle(): string;
+  /** A function that generates the default config object when creating a new chart. */
   protected generateDefaultConfig(): Omit<ChartConfig<"scatterplot", WebChart>, "iLayer">;
   /** Generate the proper y-axis title given the current config. */
   generateYAxisTitle(): string;
-  /** @param params */
+  /**
+   * Completes the async setup process for the chart model. Must be called before using the model.
+   *
+   * @param params
+   * @async **This method is `async` and must be awaited for the changes to take effect.**
+   */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.Scatterplot>>): Promise<void>;
 }
-
-export interface ScatterplotModel extends MixinInstances<typeof scatterplotMixins> {}
-
-export const scatterplotMixins: readonly [
-    typeof ModelWithMultiAxes2,
-    typeof ModelWithLegend2,
-    typeof ModelWithTooltips2,
-    typeof WithColorMatch,
-    typeof WithDataLabelsVisibility,
-    typeof WithDataLabelsSymbol,
-    typeof ModelWithXGuides2,
-    typeof ModelWithYGuides2,
-    typeof WithXAxisTitleText,
-    typeof WithXAxisLabelsVisibility,
-    typeof WithXAxisTitleVisibility,
-    typeof WithXBounds,
-    typeof WithXAxisTitleSymbol,
-    typeof WithAxisLabelsSymbol,
-    typeof WithAxisLinesSymbol,
-    typeof WithGenerateXAxisTitle
-];
+declare const ScatterplotModelSuperclass: typeof ChartModel & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithYGuides & typeof ModelWithXGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

package/dist/model/serial-chart-model/serial-chart-model.d.ts

@@ -1,6 +1,5 @@
 import type { ChartModel } from "../chart-model/chart-model.js";
 import type { SerialChartConfig } from "../interfaces/chart-interfaces.js";
-import type { MixinInstances } from "../shared/utils.js";
 import type { HeatChartDataSortingKinds, SerialChartDataSortingKinds } from "../interfaces/common.js";
 import type { WithColorMatch } from "../properties/color-match.js";
 import type { WithRotatedState } from "../properties/rotated-state.js";
@@ -18,14 +17,14 @@ import type { SerialChartTypes } from "../../utils/misc/index.js";
 import type { WebChartStatisticType, WebChartStackedKinds } from "../../spec/chart-object-literals.js";
 import type { WebChartDataFilters, WebChartNullCategory } from "../../spec/web-chart.js";
 import type { Color } from "../../spec/rest-js-types.js";
-import type { ModelWithMultiAxes as ModelWithMultiAxes2 } from "../mixins/model-with-multi-axes.js";
-import type { ModelWithLegend as ModelWithLegend2 } from "../mixins/model-with-legend.js";
-import type { ModelWithTooltips as ModelWithTooltips2 } from "../mixins/model-with-tooltips.js";
-import type { ModelWithXGuides as ModelWithXGuides2 } from "../mixins/model-with-x-guides.js";
-import type { ModelWithYGuides as ModelWithYGuides2 } from "../mixins/model-with-y-guides.js";
-import type { ModelWithTemporalBinning as ModelWithTemporalBinning2 } from "../mixins/model-with-temporal-binning.js";
+import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
+import type { ModelWithLegend } from "../mixins/model-with-legend.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
+import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
+import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
+import type { ModelWithTemporalBinning } from "../mixins/model-with-temporal-binning.js";
 
-export abstract class SerialChartModel extends ChartModel {
+export abstract class SerialChartModel extends SerialChartModelSuperclass {
   /** Internal storage of the aggregation type for the chart. */
   protected _aggregationType: WebChartStatisticType;
   /** Current chart type. */
@@ -87,6 +86,7 @@ export abstract class SerialChartModel extends ChartModel {
   protected canUseSynchronousSeriesRebuild(): boolean;
   /** Generate the proper chart title given the current config. */
   generateChartTitle(): string;
+  /** A function that generates the default config object when creating a new chart. */
   protected abstract generateDefaultConfig(): Omit<SerialChartConfig, "iLayer">;
   /** Generate the proper y-axis title given the current config. */
   generateYAxisTitle(): string;
@@ -188,26 +188,4 @@ export abstract class SerialChartModel extends ChartModel {
    */
   updateSeriesFromLayerFilter(): Promise<void>;
 }
-
-export interface SerialChartModel extends MixinInstances<typeof serialChartMixins> {}
-
-export const serialChartMixins: readonly [
-    typeof ModelWithMultiAxes2,
-    typeof ModelWithLegend2,
-    typeof ModelWithTooltips2,
-    typeof WithColorMatch,
-    typeof WithRotatedState,
-    typeof WithDataLabelsVisibility,
-    typeof WithDataLabelsSymbol,
-    typeof ModelWithXGuides2,
-    typeof ModelWithYGuides2,
-    typeof ModelWithTemporalBinning2,
-    typeof WithXAxisTitleText,
-    typeof WithXAxisLabelsVisibility,
-    typeof WithXAxisTitleVisibility,
-    typeof WithXBounds,
-    typeof WithXAxisTitleSymbol,
-    typeof WithAxisLabelsSymbol,
-    typeof WithAxisLinesSymbol,
-    typeof WithGenerateXAxisTitle
-];
+declare const SerialChartModelSuperclass: typeof ChartModel & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithTemporalBinning & typeof ModelWithYGuides & typeof ModelWithXGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithRotatedState & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

package/dist/model.js

@@ -1,115 +1,41 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.0/LICENSE.txt */
-import { M as i } from "./chunks/common.js";
-import { B as m, C as y, F as g, G as C, H as w, L as f, a as u, P as L, b, S as p, T, c as S } from "./chunks/common.js";
-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";
-async function c(t) {
-  const o = "config" in t ? r(t.config) : t.chartType;
-  let a;
-  if (!("layer" in t) && !("iLayer" in t) && "config" in t && t.config.iLayer === void 0)
-    throw new Error(
-      "The source is missing. You can provide it to createModel through either `iLayer`, `layer`, or by setting the `config.iLayer` property."
-    );
-  switch (o) {
-    case i.LineChart: {
-      const { LineChartModel: e } = await import("./chunks/line-chart-model.js");
-      a = new e();
-      break;
-    }
-    case i.ComboBarLineChart: {
-      const { ComboBarLineChartModel: e } = await import("./chunks/combo-bar-line-chart-model.js");
-      a = new e();
-      break;
-    }
-    case i.PieChart: {
-      const { PieChartModel: e } = await import("./chunks/pie-chart-model.js");
-      a = new e();
-      break;
-    }
-    case i.Histogram: {
-      const { HistogramModel: e } = await import("./chunks/histogram-model.js");
-      a = new e();
-      break;
-    }
-    case i.Scatterplot: {
-      const { ScatterplotModel: e } = await import("./chunks/scatterplot-model.js");
-      a = new e();
-      break;
-    }
-    case i.BoxPlot: {
-      const { BoxPlotModel: e } = await import("./chunks/box-plot-model.js");
-      a = new e();
-      break;
-    }
-    case i.Gauge: {
-      const { GaugeModel: e } = await import("./chunks/gauge-model.js");
-      a = new e();
-      break;
-    }
-    case i.RadarChart: {
-      const { RadarChartModel: e } = await import("./chunks/radar-chart-model.js");
-      a = new e();
-      break;
-    }
-    case i.HeatChart: {
-      const { HeatChartModel: e } = await import("./chunks/heat-chart-model.js");
-      a = new e();
-      break;
-    }
-    case i.BarChart:
-    default: {
-      const { BarChartModel: e } = await import("./chunks/bar-chart-model.js");
-      a = new e();
-      break;
-    }
-  }
-  if (await a?.setup({
-    layer: "layer" in t ? t.layer : void 0,
-    iLayer: "iLayer" in t ? t.iLayer : void 0,
-    config: "config" in t ? t.config : void 0
-  }), o !== void 0 && s(a, o))
-    return a;
-  {
-    const e = n(a.chartType);
-    throw new Error(
-      `Please check the arguments provided to \`createModel\`. The generated model's type (\`${e}\`) does not match the type specified by either the \`chartType\` or the \`config\` argument (\`${o}\`).`
-    );
-  }
-}
+import { B as e, C as i, F as t, G as o, H as r, L as l, M as d, a as M, P as h, b as n, S as C, T as g, c as m } from "./chunks/common.js";
+import { a as p, f as u, i as y, c as K, k as P, j as W, h as c, b as x, u as L, o as B, r as D, m as G, l as T, t as f, n as F, p as H, q as b, s as k, e as O, g as j, d as q } from "./chunks/type-guards.js";
+import { c as X } from "./chunks/setup-utils.js";
 export {
-  m as BoxPlotDataSortingKinds,
-  y as ColorFormatKeys,
-  g as FormatKeys,
-  C as GuideOrientation,
-  w as HeatChartDataSortingKinds,
-  f as LineFormatKeys,
-  i as ModelTypes,
-  u as PieChartDataModes,
-  L as PieChartDataSortingKinds,
-  b as PieChartSlicesDisplay,
-  p as SerialChartDataSortingKinds,
-  T as TextFormatKeys,
-  c as createModel,
-  S as customSortString,
-  P as isBarChartModel,
-  B as isBoxPlotModel,
-  x as isChartModel,
-  v as isComboBarLineChartModel,
-  G as isGaugeModel,
-  H as isHeatChartModel,
-  K as isHistogramModel,
-  W as isLineChartModel,
-  D as isModelOfType,
-  F as isModelWithGuides,
-  O as isModelWithLegend,
-  E as isModelWithLineMarkerStyling,
-  R as isModelWithMultiAxes,
-  Y as isModelWithTemporalBinning,
-  $ as isModelWithTooltips,
-  j as isModelWithXGuides,
-  q as isModelWithYGuides,
-  A as isPieChartLegendModel,
-  X as isPieChartModel,
-  z as isScatterplotModel,
-  I as isSerialChartModel
+  e as BoxPlotDataSortingKinds,
+  i as ColorFormatKeys,
+  t as FormatKeys,
+  o as GuideOrientation,
+  r as HeatChartDataSortingKinds,
+  l as LineFormatKeys,
+  d as ModelTypes,
+  M as PieChartDataModes,
+  h as PieChartDataSortingKinds,
+  n as PieChartSlicesDisplay,
+  C as SerialChartDataSortingKinds,
+  g as TextFormatKeys,
+  X as createModel,
+  m as customSortString,
+  p as isBarChartModel,
+  u as isBoxPlotModel,
+  y as isChartModel,
+  K as isComboBarLineChartModel,
+  P as isGaugeModel,
+  W as isHeatChartModel,
+  c as isHistogramModel,
+  x as isLineChartModel,
+  L as isModelOfType,
+  B as isModelWithGuides,
+  D as isModelWithLegend,
+  G as isModelWithLineMarkerStyling,
+  T as isModelWithMultiAxes,
+  f as isModelWithTemporalBinning,
+  F as isModelWithTooltips,
+  H as isModelWithXGuides,
+  b as isModelWithYGuides,
+  k as isPieChartLegendModel,
+  O as isPieChartModel,
+  j as isScatterplotModel,
+  q as isSerialChartModel
 };

package/dist/spec/config-defaults.d.ts

@@ -1,7 +1,11 @@
+/** @internal */
 export const defaultPieFromFieldsName: "arcgis_charts_pie_from_fields_name";
 
+/** @internal */
 export const defaultPieFromFieldsValue: "arcgis_charts_pie_from_fields_value";
 
+/** @internal */
 export const defaultBarLineFromFieldsName: "arcgis_charts_bar_line_from_fields_name";
 
+/** @internal */
 export const defaultBarLineFromFieldsValue: "arcgis_charts_bar_line_from_fields_value";