@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

package/layers/video/types.d.ts

@@ -1,23 +1,53 @@
 
+/** @since 5.0 */
 export type VideoState = "can-play" | "not-ready" | "paused" | "playing" | "ready" | "waiting" | "data-loaded";
 
+/** @since 5.0 */
 export type SensorOrientationSource = "platformHeading" | "cameraAzimuth";
 
-/** The **SensorSymbolOrientation** type defines the orientation source and symbol offset for the sensor symbol. */
+/**
+ * The **SensorSymbolOrientation** type defines the orientation source and symbol offset for the sensor symbol.
+ *
+ * @since 5.0
+ */
 export interface SensorOrientationInfo {
-  /** The orientation source for the sensor symbol. Possible values are "platformHeading" and "cameraAzimuth". */
+  /**
+   * The orientation source for the sensor symbol. Possible values are "platformHeading" and "cameraAzimuth".
+   *
+   * @since 5.0
+   */
   source: SensorOrientationSource;
-  /** The offset angle in degrees to apply to the sensor symbol. */
+  /**
+   * The offset angle in degrees to apply to the sensor symbol.
+   *
+   * @since 5.0
+   */
   symbolOffset: number;
 }
 
-/** The **VideoMetadataEntry** is an object that represents a metadata entry for the video layer. */
+/**
+ * The **VideoMetadataEntry** is an object that represents a metadata entry for the video layer.
+ *
+ * @since 5.0
+ */
 export interface VideoMetadataEntry {
-  /** The name of the metadata entry. */
+  /**
+   * The name of the metadata entry.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** The tag id of the metadata entry. */
+  /**
+   * The tag id of the metadata entry.
+   *
+   * @since 5.0
+   */
   tagId: number;
-  /** The value of the metadata entry. */
+  /**
+   * The value of the metadata entry.
+   *
+   * @since 5.0
+   */
   value: any;
 }
 
