@arcgis/common-components 5.1.0-next.2 → 5.1.0-next.21

package/dist/components/arcgis-histogram/customElement.d.ts

@@ -5,10 +5,10 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
 /**
- * Renders a histogram to visualize the spread of a dataset based on [bins](#bins) representing buckets, or sub-ranges, of
- * data. Each [bin](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-types.html#HistogramBin) is defined by a minimum and maximum value and a total count.
+ * Renders a histogram to visualize the spread of a dataset based on [bins](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#bins) representing buckets, or sub-ranges, of
+ * data. Each [bin](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/types/#HistogramBin) is defined by a minimum and maximum value and a total count.
  *
- * You can generate the underlying histogram's bins with the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html)
+ * You can generate the underlying histogram's bins with the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
  * module, then apply them to the component, as shown in the example below.
  *
  * ```js
@@ -27,26 +27,25 @@ import type { T9nMeta } from "@arcgis/lumina/controllers";
  * histogramElement.max = results.maxValue;
  * ```
  *
- * Other properties of this component allow you to display meaningful values on the histogram, such as the [average](#average),
- * [one standard deviation](#standardDeviation), and the [dataLines](#dataLines) properties.
+ * Other properties of this component allow you to display meaningful values on the histogram, such as the [average](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#average),
+ * [standardDeviation](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#standardDeviation), and the [dataLines](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#dataLines) properties.
  *
- * The [layout](#layout) property allows you to set the orientation of the histogram, and the [colorStops](#colorStops)
+ * The [layout](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#layout) property allows you to set the orientation of the histogram, and the [colorStops](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#colorStops)
  * property allows you to set a gradient or color scheme for the histogram bars.
  *
- * <a name="image-annotations"></a>
- * See the image below for a summary of the configurable options available on this slider.
+ * See the image below for a summary of the configurable options available on the histogram.
  *
- * ![Histogram with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/histogram-basic-labels.png "Histogram with annotations")
+ * ![Histogram with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/histogram-basic-labels.png "Histogram with annotations")
  *
- * The [colorStops](#colorStops) property may be used to define a color scheme for the histogram bars.
+ * The [colorStops](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#colorStops) property may be used to define a color scheme for the histogram bars.
  *
- * ![Histogram with color](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/histogram-colors.png "Histogram with color")
- *
- * **See also:**
- * - [histogram module](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html)
+ * ![Histogram with color](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/histogram-colors.png "Histogram with color")
  *
  * @cssproperty [--arcgis-histogram-bar-color] - Specifies the color of the histogram bars when the bin doesn't have a corresponding color stop.
  * @cssproperty [--arcgis-histogram-stop-color] - Specifies the default color for color stops.
+ * @see [histogram module](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
+ * @see [Sample - Histogram component](https://developers.arcgis.com/javascript/latest/sample-code/histogram/)
+ * @since 5.0
  */
 export abstract class ArcgisHistogram extends LitElement {
   /** @internal */
@@ -60,13 +59,13 @@ export abstract class ArcgisHistogram extends LitElement {
   /**
    * The statistical average of the data in the histogram. You would typically
    * get this value from the `avg` property of
-   * [SummaryStatisticsResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#SummaryStatisticsResult),
+   * [SummaryStatisticsResult](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/#SummaryStatisticsResult),
    * which is the result of the
-   * [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics) function.
+   * [summaryStatistics](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/#summaryStatistics) function.
    *
    * When set, this value will render on the histogram with a symbol indicating it is the average.
    *
-   * @see [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html#summaryStatistics)
+   * @see [summaryStatistics](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/#summaryStatistics)
    * @example
    * ```js
    * // sets result returned from a smart mapping method
@@ -82,7 +81,7 @@ export abstract class ArcgisHistogram extends LitElement {
   /**
    * An array of objects representing each bin in the histogram. This
    * information is typically returned from the
-   * [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) function.
+   * [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram) function.
    *
    * @example
    * ```js
@@ -108,7 +107,7 @@ export abstract class ArcgisHistogram extends LitElement {
    * When set to `true`, overlapping classed color stops will be blended together to create the color of the bar.
    * This allows to show a if a bar representing a bin overlaps with multiple classed color stops.
    *
-   * This property is only applicable when the [colorStops](#colorStops) property is set to classed color stops.
+   * This property is only applicable when the [colorStops](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#colorStops) property is set to classed color stops.
    *
    * @default false
    */
@@ -119,7 +118,7 @@ export abstract class ArcgisHistogram extends LitElement {
    * - **Continuous color stops**: Each stop is defined by a `color` and a value. The color of the bar is determined by interpolating between the
    *   colors of the stops surrounding the value of the bin.
    * - **Classed color stops**: Each stop is defined by a `color` and a `minValue` and `maxValue`. The color of the bar is determined by the color of the stop
-   *  that contains the value of the bin. If the `color` is ommitted, the bar will be colored using the CSS variable `--arcgis-histogram-stop-color`.
+   *  that contains the value of the bin. If the `color` is omitted, the bar will be colored using the CSS variable `--arcgis-histogram-stop-color`.
    *
    * When a bar is not covered by any color stop, it will be colored using the CSS variable `--arcgis-histogram-bar-color`.
    *
@@ -176,7 +175,7 @@ export abstract class ArcgisHistogram extends LitElement {
    *   };
    * });
    * ```
-   * @see [smartMappingUtils.getDeviationValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-support-utils.html#getDeviationValues)
+   * @see [smartMappingUtils.getDeviationValues](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/support/utils/#getDeviationValues)
    */
   accessor dataLines: DataLine[] | undefined;
   /**
@@ -201,7 +200,7 @@ export abstract class ArcgisHistogram extends LitElement {
   accessor layout: HistogramLayout;
   /**
    * The maximum value or bound of the entire histogram. This
-   * should match the maximum bound of the last [bin](#bins).
+   * should match the maximum bound of the last [bins](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#bins).
    *
    * @example
    * ```js
@@ -209,20 +208,23 @@ export abstract class ArcgisHistogram extends LitElement {
    * ```
    * @example
    * ```js
-   * // sets result returned from a smart mapping method
-   * // to the histogram
+   * // sets result returned from a smart mapping method to the histogram
    * histogram.max = response.statistics.max;
    * ```
    */
   accessor max: number | undefined;
-  /** Replace localized message strings with your own strings. */
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   */
   accessor messageOverrides: {
       componentLabel?: string | undefined;
       barLabel?: string | undefined;
   };
   /**
    * The minimum value or bound of the entire histogram. This
-   * should match the minimum bound of the first [bin](#bins).
+   * should match the minimum bound of the first [bins](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#bins).
    *
    * @example
    * ```js
@@ -230,11 +232,27 @@ export abstract class ArcgisHistogram extends LitElement {
    * ```
    * @example
    * ```js
-   * // sets result returned from a smart mapping method
-   * // to the histogram
+   * // sets result returned from a smart mapping method to the histogram
    * histogram.min = response.statistics.min;
    * ```
    */
   accessor min: number | undefined;
+  /**
+   * The statistical standard deviation of the data in the histogram. You would typically
+   * get this value from the `stddev` property of
+   * [SummaryStatisticsResult](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/#SummaryStatisticsResult),
+   * which is the result of the
+   * [summaryStatistics](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/#summaryStatistics) function.
+   *
+   * When set, this value will render on the histogram with symbols indicating standard deviation intervals from the mean.
+   *
+   * @see [summaryStatistics](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/#summaryStatistics)
+   * @example
+   * ```js
+   * // sets result returned from a smart mapping method
+   * // to the histogram
+   * histogram.standardDeviation = response.statistics.stddev;
+   * ```
+   */
   accessor standardDeviation: number | undefined;
 }

package/dist/components/arcgis-label-input/customElement.d.ts

@@ -4,6 +4,7 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { Button as Button } from "@esri/calcite-components/components/calcite-button";
 import type { InputNumber as InputNumber } from "@esri/calcite-components/components/calcite-input-number";
 
+/** @internal */
 export abstract class ArcgisLabelInput extends LitElement {
   /**
    * Specifies the alignment of the component's text elements.
@@ -13,11 +14,11 @@ export abstract class ArcgisLabelInput extends LitElement {
   accessor alignment: Button["alignment"] & InputNumber["alignment"];
   /**
    * Indicates whether the component is in edit mode.
-   * This value changes when user interacts with the component or when [edit()](#edit) is called.
-   * The value is always `false` when the component is in [read-only](#readOnly) mode.
+   * This value changes when user interacts with the component or when [edit()](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-label-input/#edit) is called.
+   * The value is always `false` when the component is in [readOnly](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-label-input/#readOnly) mode.
    *
    * @default false
-   * @see [edit()](#edit)
+   * @see [edit()](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-label-input/#edit)
    */
   get editing(): boolean;
   /** A function used to format the value. */
@@ -37,7 +38,7 @@ export abstract class ArcgisLabelInput extends LitElement {
   /**
    * Initiates the edit mode for the component.
    *
-   * @see [editing](#editing)
+   * @see [editing](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-label-input/#editing)
    */
   edit(): Promise<void>;
   /** Fires each time a new value is typed and committed. */

package/dist/components/arcgis-picker-input/customElement.d.ts

@@ -3,6 +3,7 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { IPopoverProps } from "../../utils/types.js";
 import type { Icon as Icon } from "@esri/calcite-components/components/calcite-icon";
 
+/** @internal */
 export abstract class ArcgisPickerInput extends LitElement {
   /**
    * If true, disables the component.

package/dist/components/arcgis-ramp-color/customElement.d.ts

@@ -2,6 +2,7 @@
 import type Color from "@arcgis/core/Color.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 
+/** @internal */
 export abstract class ArcgisRampColor extends LitElement {
   /** @default "horizontal" */
   accessor layout: "horizontal" | "vertical";
@@ -12,6 +13,7 @@ export abstract class ArcgisRampColor extends LitElement {
   accessor stops: ColorStop[];
 }
 
+/** @internal */
 export interface ColorStop {
   color: Color | string;
   value: number;

package/dist/components/arcgis-ramp-color-break/customElement.d.ts

@@ -3,6 +3,7 @@ import type Color from "@arcgis/core/Color.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisRampColor } from "../arcgis-ramp-color/customElement.js";
 
+/** @internal */
 export abstract class ArcgisRampColorBreak extends LitElement {
   /** @default "horizontal" */
   accessor layout: ArcgisRampColor["layout"];
@@ -13,6 +14,7 @@ export abstract class ArcgisRampColorBreak extends LitElement {
   accessor stops: ColorBreak[];
 }
 
+/** @internal */
 export interface ColorBreak {
   color: Color | string;
   max: number;

package/dist/components/arcgis-ramp-opacity/customElement.d.ts

@@ -3,6 +3,7 @@ import type Color from "@arcgis/core/Color.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisRampColor } from "../arcgis-ramp-color/customElement.js";
 
+/** @internal */
 export abstract class ArcgisRampOpacity extends LitElement {
   accessor fillColor: Color | string;
   /** @default "horizontal" */