@arcgis/charts-components 5.2.0-next.1 → 5.2.0-next.11

package/dist/json-schema/index.d.ts

@@ -528,6 +528,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         ILocation: {
@@ -575,6 +576,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         Position: {
@@ -735,6 +737,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         IPolygonWithCurves: {
@@ -762,6 +765,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         ElipticArc: {
@@ -4045,6 +4049,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         IWCSLayer: {
@@ -4122,6 +4127,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         IExclusionArea: {
@@ -4658,6 +4664,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         IGeoRssLayer: {
@@ -6559,6 +6566,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -6812,6 +6824,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -6930,6 +6947,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -7065,6 +7087,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -7244,6 +7271,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -7430,6 +7462,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -7503,6 +7540,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -7666,6 +7708,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -7779,6 +7826,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -7914,6 +7966,11 @@
                     $ref: string;
                     description: string;
                 };
+                dataTooltipFontSize: {
+                    type: string;
+                    description: string;
+                    default: number;
+                };
                 name: {
                     type: string;
                     description: string;
@@ -8684,11 +8741,11 @@
             description: string;
             title: string;
         };
-        "Omit<(structure-1066060463-59675-61418-1066060463-59600-61419-1066060463-55705-61421-1066060463-0-64474|undefined)937098756,(\"data\"|\"orderByFields\")>": {
+        "Omit<(structure-1066060463-59771-61514-1066060463-59696-61515-1066060463-55801-61517-1066060463-0-64570|undefined)937098756,(\"data\"|\"orderByFields\")>": {
             $ref: string;
             title: string;
         };
-        "Pick<(structure-1066060463-59675-61418-1066060463-59600-61419-1066060463-55705-61421-1066060463-0-64474|undefined)937098756,Exclude<(\"series\"|\"data\"|\"orderByFields\"),(\"data\"|\"orderByFields\")>>": {
+        "Pick<(structure-1066060463-59771-61514-1066060463-59696-61515-1066060463-55801-61517-1066060463-0-64570|undefined)937098756,Exclude<(\"series\"|\"data\"|\"orderByFields\"),(\"data\"|\"orderByFields\")>>": {
             type: string;
             properties: {
                 series: {

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

@@ -19,10 +19,11 @@ import type { WithSeriesId } from "../properties/series/series-id.js";
 import type { WithSeriesIndex } from "../properties/series/series-index.js";
 import type { WithSeriesLength } from "../properties/series/series-length.js";
 import type { WithChartSubType } from "../properties/chart-sub-type.js";
+import type { WithSeriesDataTooltipFontSize } from "../properties/data-tooltip-font-size.js";
 import type { WithSeriesDataTooltipValueFormat } from "../properties/data-tooltip-value-format.js";
 import type { WithFetchNULLValues } from "../properties/fetch-null-values.js";
 import type { WithSplitByValues } from "../properties/split-by-values.js";
 import type { WithDataFilters } from "../properties/data-filters.js";
 
 export abstract class ChartModel extends ChartModelSuperclass {}
-declare const ChartModelSuperclass: typeof ChartModelBase & typeof WithDataFilters & typeof WithSplitByValues & typeof WithFetchNULLValues & typeof WithSeriesDataTooltipValueFormat & typeof WithChartSubType & typeof WithSeriesLength & typeof WithSeriesIndex & typeof WithSeriesId & typeof WithSeriesVisibility & typeof WithBackgroundColor & typeof WithChartRenderer & typeof WithDescriptionVisibility & typeof WithChartSubtitleVisibility & typeof WithChartTitleVisibility & typeof WithDescriptionSymbol & typeof WithDescriptionText & typeof WithSubtitleSymbol & typeof WithSubtitleText & typeof WithVersion & typeof WithTitleSymbol & typeof WithTitleText & typeof WithChartId & typeof WithLayer & typeof WithConfig
+declare const ChartModelSuperclass: typeof ChartModelBase & typeof WithDataFilters & typeof WithSplitByValues & typeof WithFetchNULLValues & typeof WithSeriesDataTooltipFontSize & typeof WithSeriesDataTooltipValueFormat & typeof WithChartSubType & typeof WithSeriesLength & typeof WithSeriesIndex & typeof WithSeriesId & typeof WithSeriesVisibility & typeof WithBackgroundColor & typeof WithChartRenderer & typeof WithDescriptionVisibility & typeof WithChartSubtitleVisibility & typeof WithChartTitleVisibility & typeof WithDescriptionSymbol & typeof WithDescriptionText & typeof WithSubtitleSymbol & typeof WithSubtitleText & typeof WithVersion & typeof WithTitleSymbol & typeof WithTitleText & typeof WithChartId & typeof WithLayer & typeof WithConfig

package/dist/model/interfaces/common.d.ts

@@ -163,11 +163,9 @@ export const ModelTypes: {
 
 export type ModelTypes = (typeof ModelTypes)[keyof typeof ModelTypes];
 
-/** @internal */
 export type ModelTypeToSeriesType<T extends ModelTypes> = T extends typeof ModelTypes.BarChart ? WebChartBarChartSeries : T extends typeof ModelTypes.LineChart ? WebChartLineChartSeries : T extends typeof ModelTypes.ComboBarLineChart ? WebChartBarChartSeries | WebChartLineChartSeries : T extends typeof ModelTypes.BoxPlot ? WebChartBoxPlotSeries | WebChartLineChartSeries : T extends typeof ModelTypes.PieChart ? WebChartPieChartSeries : T extends typeof ModelTypes.Scatterplot ? WebChartScatterplotSeries : T extends typeof ModelTypes.Histogram ? WebChartHistogramSeries : T extends typeof ModelTypes.Gauge ? WebChartGaugeSeries : T extends typeof ModelTypes.RadarChart ? WebChartRadarChartSeries : T extends typeof ModelTypes.HeatChart ? WebChartHeatChartSeries : SupportedChartSeries;
 
 /** @internal */
 export type SeriesTypeToChartType<T extends SupportedChartSeries> = T extends WebChartBarChartSeries ? typeof WebChartTypes.BarSeries : T extends WebChartLineChartSeries ? typeof WebChartTypes.LineSeries : T extends WebChartBoxPlotSeries ? typeof WebChartTypes.BoxPlotSeries : T extends WebChartPieChartSeries ? typeof WebChartTypes.PieSeries : T extends WebChartScatterplotSeries ? typeof WebChartTypes.ScatterSeries : T extends WebChartHistogramSeries ? typeof WebChartTypes.HistogramSeries : T extends WebChartGaugeSeries ? typeof WebChartTypes.GaugeSeries : T extends WebChartRadarChartSeries ? typeof WebChartTypes.RadarSeries : T extends WebChartHeatChartSeries ? typeof WebChartTypes.HeatSeries : never;
 
-/** @internal */
 export type ModelOfType<T> = T extends typeof ModelTypes.BarChart ? BarChartModel : T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : T extends typeof ModelTypes.HeatChart ? HeatChartModel : never;

package/dist/model/properties/data-tooltip-font-size.d.ts

@@ -0,0 +1,20 @@
+import type { ChartModelBase } from "../chart-model/chart-model-base.js";
+
+/** Adds support for working with data tooltip font sizes. */
+export abstract class WithSeriesDataTooltipFontSize extends ChartModelBase {
+  /**
+   * Gets the data tooltip font size for a series.
+   *
+   * If the series index is out of bounds or the series list is empty, this function will return `undefined`.
+   *
+   * @param seriesIndex - The index of the series to retrieve the font size for.
+   */
+  getDataTooltipFontSize(seriesIndex: number): number | undefined;
+  /**
+   * Sets the data tooltip font size for a series.
+   *
+   * @param fontSize - The font size to set.
+   * @param seriesIndex - The index of the series to set the font size for.
+   */
+  setDataTooltipFontSize(fontSize: number | undefined, seriesIndex: number): void;
+}

package/dist/model/properties/rotated-state.d.ts

@@ -7,7 +7,7 @@ export abstract class WithRotatedState extends ChartModelBase {
   /**
    * Whether the chart is rotated.
    *
-   * @deprecated since 5.1. Use `rotated` instead.
+   * @deprecated since 5.1. Use [rotated](https://developers.arcgis.com/javascript/latest/references/charts-components/model/properties/rotated-state/#rotated) instead.
    */
   accessor rotatedState: boolean;
 }

package/dist/{model.js → model/shared/setup-utils.js}

@@ -1,6 +1,6 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import { M as o } from "./chunks/common.js";
-import { g as r, i as n, c } from "./chunks/model-types.js";
+import { M as o } from "../../chunks/common.js";
+import { g as r, i as n, c } from "../../chunks/model-types.js";
 async function s(a) {
   const i = "config" in a ? r(a.config) : a.chartType;
   let t;
@@ -10,53 +10,53 @@ async function s(a) {
     );
   switch (i) {
     case o.LineChart: {
-      const { LineChartModel: e } = await import("./chunks/line-chart-model.js");
+      const { LineChartModel: e } = await import("../../chunks/line-chart-model.js");
       t = new e();
       break;
     }
     case o.ComboBarLineChart: {
-      const { ComboBarLineChartModel: e } = await import("./chunks/combo-bar-line-chart-model.js");
+      const { ComboBarLineChartModel: e } = await import("../../chunks/combo-bar-line-chart-model.js");
       t = new e();
       break;
     }
     case o.PieChart: {
-      const { PieChartModel: e } = await import("./chunks/pie-chart-model.js");
+      const { PieChartModel: e } = await import("../../chunks/pie-chart-model.js");
       t = new e();
       break;
     }
     case o.Histogram: {
-      const { HistogramModel: e } = await import("./chunks/histogram-model.js");
+      const { HistogramModel: e } = await import("../../chunks/histogram-model.js");
       t = new e();
       break;
     }
     case o.Scatterplot: {
-      const { ScatterplotModel: e } = await import("./chunks/scatterplot-model.js");
+      const { ScatterplotModel: e } = await import("../../chunks/scatterplot-model.js");
       t = new e();
       break;
     }
     case o.BoxPlot: {
-      const { BoxPlotModel: e } = await import("./chunks/box-plot-model.js");
+      const { BoxPlotModel: e } = await import("../../chunks/box-plot-model.js");
       t = new e();
       break;
     }
     case o.Gauge: {
-      const { GaugeModel: e } = await import("./chunks/gauge-model.js");
+      const { GaugeModel: e } = await import("../../chunks/gauge-model.js");
       t = new e();
       break;
     }
     case o.RadarChart: {
-      const { RadarChartModel: e } = await import("./chunks/radar-chart-model.js");
+      const { RadarChartModel: e } = await import("../../chunks/radar-chart-model.js");
       t = new e();
       break;
     }
     case o.HeatChart: {
-      const { HeatChartModel: e } = await import("./chunks/heat-chart-model.js");
+      const { HeatChartModel: e } = await import("../../chunks/heat-chart-model.js");
       t = new e();
       break;
     }
     case o.BarChart:
     default: {
-      const { BarChartModel: e } = await import("./chunks/bar-chart-model.js");
+      const { BarChartModel: e } = await import("../../chunks/bar-chart-model.js");
       t = new e();
       break;
     }

package/dist/spec/rest-js-object-literals.d.ts

@@ -108,7 +108,7 @@ export const RESTFontDecoration: {
 /** @deprecated since 5.1. Won't be replaced. */
 export type RESTFontDecoration = (typeof RESTFontDecoration)[keyof typeof RESTFontDecoration];
 
-/** @deprecated since 5.1. Use core's Query["units"] instead. */
+/** @deprecated since 5.1. Use [Query#units](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/#units) instead. */
 export const RESTUnits: {
     readonly Feet: "feet";
     readonly Miles: "miles";
@@ -118,7 +118,7 @@ export const RESTUnits: {
     readonly Kilometers: "kilometers";
 };
 
-/** @deprecated since 5.1. Use core's Query["units"] instead. */
+/** @deprecated since 5.1. Use [Query#units](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/#units) instead. */
 export type RESTUnits = (typeof RESTUnits)[keyof typeof RESTUnits];
 
 export const RESTRendererType: {

package/dist/spec/rest-js-types.d.ts

@@ -71,7 +71,16 @@ export interface IGeometry {
   spatialReference?: ISpatialReference;
 }
 
-/** @internal */
+/**
+ * A simple point geometry, with spatial reference defined.
+ *
+ * `IPoint` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IPoint } from "@esri/arcgis-rest-routing";
+ * import { IPoint } from "@esri/arcgis-rest-geocoding";
+ * ```
+ */
 export interface IPoint extends IHasZM, IGeometry {
   x: number;
   y: number;
@@ -90,7 +99,7 @@ export interface ILocation {
   z?: number;
 }
 
-/** @internal */
+/** Polyline geometry. */
 export interface IPolyline extends IHasZM, IGeometry {
   paths: Position[][];
 }
@@ -103,12 +112,12 @@ export interface IPolylineWithCurves extends IHasZM, IGeometry {
   curvePaths: (JsonCurve | Position)[][];
 }
 
-/** @internal */
+/** Polygon geometry. */
 export interface IPolygon extends IHasZM, IGeometry {
   rings: Position[][];
 }
 
-/** @internal */
+/** Polygon geometry with curves. */
 export interface IPolygonWithCurves extends IHasZM, IGeometry {
   curveRings: (JsonCurve | Position)[][];
 }
@@ -1367,7 +1376,6 @@ export interface IBingLayer extends ILayer {
   portalUrl?: string;
 }
 
-/** @internal */
 export interface IImageServiceLayer extends ILayer, ISupportsTime {
   /** An array of bandIds that are visible, can specify bands to export or rearrange band order(from image service). */
   bandIds?: number[];
@@ -1748,7 +1756,7 @@ export interface IOpenStreetMapLayer extends ILayer {
   type?: "OpenStreetMap";
 }
 
-/** @internal */
+/** Tiled image service layer definition. */
 export interface ITiledImageServiceLayer extends ILayer {
   /** Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
   isReference?: boolean;
@@ -1758,7 +1766,7 @@ export interface ITiledImageServiceLayer extends ILayer {
   refreshInterval?: number;
 }
 
-/** @internal */
+/** Web Coverage Service (WCS) layer definition. */
 export interface IWCSLayer extends ILayer {
   /** Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
   isReference?: boolean;
@@ -1935,7 +1943,13 @@ export interface ICsvLayer extends ILayer {
   type?: "CSV";
 }
 
-/** @internal */
+/**
+ * Feature layers can be created by referencing a layer from either a map service or a feature service or by specifying a feature collection object.
+ * Use a map service if you just want to retrieve geometries and attributes from the server and symbolize them yourself. Use a feature service if
+ * you want to take advantage of symbols from the service's source map document. Also, use a feature service if you plan on doing editing with the
+ * feature layer. Feature layers honor any feature templates configured in the source map document. Feature collection objects are used to create
+ * a feature layer based on the supplied definition.
+ */
 export interface IFeatureLayer extends ILayer, ISupportsTime {
   /** A comma-separated string listing which editing operations are allowed on an editable feature service. */
   capabilities?: string;

package/dist/spec/web-chart.d.ts

@@ -202,7 +202,7 @@ export interface WebChartOverlay {
 export interface NumberFormatOptions {
   /** Represents a unique string identifier for the `NumberFormatOptions` object. For the `NumberFormatOptions` object, it is `number`. It can help to differentiate numerical (value) axis from other types of axes such as date-time axis and category axis. */
   type: typeof WebChartTypes.NumberAxisFormat;
-  /** Represents the JS native [Intl.NumberFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat), which is based on [CLDR](https://cldr.unicode.org/translation/number-currency-formats/number-and-currency-patterns) specifications. */
+  /** Represents the JS native [Intl.NumberFormatOptions](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat), which is based on [CLDR](https://cldr.unicode.org/translation/number-currency-formats/number-and-currency-patterns) specifications. */
   intlOptions: Intl.NumberFormatOptions;
 }
 
@@ -232,7 +232,7 @@ export interface WebChartDateTimeUnitFormatOptions {
 export interface DateTimeFormatOptions {
   /** Represents a unique string identifier for the `NumberFormatOptions` object. For the `NumberFormatOptions` object, it is `date`. It can help to differentiate date-time axis from other types of axes such as numeric (value) axis and category axis. */
   type: typeof WebChartTypes.DateAxisFormat;
-  /** Represent the JS native [Intl.DateTimeFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat), which is based on [CLDR](https://cldr.unicode.org/translation/date-time/date-time-patterns) specifications. */
+  /** Represent the JS native [Intl.DateTimeFormatOptions](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat), which is based on [CLDR](https://cldr.unicode.org/translation/date-time/date-time-patterns) specifications. */
   intlOptions: Intl.DateTimeFormatOptions;
   /** Represents how to format specific date and time units when displayed on the axis, independently from the `intlOptions`. */
   formatPerDateTimeUnit?: WebChartDateTimeUnitFormatOptions;
@@ -627,6 +627,12 @@ export interface WebChartSeries {
    * Used for bar and line charts using a date x-axis with no time binning.
    */
   dataTooltipDateFormat?: DateTimeFormatOptions;
+  /**
+   * Specifies the font size for tooltip text.
+   *
+   * @default 14
+   */
+  dataTooltipFontSize?: number;
   /** Specifies the name of the series. It would be reflected in the chart's legend. */
   name: string;
   /** Specifies a query object associated with a particular series containing information on what data to fetch for that series. */