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

package/widgets/Slider/types.d.ts

@@ -1,25 +1,55 @@
 import type { LabelFormatFunction } from "../types.js";
 
-/** Represents the effective bounds of the slider. */
+/**
+ * Represents the effective bounds of the slider.
+ *
+ * @since 5.0
+ */
 export interface Bounds {
-  /** The effective max value of the slider, or the maximum value a user can set a thumb on the slider. */
+  /**
+   * The effective max value of the slider, or the maximum value a user can set a thumb on the slider.
+   *
+   * @since 5.0
+   */
   max?: number | null;
-  /** The effective min value of the slider, or the minimum value a user can set a thumb on the slider. */
+  /**
+   * The effective min value of the slider, or the minimum value a user can set a thumb on the slider.
+   *
+   * @since 5.0
+   */
   min?: number | null;
 }
 
-/** Label infos for the slider. */
+/**
+ * Label infos for the slider.
+ *
+ * @since 5.0
+ */
 export interface LabelInfos {
-  /** The label for the maximum value. */
+  /**
+   * The label for the maximum value.
+   *
+   * @since 5.0
+   */
   max?: string | null;
-  /** The label for the minimum value. */
+  /**
+   * The label for the minimum value.
+   *
+   * @since 5.0
+   */
   min?: string | null;
-  /** The labels for the values. */
+  /**
+   * The labels for the values.
+   *
+   * @since 5.0
+   */
   values: (string | null | undefined)[];
 }
 
+/** @since 5.0 */
 export type InputType = "max" | "min" | "thumb";
 
+/** @since 5.0 */
 export type SliderTickMode = "count" | "percent" | "step" | "position";
 
 /**
@@ -34,6 +64,7 @@ export type SliderTickMode = "count" | "percent" | "step" | "position";
  * @param labelElement - The HTMLElement representing the label of the tick. You can add or modify the default
  *   style of the tick's labels by adding CSS classes to this element. You can also add custom behavior to tick labels by attaching
  *   event listeners to individual elements.
+ * @since 5.0
  */
 export type TickCreatedFunction = (value: number, tickElement?: HTMLElement | null, labelElement?: HTMLElement | null) => void;
 
