@arcgis/charts-components 5.1.0-next.8 → 5.1.0-next.80

package/dist/spec/data-source.d.ts

@@ -1,12 +1,19 @@
 import type { WebChartTemporalBinningUnits } from "./chart-object-literals.js";
 import type { Color, IExtent, ISimpleLineSymbol, ISymbol, SimpleFillSymbolStyle, SimpleLineSymbolStyle, SimpleMarkerSymbolStyle } from "./rest-js-types.js";
 
-/** JSON representation of the color object */
+/** JSON representation of the color object. */
 export interface RGBObject {
+  /** Red component of the color, in the range [0, 255]. */
   r: number;
+  /** Green component of the color, in the range [0, 255]. */
   g: number;
+  /** Blue component of the color, in the range [0, 255]. */
   b: number;
-  /** @default 1.0 */
+  /**
+   * Alpha component of the color.
+   *
+   * @default 1.0
+   */
   a?: number;
 }
 
@@ -23,23 +30,23 @@ export type WebChartDataItemColor = Color | RGBArray | RGBObject | string;
 
 export type WebChartDataItemValue = Date | IExtent | IRendererSymbol | number[] | string[] | WebChartDataItem[] | WebChartDataItemColor | boolean | number | string | null | undefined;
 
-/** JSON representation of a typical data item */
+/** JSON representation of a typical data item. */
 export type WebChartDataItem = Record<string, WebChartDataItemValue>;
 
-/** JSON representation of the processed data for a Box Plot */
+/** JSON representation of the processed data for a box plot. */
 export interface WebChartBoxPlotDataItem {
   dataItems: WebChartDataItem[];
   outliers?: WebChartDataItem[];
   meanLines?: WebChartDataItem[];
 }
 
-/** JSON representation of the processed data for a Scatter plot trend line */
+/** JSON representation of the processed data for a scatterplot trend line. */
 export interface ScatterplotTrendLineData {
   r2?: number;
   trendLinePoints?: [WebChartDataItem, WebChartDataItem];
 }
 