@@ -27,18 +57,46 @@ export interface VideoMetadataEntry {
  * @since 4.34
  */
 export interface LivestreamStatus {
-  /** Indicates if the video layer is at the live edge. */
+  /**
+   * Indicates if the video layer is at the live edge.
+   *
+   * @since 5.0
+   */
   atLiveEdge?: boolean | null;
-  /** Indicates if the video layer is behind the live edge. */
+  /**
+   * Indicates if the video layer is behind the live edge.
+   *
+   * @since 5.0
+   */
   behindLiveEdge?: boolean | null;
-  /** The current time of the livestream in seconds. */
+  /**
+   * The current time of the livestream in seconds.
+   *
+   * @since 5.0
+   */
   liveCurrentTime?: number | null;
-  /** The live window of the livestream in seconds. */
+  /**
+   * The live window of the livestream in seconds.
+   *
+   * @since 5.0
+   */
   liveWindow?: number | null;
-  /** The time in seconds that the video layer is past the seek end. */
+  /**
+   * The time in seconds that the video layer is past the seek end.
+   *
+   * @since 5.0
+   */
   pastSeekEnd?: number | null;
-  /** The end time of the seekable range in seconds. */
+  /**
+   * The end time of the seekable range in seconds.
+   *
+   * @since 5.0
+   */
   seekableEnd?: number | null;
-  /** The start time of the seekable range in seconds. */
+  /**
+   * The start time of the seekable range in seconds.
+   *
+   * @since 5.0
+   */
   seekableStart?: number | null;
 }

package/layers/voxel/VoxelColorStop.d.ts

@@ -3,20 +3,34 @@ import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 import type { ColorLike } from "../../Color.js";
 
+/** @since 5.0 */
 export interface VoxelColorStopProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<VoxelColorStop, "position">> {
-  /** The color to render data at this position with. */
+  /**
+   * The color to render data at this position with.
+   *
+   * @since 5.0
+   */
   color?: ColorLike;
 }
 
-/** VoxelColorStop defines a color and a normalized position. */
+/**
+ * VoxelColorStop defines a color and a normalized position.
+ *
+ * @since 5.0
+ */
 export default abstract class VoxelColorStop extends VoxelColorStopSuperclass {
-  /** The color to render data at this position with. */
+  /**
+   * The color to render data at this position with.
+   *
+   * @since 5.0
+   */
   get color(): EsriColor;
   set color(value: ColorLike);
   /**
    * The normalized (i.e. 0 to 1) position.
    *
    * @default 0
+   * @since 5.0
    */
   accessor position: number;
 }

package/layers/voxel/VoxelFormat.d.ts

@@ -1,24 +1,37 @@
 import type { JSONSupport } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export type VariableContinuity = "discrete" | "continuous";
 
+/** @since 5.0 */
 export type VoxelFormatType = "Int8" | "UInt8" | "Int16" | "UInt16" | "Int32" | "UInt32" | "Float32" | "Float64";
 
+/** @since 5.0 */
 export default abstract class VoxelFormat extends JSONSupport {
-  /** Whether or not the data is discrete or continuous. */
+  /**
+   * Whether or not the data is discrete or continuous.
+   *
+   * @since 5.0
+   */
   get continuity(): VariableContinuity | null;
   /**
    * Whether or not the data has a value representing NoData.
    *
    * @default false
+   * @since 5.0
    */
   get hasNoData(): boolean;
   /**
    * The NoData value if there is one.
    *
    * @default 0.0
+   * @since 5.0
    */
   get noData(): number;
-  /** Indicates how the data are encoded. */
+  /**
+   * Indicates how the data are encoded.
+   *
+   * @since 5.0
+   */
   get type(): VoxelFormatType | null;
 }

package/layers/voxel/VoxelIsosurface.d.ts

@@ -3,41 +3,56 @@ import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 import type { ColorLike } from "../../Color.js";
 
+/** @since 5.0 */
 export interface VoxelIsosurfaceProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<VoxelIsosurface, "colorLocked" | "enabled" | "label" | "value">> {
-  /** The color to render this isosurface with. */
+  /**
+   * The color to render this isosurface with.
+   *
+   * @since 5.0
+   */
   color?: ColorLike;
 }
 
 /**
  * VoxelIsosurface describes an isosurface value and how to render it. Isosurfaces draw when
  * the [VoxelLayer#renderMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html#renderMode) is set to surfaces.
+ *
+ * @since 5.0
  */
 export default abstract class VoxelIsosurface extends VoxelIsosurfaceSuperclass {
-  /** The color to render this isosurface with. */
+  /**
+   * The color to render this isosurface with.
+   *
+   * @since 5.0
+   */
   get color(): EsriColor;
   set color(value: ColorLike);
   /**
    * Whether or not the isosurface color is automatically updated when the variable's transfer function's color stops change.
    *
    * @default true
+   * @since 5.0
    */
   accessor colorLocked: boolean;
   /**
    * Whether or not to render this isosurface.
    *
    * @default true
+   * @since 5.0
    */
   accessor enabled: boolean;
   /**
    * The label string for this isosurface.
    *
    * @default ""
+   * @since 5.0
    */
   accessor label: string;
   /**
    * The data value for this isosurface.
    *
    * @default 0.0
+   * @since 5.0
    */
   accessor value: number;
 }

package/layers/voxel/VoxelOpacityStop.d.ts

@@ -1,20 +1,27 @@
 import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable.js";
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface VoxelOpacityStopProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<VoxelOpacityStop, "opacity" | "position">> {}
 
-/** VoxelOpacityStop defines an opacity value and a normalized position. */
+/**
+ * VoxelOpacityStop defines an opacity value and a normalized position.
+ *
+ * @since 5.0
+ */
 export default abstract class VoxelOpacityStop extends VoxelOpacityStopSuperclass {
   /**
    * The opacity value (0 = transparent, 1 = opaque) to apply to data at this position.
    *
    * @default 1
+   * @since 5.0
    */
   accessor opacity: number;
   /**
    * The normalized (i.e. 0 to 1) position.
    *
    * @default 0
+   * @since 5.0
    */
   accessor position: number;
 }

package/layers/voxel/VoxelRangeFilter.d.ts

@@ -1,17 +1,27 @@
 import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable.js";
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface VoxelRangeFilterProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<VoxelRangeFilter, "enabled" | "range">> {}
 
-/** VoxelRangeFilter defines the data range which will be rendered. */
+/**
+ * VoxelRangeFilter defines the data range which will be rendered.
+ *
+ * @since 5.0
+ */
 export default abstract class VoxelRangeFilter extends VoxelRangeFilterSuperclass {
   /**
    * Whether or not the filter is enabled.
    *
    * @default false
+   * @since 5.0
    */
   accessor enabled: boolean;
-  /** The data range to render, specified as [minimum, maximum]. */
+  /**
+   * The data range to render, specified as [minimum, maximum].
+   *
+   * @since 5.0
+   */
   accessor range: [
       number,
       number

package/layers/voxel/VoxelUniqueValue.d.ts

@@ -3,32 +3,48 @@ import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 import type { ColorLike } from "../../Color.js";
 
+/** @since 5.0 */
 export interface VoxelUniqueValueProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<VoxelUniqueValue, "enabled" | "label" | "value">> {
-  /** The color to render this value with. */
+  /**
+   * The color to render this value with.
+   *
+   * @since 5.0
+   */
   color?: ColorLike;
 }
 
-/** VoxelUniqueValue describes a particular voxel discrete value how to render it. */
+/**
+ * VoxelUniqueValue describes a particular voxel discrete value how to render it.
+ *
+ * @since 5.0
+ */
 export default abstract class VoxelUniqueValue extends VoxelUniqueValueSuperclass {
-  /** The color to render this value with. */
+  /**
+   * The color to render this value with.
+   *
+   * @since 5.0
+   */
   get color(): EsriColor;
   set color(value: ColorLike);
   /**
    * Whether or not to render data with this value.
    *
    * @default true
+   * @since 5.0
    */
   accessor enabled: boolean;
   /**
    * The label string for this value.
    *
    * @default ""
+   * @since 5.0
    */
   accessor label: string;
   /**
    * The data value.
    *
    * @default 0
+   * @since 5.0
    */
   accessor value: number;
 }

package/layers/wms/types.d.ts

@@ -1,56 +1,130 @@
 
-/** The time dimension interval. */
+/**
+ * The time dimension interval.
+ *
+ * @since 5.0
+ */
 export interface DimensionInterval<T, K> {
-  /** End of interval. */
+  /**
+   * End of interval.
+   *
+   * @since 5.0
+   */
   max: T;
-  /** Start of interval. */
+  /**
+   * Start of interval.
+   *
+   * @since 5.0
+   */
   min: T;
-  /** Interval duration defined by the following properties. */
+  /**
+   * Interval duration defined by the following properties.
+   *
+   * @since 5.0
+   */
   resolution?: K;
 }
 
+/** @since 5.0 */
 export interface Duration {
-  /** Number of days. */
+  /**
+   * Number of days.
+   *
+   * @since 5.0
+   */
   days: number;
-  /** Number of hours. */
+  /**
+   * Number of hours.
+   *
+   * @since 5.0
+   */
   hours: number;
-  /** Number of minutes. */
+  /**
+   * Number of minutes.
+   *
+   * @since 5.0
+   */
   minutes: number;
-  /** Number of months. */
+  /**
+   * Number of months.
+   *
+   * @since 5.0
+   */
   months: number;
-  /** Number of seconds. */
+  /**
+   * Number of seconds.
+   *
+   * @since 5.0
+   */
   seconds: number;
-  /** Number of years. */
+  /**
+   * Number of years.
+   *
+   * @since 5.0
+   */
   years: number;
 }
 
+/** @since 5.0 */
 export type DimensionExtent<T, K> = T[] | DimensionInterval<T, K>[];
 
+/** @since 5.0 */
 export type TimeDimensionExtent = DimensionExtent<Date, Duration | null | undefined>;
 
+/** @since 5.0 */
 export interface Dimension<T> {
   /**
    * Default value(s) for the time dimension.
    * The default value will be used if the request does not include a value for the time dimension.
+   *
+   * @since 5.0
    */
   default?: T;
-  /** Available value(s) for the time dimension. */
+  /**
+   * Available value(s) for the time dimension.
+   *
+   * @since 5.0
+   */
   extent: T;
-  /** Indicates whether multiple values of the dimension may be requested. */
+  /**
+   * Indicates whether multiple values of the dimension may be requested.
+   *
+   * @since 5.0
+   */
   multipleValues?: boolean;
-  /** Indicates whether the nearest value of the dimension will be returned in response to a request for a nearby value. */
+  /**
+   * Indicates whether the nearest value of the dimension will be returned in response to a request for a nearby value.
+   *
+   * @since 5.0
+   */
   nearestValue?: boolean;
 }
 
-/** Generic dimension information. */
+/**
+ * Generic dimension information.
+ *
+ * @since 5.0
+ */
 export interface GenericDimension {
-  /** Name of dimensional axis. */
+  /**
+   * Name of dimensional axis.
+   *
+   * @since 5.0
+   */
   name: string;
 }
 
-/** Elevation dimension information. */
+/**
+ * Elevation dimension information.
+ *
+ * @since 5.0
+ */
 export interface ElevationDimension {
-  /** Name of dimensional axis. */
+  /**
+   * Name of dimensional axis.
+   *
+   * @since 5.0
+   */
   name: "elevation";
 }
 
@@ -58,12 +132,23 @@ export interface ElevationDimension {
  * Time dimension information. For example, the WMS service might be published to show hourly weather information.
  * The TimeDimension can be used to update [View#timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#timeExtent),
  * [WMSLayer#timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WMSLayer.html#timeExtent), or to configure a [TimeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html) widget.
+ *
+ * @since 5.0
  */
 export interface TimeDimension extends Omit<Dimension<TimeDimensionExtent>, "unitSymbol"> {
-  /** Name of dimensional axis. */
+  /**
+   * Name of dimensional axis.
+   *
+   * @since 5.0
+   */
   name: "time";
-  /** Units of dimensional axis. */
+  /**
+   * Units of dimensional axis.
+   *
+   * @since 5.0
+   */
   units: "ISO8601";
 }
 
+/** @since 5.0 */
 export type WMSDimension = ElevationDimension | GenericDimension | TimeDimension;

package/layers/wmts/types.d.ts

@@ -1,2 +1,3 @@
 
+/** @since 5.0 */
 export type WMTSLayerServiceMode = "RESTful" | "KVP";

package/linkChart/ChronologicalLayoutSettings.d.ts

@@ -20,7 +20,7 @@ export interface ChronologicalLayoutSettingsProperties extends JSONSupportMixinP
  * > **Implementation Note**
  * >
  * >
- * > Chronological layouts require "Filter content using time" to be configured on the {@link layers/KnowledgeGraph/KnowledgeGraphSublayer#timeinfo link chart sublayer} properties.
+ * > Chronological layouts require "Filter content using time" to be configured on the [link chart sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html#timeInfo) properties.
  * > The time fields used must have the type `timestamp offset`. Time can be set on a link chart created in ArcGIS Pro
  * > and imported into to [ArcGIS Knowledge Studio](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/import-link-charts.htm), or you can set time in the link chart layer definition using ArcGIS Pro or the ArcGIS REST API.
  *

package/linkChart/OrganicLayoutSettings.d.ts

@@ -13,7 +13,7 @@ export interface OrganicLayoutSettingsProperties extends JSONSupportMixinPropert
 export default class OrganicLayoutSettings extends OrganicLayoutSettingsSuperclass {
   constructor(properties?: OrganicLayoutSettingsProperties);
   /**
-   * The value, in degrees, to use for the ideal edge length during layout calculations when the {@link linkChart/OrganicLayoutSettings#idealEdgeLenghtType idealEdgeLengthType} is `absolute-value`.
+   * The value, in degrees, to use for the ideal edge length during layout calculations when the [idealEdgeLengthType](https://developers.arcgis.com/javascript/latest/api-reference/esri-linkChart-OrganicLayoutSettings.html#idealEdgeLengthType) is `absolute-value`.
    * Only used for geographic layouts.
    *
    * @default 1

package/linkChart/types.d.ts

@@ -1,4 +1,6 @@
 
+/** @since 5.0 */
 export type EventsTicksVisualization = "none" | "start-and-end" | "start-only";
 
+/** @since 5.0 */
 export type IdealEdgeLengthType = "absolute-value" | "multiplier";