@arcgis/charts-components 5.2.0-next.10 → 5.2.0-next.12

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;