-/** JSON representation of the processed data for a Scatter plot */
+/** JSON representation of the processed data for a scatterplot. */
 export interface WebChartScatterplotDataItem extends ScatterplotTrendLineData {
   dataItems: WebChartDataItem[];
   aggregated?: boolean;
@@ -50,24 +57,25 @@ export interface TimeIntervalInfo {
   size?: number;
 }
 
-/** JSON representation of the generic data structure for bar, line bar-line, gauge and pie chart */
+/** JSON representation of the generic data structure for bar chart, line chart, combo bar line chart, gauge, heat chart, pie chart and radar chart. */
 export interface WebChartGenericDataItem {
   dataItems: WebChartDataItem[];
-  /** Time interval information, only for line charts */
-  timeIntervalInfo?: TimeIntervalInfo;
   /**
-   * Indicates whether the server limit has been reached when fetching data.
-   * Currently applies only to the queries leveraging the /queryBins operation.
+   * Time interval information.
+   *
+   * Only applicable to bar chart, line chart.
    */
+  timeIntervalInfo?: TimeIntervalInfo;
+  /** Indicates whether the server limit has been reached when fetching data. */
   serverLimitReached?: boolean;
 }
 
-/** JSON representation of a Histogram bin */
+/** JSON representation of a histogram bin. */
 export interface WebChartBin {
   count: number;
-  /** Min value in the bin */
+  /** Minimum value in the bin. */
   minValue: number;
-  /** Max value in the bin */
+  /** Maximum value in the bin. */
   maxValue: number;
   /** Symbol associated with the bin. */
   symbol?: WebChartDataItem;
@@ -75,18 +83,18 @@ export interface WebChartBin {
   isLastBin?: boolean;
 }
 
-/** JSON representation of the processed data for a Histogram */
+/** JSON representation of the processed data for a histogram. */
 export interface WebChartHistogramDataItem {
   mean: number;
   median: number;
   stddev: number;
   max: number;
   min: number;
-  /** Sum of the values of all the points */
+  /** Sum of the values of all the points. */
   sum?: number;
-  /** Number of all the points/features in un-binned data (including only non-null entries) */
+  /** Number of all the points/features in un-binned data (including only non-null entries). */
   count?: number;
-  /** Number of null entries in the pool of points */
+  /** Number of null entries in the pool of points. */
   nulls?: number;
   bins: WebChartBin[];
 }

package/dist/spec/events.d.ts

@@ -11,10 +11,7 @@ export const OverlayTerms: {
 
 export type OverlayTerms = (typeof OverlayTerms)[keyof typeof OverlayTerms];
 
-/**
- * Represents a subset of the event payload carrying the chart's axes bounds.
- * See event `arcgisChartsAxesMinMaxChange`.
- */
+/** Represents a subset of the event payload carrying the chart's axes bounds. */
 export interface CalculatedMinMaxBoundsPayload {
   isXAxis: boolean;
   isSecondValueAxis?: boolean;
@@ -22,7 +19,7 @@ export interface CalculatedMinMaxBoundsPayload {
   maximum: WebChartAxis["maximum"];
 }
 
-/** Represents the payload of the event sent when a chart is removed from the chart list (component arcgis-charts-config-view-charts). */
+/** Represents the payload of the event sent when a chart is removed from the chart list. */
 export interface ChartDeletePayload {
   chartId: string;
 }

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

@@ -2,6 +2,7 @@ export const RESTFieldType: {
     readonly Blob: "esriFieldTypeBlob";
     readonly Date: "esriFieldTypeDate";
     readonly DateOnly: "esriFieldTypeDateOnly";
+    readonly TimeOnly: "esriFieldTypeTimeOnly";
     readonly TimestampOffset: "esriFieldTypeTimestampOffset";
     readonly Double: "esriFieldTypeDouble";
     readonly Geometry: "esriFieldTypeGeometry";

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

@@ -25,7 +25,9 @@ export interface IFeatureSet extends IHasZM {
   objectIdFieldName?: string;
   globalIdFieldName?: string;
   displayFieldName?: string;
+  /** For feature layers only. */
   geometryType?: GeometryType;
+  /** For feature layers only. */
   spatialReference?: ISpatialReference;
   fields?: IField[];
   features: IFeature[];
@@ -56,6 +58,8 @@ export interface ISpatialReference {
  * ```js
  * import { IGeometry } from "@esri/arcgis-rest-feature-layer";
  * ```
+ *
+ * @internal
  */
 export interface IGeometry {
   spatialReference?: ISpatialReference;
@@ -126,6 +130,7 @@ export interface ICircularArc {
   c: [Position, Position2D];
 }
 
+/** @internal */
 export type ElipticArc = IArc;
 
 /** An envelope is a rectangle defined by a range of values for each coordinate and attribute. */
@@ -189,6 +194,7 @@ export interface IHasZM {
 
 export type JsonCurve = IArc | IBezierCurve | ICircularArc | IOldCircularArc;
 
+/** @internal */
 export interface IOldCircularArc {
   a: [
       Position,
@@ -218,6 +224,8 @@ export type Units = "esriSRUnit_Foot" | "esriSRUnit_Kilometer" | "esriSRUnit_Met
  * ```js
  * import { GroupMembership } from "@esri/arcgis-rest-portal";
  * ```
+ *
+ * @internal
  */
 export type GroupMembership = "admin" | "member" | "none" | "owner";
 
@@ -430,19 +438,25 @@ export interface IServiceNameAvailable {
 }
 
 export interface IStatisticDefinition {
-  /** Statistical operation to perform (count, sum, min, max, avg, stddev, var, percentile_cont, percentile_disc, EnvelopeAggregate, CentroidAggregate, ConvexHullAggregate). */
+  /** Statistical operation to perform. */
   statisticType: "avg" | "centroid-aggregate" | "convex-hull-aggregate" | "count" | "envelope-aggregate" | "max" | "min" | "percentile-continuous" | "percentile-discrete" | "stddev" | "sum" | "var";
-  /** Parameters to be used along with statisticType. Currently, only applicable for percentile-continuous (continuous percentile) and percentile-discrete (discrete percentile). */
+  /** Parameters to be used along with `statisticType`. Currently only applicable for `percentile-continuous` (continuous percentile) and `percentile-discrete` (discrete percentile). */
   statisticParameters?: {
       value: number;
       orderBy?: "asc" | "desc";
   };
   /** Field on which to perform the statistical operation. */
   onStatisticField: string;
-  /** Field name for the returned statistic field. If outStatisticFieldName is empty or missing, the server will assign one. A valid field name can only contain alphanumeric characters and an underscore. If the outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName. */
+  /**
+   * Field name for the returned statistic field.
+   *
+   * If `outStatisticFieldName` is empty or missing, the server will assign one. A valid field name can only contain alphanumeric characters and an underscore.
+   * If `outStatisticFieldName` is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative `outStatisticFieldName`.
+   */
   outStatisticFieldName?: string;
 }
 
+/** Represents the color information (R, G, B, A). */
 export type Color = [number, number, number, number];
 
 export interface IFont {
@@ -537,6 +551,7 @@ export interface ITextSymbol extends IMarkerSymbol {
   rightToLeft?: boolean;
   kerning?: boolean;
   font?: IFont;
+  /** Only applicable when specified as a client-side graphic. */
   text?: string;
 }
 
@@ -577,7 +592,7 @@ export interface IUser {
 }
 
 /** @internal */
-export type FieldType = "esriFieldTypeBigInteger" | "esriFieldTypeBlob" | "esriFieldTypeDate" | "esriFieldTypeDateOnly" | "esriFieldTypeDouble" | "esriFieldTypeGeometry" | "esriFieldTypeGlobalID" | "esriFieldTypeGUID" | "esriFieldTypeInteger" | "esriFieldTypeOID" | "esriFieldTypeRaster" | "esriFieldTypeSingle" | "esriFieldTypeSmallInteger" | "esriFieldTypeString" | "esriFieldTypeTimestampOffset" | "esriFieldTypeXML";
+export type FieldType = "esriFieldTypeBigInteger" | "esriFieldTypeBlob" | "esriFieldTypeDate" | "esriFieldTypeDateOnly" | "esriFieldTypeDouble" | "esriFieldTypeGeometry" | "esriFieldTypeGlobalID" | "esriFieldTypeGUID" | "esriFieldTypeInteger" | "esriFieldTypeOID" | "esriFieldTypeRaster" | "esriFieldTypeSingle" | "esriFieldTypeSmallInteger" | "esriFieldTypeString" | "esriFieldTypeTimeOnly" | "esriFieldTypeTimestampOffset" | "esriFieldTypeXML";
 
 /** @internal */
 export type DomainType = "codedValue" | "inherited" | "range";
@@ -789,7 +804,10 @@ export interface IPopupInfo {
 
 /**
  * @internal
- * @example { "background": { "color": [255,255,255,255] } }
+ * @example
+ * ```
+ * { "background": { "color": [255,255,255,255] } }
+ * ```
  */
 export interface IWebMapBackground {
   /** To define the color of the background of the map (which is shown when no data is shown). */
@@ -807,6 +825,7 @@ export interface IBookmark {
 /**
  * @internal
  * @example
+ * ```
  * {
  *   "mapRangeInfo": {
  *     "activeRangeName": "floors",
@@ -814,6 +833,7 @@ export interface IBookmark {
  *     "fullRangeExtent": [-2, 100 ]
  *   }
  * }
+ * ```
  */
 export interface IMapRangeInfo {
   /** Active range ID that slider/picker acts upon. */
@@ -838,6 +858,7 @@ export interface IMapLocation {
 /**
  * @internal
  * @example
+ * ```
  * {
  *   "visibleLayer": {
  *     "featureVisibility": [
@@ -849,6 +870,7 @@ export interface IMapLocation {
  *     "id": "73128eb3-05ee-46a7-8c22-0c385a0b1827"
  *   }
  * }
+ * ```
  */
 export interface IVisibleLayer {
   /** An array of arrays. */
@@ -874,6 +896,7 @@ export interface IVisiblePopup {
   subLayerId?: number;
 }
 
+/** @internal */
 export interface ISlide {
   /** Basemaps give the web map a geographic context. */
   baseMap?: IBaseMap;
@@ -893,6 +916,7 @@ export interface ISlide {
   visiblePopup?: IVisiblePopup;
 }
 
+/** @internal */
 export interface IPresentation {
   /** Indicates whether to display the time slider (if accessible). */
   displayTimeSlider?: boolean;
@@ -1062,6 +1086,7 @@ export interface IReadOnlyLayers {
   downloadAttachments: boolean;
 }
 
+/** @internal */
 export interface IEnableable {
   enabled: boolean;
 }
@@ -1128,11 +1153,13 @@ export interface ILayer {
   url?: string;
 }
 
+/** @internal */
 export interface ISupportsTime {
   /** This property is applicable to layers that support time. If 'true', timeAnimation is enabled. */
   timeAnimation?: boolean;
 }
 
+/** @internal */
 export interface IBingLayer extends ILayer {
   /** String value that unlocks the use of Bing layers in a web map. */
   bingKey?: string;
@@ -1144,6 +1171,7 @@ 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[];
@@ -1160,7 +1188,7 @@ export interface IImageServiceLayer extends ILayer, ISupportsTime {
   /** This is 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;
   /** A layerDefinition object defining the attribute schema and drawing information for the layer. */
-  layerDefinition?: any;
+  layerDefinition?: ILayerDefinition;
   /** String indicating the layer type. Value of this property must be ArcGISImageServiceLayer */
   layerType: "ArcGISImageServiceLayer";
   /** Specifies the mosaic rule when defining how individual images should be mosaicked. */
@@ -1179,6 +1207,7 @@ export interface IImageServiceLayer extends ILayer, ISupportsTime {
   renderingRule?: any;
 }
 
+/** @internal */
 export interface IImageVectorLayer extends ILayer, ISupportsTime {
   /** Stores interactive filters. */
   definitionEditor?: any;
@@ -1290,7 +1319,7 @@ export interface IThematicGroup {
   name?: string;
 }
 
-/** Drawing info container (renderer/labeling/etc). */
+/** Drawing info container for renderer, labeling etc. */
 export interface IDrawingInfo {
   /** Only used for feature collections with a renderer. The feature's symbol is defined by the layer's renderer. */
   fixedSymbols?: any;
@@ -1302,7 +1331,7 @@ export interface IDrawingInfo {
   scaleSymbols?: any;
   /** Defines whether labels should be shown or not. This is only valid for sublayers. */
   showLabels?: boolean;
-  /** Number value ranging between 0 (no transparency) to 100 (completely transparent). */
+  /** Number value ranging between `0` (no transparency) to `100` (completely transparent). */
   transparency?: number;
 }
 
@@ -1323,7 +1352,7 @@ export interface IEditingInfo {
 export interface ILayerDefinition extends IHasZM {
   /** Boolean value indicating whether the geometry of the features in the layer can be edited. */
   allowGeometryUpdates?: boolean;
-  /** A comma separated list of supported capabilities, e.g. Query,Editing. */
+  /** A comma separated list of supported capabilities, e.g. Query, Editing. */
   capabilities?: string;
   /** String value for the copyright text information for the layer. */
   copyrightText?: string;
@@ -1459,8 +1488,10 @@ export type FeatureEditTool = "esriFeatureEditToolAutoCompletePolygon" | "esriFe
 
 /**
  * Templates describe features that can be created in a layer. They are generally used with feature collections and editable web-based CSV layers.
- * Templates are not used with ArcGIS feature services as these already have templates defined in the service. They are also defined as properties
- * of the layer definition when there are no defined types. Otherwise, templates are defined as properties of the types.
+ *
+ * Templates are not used with ArcGIS feature services as these already have templates defined in the service.
+ *
+ * They are also defined as properties of the layer definition when there are no defined types. Otherwise, templates are defined as properties of the types.
  */
 export interface ITemplate {
   /** A string value containing a detailed description of the template. */
@@ -1549,6 +1580,7 @@ export interface IVectorTileLayer extends ILayer {
   type?: "VectorTileLayer";
 }
 
+/** @internal */
 export interface ILod {
   /** ID for each level. */
   level?: number;
@@ -1710,6 +1742,7 @@ export interface IKmlLayer extends ILayer {
   visibleFolders?: number[];
 }
 
+/** @internal */
 export interface IArcGisStreamLayer extends ILayer {
   /** Stores interactive filters. */
   definitionEditor?: IDefinitionEditor;