@@ -49,6 +80,7 @@ export type TickCreatedFunction = (value: number, tickElement?: HTMLElement | nu
  * @param labelElement - The HTMLElement representing the label of the thumb. You can add or modify the default
  *   style of the thumb's labels by adding CSS classes to this element. You can also add custom behavior to thumb labels by attaching
  *   event listeners to individual elements.
+ * @since 5.0
  */
 export type ThumbCreatedFunction = (index: number, value: number, thumbElement: HTMLElement, labelElement?: HTMLElement | null) => void;
 
@@ -62,6 +94,7 @@ export type ThumbCreatedFunction = (index: number, value: number, thumbElement:
  *   the `type` and `pattern` attributes.
  * @param type - The type of input created.
  * @param thumbIndex - The index of the thumb corresponding to the input element.
+ * @since 5.0
  */
 export type InputCreatedFunction = (inputElement: HTMLInputElement, type: InputType, thumbIndex?: number | null) => void;
 
@@ -69,6 +102,7 @@ export type InputCreatedFunction = (inputElement: HTMLInputElement, type: InputT
  * Object specification for configuring ticks on the slider. An array of these objects should be set on the
  * [Slider#tickConfigs](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickConfigs) property.
  *
+ * @since 5.0
  * @example
  * // places 25 ticks on the slider track
  * // evenly spaced from one another
@@ -140,9 +174,17 @@ export type InputCreatedFunction = (inputElement: HTMLInputElement, type: InputT
  * }];
  */
 export interface TickConfig {
-  /** Callback for formatting tick labels. */
+  /**
+   * Callback for formatting tick labels.
+   *
+   * @since 5.0
+   */
   labelFormatFunction?: LabelFormatFunction;
-  /** Indicates whether to render labels for the ticks. */
+  /**
+   * Indicates whether to render labels for the ticks.
+   *
+   * @since 5.0
+   */
   labelsVisible?: boolean;
   /**
    * The mode or method of positioning ticks along the slider track. See the table below for a list of possible values.
@@ -152,119 +194,280 @@ export interface TickConfig {
    * count | Places a fixed number of ticks (provided in the `values` property) at equal distances from each other below the slider track.
    * percent | When set, and a single number is set on the `values` property, ticks will be placed at the specified percentage interval along the length of the slider. For example, when `mode` is percent and `values` is `5`, then 20 ticks will be placed below the slider track (at 5-percent intervals from each other). If an array of `values` is provided, the values are interpreted as percentages along the slider. So if `values` is `[10, 50, 90]`, then three ticks will be placed below the track; one at the midway point, and two 10 percent of the length from either end of the slider.
    * position | Indicates that ticks will only be placed at the values specified in the `values` property.
+   *
+   * @since 5.0
    */
   mode: SliderTickMode;
-  /** Callback that fires for each tick. You can override default behaviors and styles with this property. */
+  /**
+   * Callback that fires for each tick. You can override default behaviors and styles with this property.
+   *
+   * @since 5.0
+   */
   tickCreatedFunction?: TickCreatedFunction;
-  /** Indicates where ticks will be rendered below the track. See the description for `mode` for more information about how this property is interpreted by each mode. */
+  /**
+   * Indicates where ticks will be rendered below the track. See the description for `mode` for more information about how this property is interpreted by each mode.
+   *
+   * @since 5.0
+   */
   values: number | number[];
 }
 
+/** @since 5.0 */
 export interface MaxChangeEvent {
-  /** The former [Slider#max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) value (or bound) of the slider. */
+  /**
+   * The former [Slider#max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) value (or bound) of the slider.
+   *
+   * @since 5.0
+   */
   oldValue: number;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "max-change";
-  /** The value of the [Slider#max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) (or bound) of the slider when the event is emitted. */
+  /**
+   * The value of the [Slider#max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) (or bound) of the slider when the event is emitted.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface MinChangeEvent {
-  /** The former [Slider#min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) value (or bound) of the slider. */
+  /**
+   * The former [Slider#min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) value (or bound) of the slider.
+   *
+   * @since 5.0
+   */
   oldValue: number;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "min-change";
-  /** The the [Slider#min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) value (or bound) of the slider when the event is emitted. */
+  /**
+   * The the [Slider#min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) value (or bound) of the slider when the event is emitted.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface MaxClickEvent {
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "max-click";
-  /** The max value of the slider. */
+  /**
+   * The max value of the slider.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface MinClickEvent {
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "min-click";
-  /** The  min value of the slider. */
+  /**
+   * The  min value of the slider.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface ThumbClickEvent {
-  /** The 0-based index of the thumb. */
+  /**
+   * The 0-based index of the thumb.
+   *
+   * @since 5.0
+   */
   index: number;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "thumb-click";
-  /** The value of the thumb when the event is emitted. */
+  /**
+   * The value of the thumb when the event is emitted.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface ThumbChangeEvent {
-  /** The 0-based index of the updated thumb position. */
+  /**
+   * The 0-based index of the updated thumb position.
+   *
+   * @since 5.0
+   */
   index: number;
-  /** The former value of the thumb before the change was made. */
+  /**
+   * The former value of the thumb before the change was made.
+   *
+   * @since 5.0
+   */
   oldValue: number;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "thumb-change";
-  /** The value of the thumb when the event is emitted. */
+  /**
+   * The value of the thumb when the event is emitted.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface ThumbDragEvent {
-  /** The 0-based index of the updated thumb position. */
+  /**
+   * The 0-based index of the updated thumb position.
+   *
+   * @since 5.0
+   */
   index: number;
-  /** The state of the drag. */
+  /**
+   * The state of the drag.
+   *
+   * @since 5.0
+   */
   state: "start" | "drag" | "stop";
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "thumb-drag";
-  /** The value of the thumb when the event is emitted. */
+  /**
+   * The value of the thumb when the event is emitted.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface TickClickEvent {
-  /** The 0-based index of the associated configuration provided in [Slider#tickConfigs](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickConfigs). */
+  /**
+   * The 0-based index of the associated configuration provided in [Slider#tickConfigs](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#tickConfigs).
+   *
+   * @since 5.0
+   */
   configIndex: number;
-  /** The 0-based index of the tick and/or group (associated label) relative to other ticks in the same configuration. */
+  /**
+   * The 0-based index of the tick and/or group (associated label) relative to other ticks in the same configuration.
+   *
+   * @since 5.0
+   */
   groupIndex: number;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "tick-click";
-  /** The approximate value that the tick represents on the slider track. */
+  /**
+   * The approximate value that the tick represents on the slider track.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface TrackClickEvent {
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "track-click";
-  /** The approximate value of the slider at the location of the click event. */
+  /**
+   * The approximate value of the slider at the location of the click event.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface SegmentClickEvent {
-  /** The 1-based index of the segment on the slider. */
+  /**
+   * The 1-based index of the segment on the slider.
+   *
+   * @since 5.0
+   */
   index: number;
-  /** The indices of the thumbs on each end of the segment. */
+  /**
+   * The indices of the thumbs on each end of the segment.
+   *
+   * @since 5.0
+   */
   thumbIndices: [
       number,
       number
   ];
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "segment-click";
-  /** The approximate value of the slider at the location of the click event. */
+  /**
+   * The approximate value of the slider at the location of the click event.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
+/** @since 5.0 */
 export interface SegmentDragEvent {
-  /** The 1-based index of the segment in the slider. */
+  /**
+   * The 1-based index of the segment in the slider.
+   *
+   * @since 5.0
+   */
   index: number;
-  /** The state of the drag. */
+  /**
+   * The state of the drag.
+   *
+   * @since 5.0
+   */
   state: "start" | "drag" | "stop";
-  /** The indices of the thumbs on each end of the segment. */
+  /**
+   * The indices of the thumbs on each end of the segment.
+   *
+   * @since 5.0
+   */
   thumbIndices: [
       number,
       number
   ];
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "segment-drag";
 }

package/widgets/Swipe/types.d.ts

@@ -1,11 +1,15 @@
 
+/** @since 5.0 */
 export type State = "ready" | "disabled";
 
+/** @since 5.0 */
 export type Direction = "vertical" | "horizontal";
 
 /**
  * The visible elements that are displayed within the widget.
  * This provides the ability to turn individual elements of the widget's display on/off.
+ *
+ * @since 5.0
  */
 export interface VisibleElements {
   /**
@@ -13,6 +17,7 @@ export interface VisibleElements {
    * Default value is `true`.
    *
    * @default true
+   * @since 5.0
    */
   divider?: boolean;
   /**
@@ -20,6 +25,7 @@ export interface VisibleElements {
    * Default value is `true`.
    *
    * @default true
+   * @since 5.0
    */
   handle?: boolean;
 }

package/widgets/TableList/TableListVisibleElements.d.ts

@@ -1,58 +1,69 @@
 import type Accessor from "../../core/Accessor.js";
 
+/** @since 5.0 */
 export interface TableListVisibleElementsProperties extends Partial<Pick<TableListVisibleElements, "closeButton" | "collapseButton" | "errors" | "filter" | "flow" | "heading" | "statusIndicators" | "temporaryTableIndicators">> {}
 
 /**
  * The visible elements that are displayed within the widget.
  * This provides the ability to turn individual elements of the widget's display on/off.
+ *
+ * @since 5.0
  */
 export default abstract class TableListVisibleElements extends Accessor {
   /**
    * **Since 4.29** Indicates whether to display a close button in the header.
    *
    * @default false
+   * @since 5.0
    */
   accessor closeButton: boolean;
   /**
    * **Since 4.29** Indicates whether to display a collapse button in the header.
    *
    * @default false
+   * @since 5.0
    */
   accessor collapseButton: boolean;
   /**
    * **Since 4.25** Indicates whether to display layers with load errors.
    *
    * @default false
+   * @since 5.0
    */
   accessor errors: boolean;
   /**
    * **Since 4.29** Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [TableList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minFilterItems), allowing users to filter tables by their title.
    *
    * @default false
+   * @since 5.0
    */
   accessor filter: boolean;
   /**
    * **Since 4.29** Determines whether the widget should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The widget will be displayed within its original flow component if set to `true`. The flow component will be omitted from the widget if set to `false`. To place the widget into an existing Calcite flow component, set this property to `false`.
    *
    * @default true
+   * @since 5.0
    */
   accessor flow: boolean;
   /**
    * **Since 4.29** Indicates whether to display the widget heading. The heading text is "Table List". The heading level can be set with the [TableList#headingLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#headingLevel).
    *
    * @default false
+   * @since 5.0
    */
   accessor heading: boolean;
   /**
    * Indicates whether the status indicators will be displayed.
    *
    * @default true
+   * @since 5.0
    */
   accessor statusIndicators: boolean;
   /**
    * **Since 4.29** Indicates whether temporary table indicators will be displayed for tables with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the table title.
    *
    * @default false
+   * @since 5.0
    */
   accessor temporaryTableIndicators: boolean;
 }

package/widgets/TableList/types.d.ts

@@ -5,17 +5,22 @@ import type ListItem from "./ListItem.js";
  * See the example snippets in the [TableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html) documentation for more details.
  *
  * @param event - An object containing a list item created by the [TableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html).
+ * @since 5.0
  */
 export type ListItemModifier = (event: ListItemModifierEvent) => void;
 
+/** @since 5.0 */
 export interface ListItemModifierEvent {
   /**
    * A list item
    *   created by the LayerList. You can modify the properties of this item to customize
    *   the text, actions, panel content, and visibility of the list item. See the
    *   documentation for the [LayerListViewModel#listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-LayerListViewModel.html#listItemCreatedFunction) for more details.
+   *
+   * @since 5.0
    */
   item: ListItem;
 }
 
+/** @since 5.0 */
 export type State = "ready" | "loading" | "disabled";

package/widgets/TimeSlider/types.d.ts

@@ -2,13 +2,16 @@ import type TimeExtent from "../../time/TimeExtent.js";
 import type TimeInterval from "../../time/TimeInterval.js";
 import type { Icon } from "@esri/calcite-components/components/calcite-icon";
 
+/** @since 5.0 */
 export type TimeSliderState = "disabled" | "ready" | "playing";
 
+/** @since 5.0 */
 export type TimeSliderMode = "instant" | "time-window" | "cumulative-from-start" | "cumulative-from-end";
 
 /**
  * Specifies an array of dates for the time slider widget. Can be used to create irregularly spaced stops.
  *
+ * @since 5.0
  * @example
  * // Explicitly define 5 stops.
  * const timeSlider = new TimeSlider({
@@ -33,7 +36,11 @@ export type TimeSliderMode = "instant" | "time-window" | "cumulative-from-start"
  * });
  */
 export interface StopsByDates {
-  /** Array of dates. */
+  /**
+   * Array of dates.
+   *
+   * @since 5.0
+   */
   dates: Date[];
 }
 
@@ -42,6 +49,7 @@ export interface StopsByDates {
  * [TimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html) can confine the subdivision to a specific time frame. StopByInterval is useful
  * when the spacing is in terms of months and years, which cannot be reliably expressed in milliseconds.
  *
+ * @since 5.0
  * @example
  * // Add yearly intervals starting from the beginning of the TimeSlider.
  * const timeSlider = new TimeSlider({
@@ -63,9 +71,17 @@ export interface StopsByDates {
  * });
  */
 export interface StopsByInterval {
-  /** Specifies a granularity of temporal data and allows you to visualize the data at specified intervals. It can be set at regular interval such as every hour or every day. */
+  /**
+   * Specifies a granularity of temporal data and allows you to visualize the data at specified intervals. It can be set at regular interval such as every hour or every day.
+   *
+   * @since 5.0
+   */
   interval: TimeInterval;
-  /** A period of time with definitive start and end dates. The time slider widget's [TimeSlider#fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent) will be used if this property is not specified. */
+  /**
+   * A period of time with definitive start and end dates. The time slider widget's [TimeSlider#fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent) will be used if this property is not specified.
+   *
+   * @since 5.0
+   */
   timeExtent?: TimeExtent;
 }
 
@@ -73,6 +89,7 @@ export interface StopsByInterval {
  * Divides the time slider's [TimeSlider#fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent) into equal parts.
  * A stop will be placed at the start and end of each division resulting in _count + 1_ [TimeSlider#effectiveStops](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#effectiveStops).
  *
+ * @since 5.0
  * @example
  * // Add ten evenly spaced stops.
  * const timeSlider = new TimeSlider({
@@ -91,27 +108,48 @@ export interface StopsByInterval {
  * });
  */
 export interface StopsByCount {
-  /** Number of evenly spaced divisions. */
+  /**
+   * Number of evenly spaced divisions.
+   *
+   * @since 5.0
+   */
   count: number;
-  /** The time period to divide. If unspecified, the time slider's [TimeSlider#fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent) will be used. */
+  /**
+   * The time period to divide. If unspecified, the time slider's [TimeSlider#fullTimeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#fullTimeExtent) will be used.
+   *
+   * @since 5.0
+   */
   timeExtent?: TimeExtent;
 }
 
+/** @since 5.0 */
 export type Stops = StopsByDates | StopsByInterval | StopsByCount;
 
 /**
  * Definition of an action that can be assigned to the [TimeSliderViewModel#actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#actions) property on the
  * [TimeSlider#actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#actions) or the [TimeSliderViewModel#actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#actions). It is displayed in a menu when
  * the user clicks the ellipsis button ![timeSlider-actions-menu](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/ellipsis.png) on the [TimeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html) widget.
+ *
+ * @since 5.0
  */
 export interface Action {
   /**
    * The name of the icon to display. The value of this property must match the icon name
    *                            from [Calcite UI Icons](https://developers.arcgis.com/calcite-design-system/icons/).
+   *
+   * @since 5.0
    */
   icon: Icon["icon"];
-  /** Unique identifier of the action. */
+  /**
+   * Unique identifier of the action.
+   *
+   * @since 5.0
+   */
   id: string;
-  /** The title of the action that will be displayed in the menu. */
+  /**
+   * The title of the action that will be displayed in the menu.
+   *
+   * @since 5.0
+   */
   title: string;
 }

package/widgets/Track/types.d.ts

@@ -1,5 +1,8 @@
 
-/** @param args - An object containing the position to be filtered. */
+/**
+ * @param args - An object containing the position to be filtered.
+ * @since 5.0
+ */
 export type PositionFilterFunction = (args: {
     position: any;
 }) => boolean;