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

package/smartMapping/symbology/types.d.ts

@@ -3,50 +3,113 @@ import type Color from "../../Color.js";
 /**
  * Describes a theme that pairs well with the given basemaps.
  * See the table below for more details of the properties in this object.
+ *
+ * @since 5.0
  */
 export interface Theme {
-  /** The Esri basemaps that pair well with the given theme. */
+  /**
+   * The Esri basemaps that pair well with the given theme.
+   *
+   * @since 5.0
+   */
   basemaps: string[];
-  /** Text describing the theme in the UI. */
+  /**
+   * Text describing the theme in the UI.
+   *
+   * @since 5.0
+   */
   description: string;
-  /** The label identifying the theme in UI elements. */
+  /**
+   * The label identifying the theme in UI elements.
+   *
+   * @since 5.0
+   */
   label: string;
-  /** The name of the theme. */
+  /**
+   * The name of the theme.
+   *
+   * @since 5.0
+   */
   name: string;
 }
 
+/** @since 5.0 */
 export interface SchemeOutline {
-  /** The outline color of the symbol. */
+  /**
+   * The outline color of the symbol.
+   *
+   * @since 5.0
+   */
   color: Color;
-  /** The width of the symbol in pixels or points. */
+  /**
+   * The width of the symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   width: string | number;
 }
 
-/** Properties defining the symbology scheme used to visualize point features with attribute data-driven color. */
+/**
+ * Properties defining the symbology scheme used to visualize point features with attribute data-driven color.
+ *
+ * @since 5.0
+ */
 export interface ColorSchemeForPoint {
-  /** The continuous color ramp that will be applied to the visualization. */
+  /**
+   * The continuous color ramp that will be applied to the visualization.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** Predefined classed color schemes to use for the visualization. */
+  /**
+   * Predefined classed color schemes to use for the visualization.
+   *
+   * @since 5.0
+   */
   colorsForClassBreaks: ColorsForClassBreak[];
   /**
    * The unique id of the color scheme to use in the visualization. The id is
    * assigned based on the following template: `<themeName>/<basemapName>/<schemeName>`.
+   *
+   * @since 5.0
    */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the symbol used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the symbol. */
+  /**
+   * The opacity of the symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the symbol. */
+  /**
+   * Properties for defining the outline of the symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** The default size of the symbol in pixels or points. */
+  /**
+   * The default size of the symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   size: string | number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
   /**
    * Indicates which values will be emphasized in the continuous ramp and the map.
@@ -57,31 +120,61 @@ export interface ColorSchemeForPoint {
    * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-above-and-below.png) |
    * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-centered-on.png) |
    * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-extremes.png) |
+   *
+   * @since 5.0
    */
   theme: string;
 }
 
-/** Properties defining the symbology scheme used to visualize polyline features with attribute data-driven color. */
+/**
+ * Properties defining the symbology scheme used to visualize polyline features with attribute data-driven color.
+ *
+ * @since 5.0
+ */
 export interface ColorSchemeForPolyline {
-  /** The continuous color ramp that will be applied to the visualization. */
+  /**
+   * The continuous color ramp that will be applied to the visualization.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** Predefined classed color schemes to use for the visualization. */
+  /**
+   * Predefined classed color schemes to use for the visualization.
+   *
+   * @since 5.0
+   */
   colorsForClassBreaks: ColorsForClassBreak[];
   /**
    * The unique id of the color scheme to use in the visualization. The id is
    * assigned based on the following template: `<themeName>/<basemapName>/<schemeName>`.
+   *
+   * @since 5.0
    */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the symbol used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the symbol. */
+  /**
+   * The opacity of the symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
   /**
    * Indicates which values will be emphasized in the continuous ramp and the map.
@@ -92,35 +185,73 @@ export interface ColorSchemeForPolyline {
    * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-above-and-below.png) |
    * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-centered-on.png) |
    * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-extremes.png) |
+   *
+   * @since 5.0
    */
   theme: string;
-  /** The default width of the symbol in pixels or points. */
+  /**
+   * The default width of the symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   width: string | number;
 }
 
-/** Properties defining the symbology scheme used to visualize polygon features with attribute data-driven color. */
+/**
+ * Properties defining the symbology scheme used to visualize polygon features with attribute data-driven color.
+ *
+ * @since 5.0
+ */
 export interface ColorSchemeForPolygon {
-  /** The continuous color ramp that will be applied to the visualization. */
+  /**
+   * The continuous color ramp that will be applied to the visualization.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** Predefined classed color schemes to use for the visualization. */
+  /**
+   * Predefined classed color schemes to use for the visualization.
+   *
+   * @since 5.0
+   */
   colorsForClassBreaks: ColorsForClassBreak[];
   /**
    * The unique id of the color scheme to use in the visualization. The id is
    * assigned based on the following template: `<themeName>/<basemapName>/<schemeName>`.
+   *
+   * @since 5.0
    */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the symbol used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the symbol. */
+  /**
+   * The opacity of the symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the symbol. */
+  /**
+   * Properties for defining the outline of the symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
   /**
    * Indicates which values will be emphasized in the continuous ramp and the map.
@@ -131,31 +262,61 @@ export interface ColorSchemeForPolygon {
    * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-above-and-below.png) |
    * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-centered-on.png) |
    * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-extremes.png) |
+   *
+   * @since 5.0
    */
   theme: string;
 }
 
-/** Properties defining the symbology scheme used to visualize mesh features with attribute data-driven color. */
+/**
+ * Properties defining the symbology scheme used to visualize mesh features with attribute data-driven color.
+ *
+ * @since 5.0
+ */
 export interface ColorSchemeForMesh {
-  /** The continuous color ramp that will be applied to the visualization. */
+  /**
+   * The continuous color ramp that will be applied to the visualization.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** Predefined classed color schemes to use for the visualization. */
+  /**
+   * Predefined classed color schemes to use for the visualization.
+   *
+   * @since 5.0
+   */
   colorsForClassBreaks: ColorsForClassBreak[];
   /**
    * The unique id of the color scheme to use in the visualization. The id is
    * assigned based on the following template: `<themeName>/<basemapName>/<schemeName>`.
+   *
+   * @since 5.0
    */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the symbol used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the symbol. */
+  /**
+   * The opacity of the symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
   /**
    * Indicates which values will be emphasized in the continuous ramp and the map.
@@ -166,602 +327,1434 @@ export interface ColorSchemeForMesh {
    * | above-and-below | Values centered around a given point (e.g. the average) are visualized with weak colors while other values are emphasized with strong colors. | ![above-and-below](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-above-and-below.png) |
    * | centered-on | Values centered around a given point (e.g. the average) are emphasized with strong colors while other values are visualized with weak colors. | ![centered-on](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-centered-on.png) |
    * | extremes | High and low values are emphasized with strong colors. All others are visualized with weak colors. | ![extremes](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/sm-extremes.png) |
+   *
+   * @since 5.0
    */
   theme: string;
 }
 
-/** Properties defining the symbology scheme used to visualize features with attribute data-driven color. */
+/**
+ * Properties defining the symbology scheme used to visualize features with attribute data-driven color.
+ *
+ * @since 5.0
+ */
 export type ColorScheme = ColorSchemeForPoint | ColorSchemeForPolyline | ColorSchemeForPolygon | ColorSchemeForMesh;
 
+/** @since 5.0 */
 export interface ColorsForClassBreak {
   /**
    * An array of hex color strings. Each color is
    * assigned to a specific break in classed color visualizations.
+   *
+   * @since 5.0
    */
   colors: Color[];
-  /** The number of classes or colors used in the ramp of discrete colors. */
+  /**
+   * The number of classes or colors used in the ramp of discrete colors.
+   *
+   * @since 5.0
+   */
   numClasses: number;
 }
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-color.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface ColorSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The color scheme best suited for the given basemap and geometry type. */
+  /**
+   * The color scheme best suited for the given basemap and geometry type.
+   *
+   * @since 5.0
+   */
   primaryScheme: ColorScheme;
-  /** Additional color schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. */
+  /**
+   * Additional color schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: ColorScheme[];
 }
 
-/** Properties defining the symbology scheme used to visualize point features driven by attribute data. */
+/**
+ * Properties defining the symbology scheme used to visualize point features driven by attribute data.
+ *
+ * @since 5.0
+ */
 export interface SizeSchemeForPoint {
-  /** The fill color of the marker symbol. */
+  /**
+   * The fill color of the marker symbol.
+   *
+   * @since 5.0
+   */
   color: Color;
   /**
    * The maximum size of a marker symbol in pixels or points representing features
    * with high data values.
+   *
+   * @since 5.0
    */
   maxSize: string | number;
   /**
    * The minimum size of a marker symbol in pixels or points representing features
    * with low data values.
+   *
+   * @since 5.0
    */
   minSize: string | number;
   /**
    * The color of the marker symbol used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
   /**
    * The size of the marker symbol (in pixels or points) used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataSize: string | number;
-  /** The opacity of the marker symbol. */
+  /**
+   * The opacity of the marker symbol.
+   *
+   * @since 5.0
+   */
   opacity?: number;
-  /** Properties for defining the outline of the marker symbol. */
+  /**
+   * Properties for defining the outline of the marker symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** The default size of the marker symbol in pixels or points. */
+  /**
+   * The default size of the marker symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   size: string | number;
 }
 
-/** Properties defining the symbology scheme used to visualize polyline features driven by attribute data. */
+/**
+ * Properties defining the symbology scheme used to visualize polyline features driven by attribute data.
+ *
+ * @since 5.0
+ */
 export interface SizeSchemeForPolyline {
-  /** The color of the line symbol. */
+  /**
+   * The color of the line symbol.
+   *
+   * @since 5.0
+   */
   color: Color;
   /**
    * The maximum width of a line symbol in pixels or points representing features
    * with high data values.
+   *
+   * @since 5.0
    */
   maxWidth: string | number;
   /**
    * The minimum width of a line symbol in pixels or points representing features
    * with low data values.
+   *
+   * @since 5.0
    */
   minWidth: string | number;
   /**
    * The color of the line symbol used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
   /**
    * The width of the line symbol in pixels or points used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataWidth: string | number;
-  /** The opacity of the line symbol. */
+  /**
+   * The opacity of the line symbol.
+   *
+   * @since 5.0
+   */
   opacity?: number;
-  /** The default width of the line symbol in pixels or points. */
+  /**
+   * The default width of the line symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   width: string | number;
 }
 
 /**
  * Properties defining the symbology scheme used to visualize polygon features driven by attribute data.
  * When visualized by size, polygons are represented with marker symbols.
+ *
+ * @since 5.0
  */
 export interface SizeSchemeForPolygon {
-  /** The schema defining the backgound symbol of the feature. This is a fill symbol. */
+  /**
+   * The schema defining the backgound symbol of the feature. This is a fill symbol.
+   *
+   * @since 5.0
+   */
   background: SizeSchemeForPolygonBackground;
-  /** The scheme defining the symbology of the marker symbol used to represent polygon features by size. */
+  /**
+   * The scheme defining the symbology of the marker symbol used to represent polygon features by size.
+   *
+   * @since 5.0
+   */
   marker: SizeSchemeForPoint;
-  /** The opacity of the symbol. */
+  /**
+   * The opacity of the symbol.
+   *
+   * @since 5.0
+   */
   opacity?: number;
 }
 
+/** @since 5.0 */
 export interface SizeSchemeForPolygonBackground {
-  /** The color of the fill symbol representing the polygon. */
+  /**
+   * The color of the fill symbol representing the polygon.
+   *
+   * @since 5.0
+   */
   color: Color;
-  /** Properties for defining the outline of the background fill symbol. */
+  /**
+   * Properties for defining the outline of the background fill symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
 }
 
-/** Properties defining the symbology scheme used to visualize features with attribute data-driven size. */
+/**
+ * Properties defining the symbology scheme used to visualize features with attribute data-driven size.
+ *
+ * @since 5.0
+ */
 export type SizeScheme = SizeSchemeForPoint | SizeSchemeForPolyline | SizeSchemeForPolygon;
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-size.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface SizeSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The size scheme best suited for the given basemap and geometry type. */
+  /**
+   * The size scheme best suited for the given basemap and geometry type.
+   *
+   * @since 5.0
+   */
   primaryScheme: SizeScheme;
-  /** Additional size schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. */
+  /**
+   * Additional size schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: SizeScheme[];
 }
 
-/** Properties defining the location-only symbology scheme used to visualize point features. */
+/**
+ * Properties defining the location-only symbology scheme used to visualize point features.
+ *
+ * @since 5.0
+ */
 export interface LocationSchemeForPoint {
-  /** The fill color of the marker symbol. */
+  /**
+   * The fill color of the marker symbol.
+   *
+   * @since 5.0
+   */
   color: Color;
-  /** The opacity of the marker symbol. */
+  /**
+   * The opacity of the marker symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the marker symbol. */
+  /**
+   * Properties for defining the outline of the marker symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** The size of the marker symbol in pixels or points. */
+  /**
+   * The size of the marker symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   size: string | number;
 }
 
-/** Properties defining the location-only symbology scheme used to visualize polyline features. */
+/**
+ * Properties defining the location-only symbology scheme used to visualize polyline features.
+ *
+ * @since 5.0
+ */
 export interface LocationSchemeForPolyline {
-  /** The color of the line symbol. */
+  /**
+   * The color of the line symbol.
+   *
+   * @since 5.0
+   */
   color: Color;
-  /** The opacity of the line symbol. */
+  /**
+   * The opacity of the line symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** The width of the line symbol in pixels or points. */
+  /**
+   * The width of the line symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   width: string | number;
 }
 
-/** Properties defining the location-only symbology scheme used to visualize polygon features. */
+/**
+ * Properties defining the location-only symbology scheme used to visualize polygon features.
+ *
+ * @since 5.0
+ */
 export interface LocationSchemeForPolygon {
-  /** The color of the fill symbol. */
+  /**
+   * The color of the fill symbol.
+   *
+   * @since 5.0
+   */
   color: Color;
-  /** The opacity of the fill symbol. */
+  /**
+   * The opacity of the fill symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the fill symbol. */
+  /**
+   * Properties for defining the outline of the fill symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
 }
 
-/** Properties defining the location-only symbology scheme used to visualize mesh features. */
+/**
+ * Properties defining the location-only symbology scheme used to visualize mesh features.
+ *
+ * @since 5.0
+ */
 export interface LocationSchemeForMesh {
-  /** The color of the fill symbol. */
+  /**
+   * The color of the fill symbol.
+   *
+   * @since 5.0
+   */
   color: Color;
-  /** The opacity of the fill symbol. */
+  /**
+   * The opacity of the fill symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
 }
 
-/** Defines the symbology scheme used to visualize default location-based symbols depending on the layer's geometry type. */
+/**
+ * Defines the symbology scheme used to visualize default location-based symbols depending on the layer's geometry type.
+ *
+ * @since 5.0
+ */
 export type LocationScheme = LocationSchemeForPoint | LocationSchemeForPolyline | LocationSchemeForPolygon | LocationSchemeForMesh;
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-location.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface LocationSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The location scheme best suited for the given basemap and geometry type. */
+  /**
+   * The location scheme best suited for the given basemap and geometry type.
+   *
+   * @since 5.0
+   */
   primaryScheme: LocationScheme;
-  /** Additional location schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. */
+  /**
+   * Additional location schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: LocationScheme[];
 }
 
-/** Properties defining the symbology scheme used to visualize point features driven by type-based attribute data. */
+/**
+ * Properties defining the symbology scheme used to visualize point features driven by type-based attribute data.
+ *
+ * @since 5.0
+ */
 export interface TypeSchemeForPoint {
-  /** The fill colors of the point symbols comprising the theme. */
+  /**
+   * The fill colors of the point symbols comprising the theme.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the point symbol used to indicate
    * features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the point symbol. */
+  /**
+   * The opacity of the point symbol.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the marker symbol. */
+  /**
+   * Properties for defining the outline of the marker symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** The default size of the point symbol in pixels, points, or real-world units. */
+  /**
+   * The default size of the point symbol in pixels, points, or real-world units.
+   *
+   * @since 5.0
+   */
   size: string | number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
-  /** The theme. */
+  /**
+   * The theme.
+   *
+   * @since 5.0
+   */
   theme: string;
 }
 
-/** Properties defining the symbology scheme used to visualize polyline features driven by type-based attribute data. */
+/**
+ * Properties defining the symbology scheme used to visualize polyline features driven by type-based attribute data.
+ *
+ * @since 5.0
+ */
 export interface TypeSchemeForPolyline {
-  /** The colors of the line symbols comprising the theme. */
+  /**
+   * The colors of the line symbols comprising the theme.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the line symbol used to indicate
    * features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the line symbol (0 - 1). */
+  /**
+   * The opacity of the line symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
-  /** The theme. */
+  /**
+   * The theme.
+   *
+   * @since 5.0
+   */
   theme: string;
-  /** The default width of the line symbol in pixels or points. */
+  /**
+   * The default width of the line symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   width: string | number;
 }
 
-/** Properties defining the symbology scheme used to visualize polygon features driven by type-based attribute data. */
+/**
+ * Properties defining the symbology scheme used to visualize polygon features driven by type-based attribute data.
+ *
+ * @since 5.0
+ */
 export interface TypeSchemeForPolygon {
-  /** The fill colors of the symbols comprising the theme. */
+  /**
+   * The fill colors of the symbols comprising the theme.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the fill symbol used to indicate
    * features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the symbol (0 - 1). */
+  /**
+   * The opacity of the symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the fill symbol. */
+  /**
+   * Properties for defining the outline of the fill symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
-  /** The theme. */
+  /**
+   * The theme.
+   *
+   * @since 5.0
+   */
   theme: string;
 }
 
-/** Properties defining the symbology scheme used to visualize mesh features driven by type-based attribute data. */
+/**
+ * Properties defining the symbology scheme used to visualize mesh features driven by type-based attribute data.
+ *
+ * @since 5.0
+ */
 export interface TypeSchemeForMesh {
-  /** The fill colors of the symbols comprising the theme. */
+  /**
+   * The fill colors of the symbols comprising the theme.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the fill symbol used to indicate
    * features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the symbol (0 - 1). */
+  /**
+   * The opacity of the symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
-  /** The theme. */
+  /**
+   * The theme.
+   *
+   * @since 5.0
+   */
   theme: string;
 }
 
-/** Properties defining the symbology scheme used to visualize point clouds. */
+/**
+ * Properties defining the symbology scheme used to visualize point clouds.
+ *
+ * @since 5.0
+ */
 export interface PointCloudClassScheme {
-  /** The fill colors of the point symbols comprising the theme. */
+  /**
+   * The fill colors of the point symbols comprising the theme.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
-  /** The theme. */
+  /**
+   * The theme.
+   *
+   * @since 5.0
+   */
   theme: string;
 }
 
+/** @since 5.0 */
 export type TypeSchemeForGeometry = TypeSchemeForPoint | TypeSchemeForPolyline | TypeSchemeForPolygon | TypeSchemeForMesh;
 
-/** Properties defining the symbology scheme used to visualize features with attribute data-driven types. */
+/**
+ * Properties defining the symbology scheme used to visualize features with attribute data-driven types.
+ *
+ * @since 5.0
+ */
 export type TypeScheme = TypeSchemeForGeometry | PointCloudClassScheme;
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-type.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface TypeSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The type scheme best suited for the given basemap and geometry type. */
+  /**
+   * The type scheme best suited for the given basemap and geometry type.
+   *
+   * @since 5.0
+   */
   primaryScheme: TypeScheme;
-  /** Additional type schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. */
+  /**
+   * Additional type schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: TypeScheme[];
 }
 
-/** Properties defining the symbology scheme used to visualize point features as a heatmap. */
+/**
+ * Properties defining the symbology scheme used to visualize point features as a heatmap.
+ *
+ * @since 5.0
+ */
 export interface HeatmapScheme {
-  /** A continuous color ramp used to construct a heatmap. */
+  /**
+   * A continuous color ramp used to construct a heatmap.
+   *
+   * @since 5.0
+   */
   colors: Color[];
   /**
    * The unique id of the color scheme to usee in the visualization. The id is
    *   assigned based on the following template: `<themeName>/<basemapName>/<schemeName>`.
+   *
+   * @since 5.0
    */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** The opacity of the heatmap. */
+  /**
+   * The opacity of the heatmap.
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-heatmap.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface HeatmapSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The heatmap color scheme best suited for the given basemap and geometry type. */
+  /**
+   * The heatmap color scheme best suited for the given basemap and geometry type.
+   *
+   * @since 5.0
+   */
   primaryScheme: HeatmapScheme;
-  /** Additional heatmap color schemes that may be used to visualize data overlaid on the given basemap. */
+  /**
+   * Additional heatmap color schemes that may be used to visualize data overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: HeatmapScheme[];
 }
 
-/** Properties defining the symbology scheme used to visualize predominance for point features. */
+/**
+ * Properties defining the symbology scheme used to visualize predominance for point features.
+ *
+ * @since 5.0
+ */
 export interface PredominanceSchemeForPoint {
-  /** The fill colors of the point symbols used for each category. */
+  /**
+   * The fill colors of the point symbols used for each category.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the point symbol used to indicate
    *   features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the point symbol (0 - 1). */
+  /**
+   * The opacity of the point symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the marker symbol. */
+  /**
+   * Properties for defining the outline of the marker symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** The scheme defining the size visual variable if included in a predominance visualization. */
+  /**
+   * The scheme defining the size visual variable if included in a predominance visualization.
+   *
+   * @since 5.0
+   */
   sizeScheme: SizeSchemeForPoint;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** Properties defining the symbology scheme used to visualize predominance for polyline features. */
+/**
+ * Properties defining the symbology scheme used to visualize predominance for polyline features.
+ *
+ * @since 5.0
+ */
 export interface PredominanceSchemeForPolyline {
-  /** The colors of the line symbols used for each category. */
+  /**
+   * The colors of the line symbols used for each category.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the line symbol used to indicate
    *   features with no data and features that are out of range.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the line symbol (0 - 1). */
+  /**
+   * The opacity of the line symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** The scheme defining the size visual variable if included in a predominance visualization. */
+  /**
+   * The scheme defining the size visual variable if included in a predominance visualization.
+   *
+   * @since 5.0
+   */
   sizeScheme: SizeSchemeForPolyline;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
-  /** The default width of the line symbol in pixels or points. */
+  /**
+   * The default width of the line symbol in pixels or points.
+   *
+   * @since 5.0
+   */
   width: string | number;
 }
 
-/** Properties defining the symbology scheme used to visualize predominance for polygon features. */
+/**
+ * Properties defining the symbology scheme used to visualize predominance for polygon features.
+ *
+ * @since 5.0
+ */
 export interface PredominanceSchemeForPolygon {
-  /** The fill colors of the polygon symbols used for each category. */
+  /**
+   * The fill colors of the polygon symbols used for each category.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the fill symbol used to indicate
    *   features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the symbol (0 - 1). */
+  /**
+   * The opacity of the symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the fill symbol. */
+  /**
+   * Properties for defining the outline of the fill symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** The scheme defining the size visual variable if included in a predominance visualization. */
+  /**
+   * The scheme defining the size visual variable if included in a predominance visualization.
+   *
+   * @since 5.0
+   */
   sizeScheme: SizeSchemeForPolygon;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** Properties defining the symbology scheme used to visualize predominance for mesh features. */
+/**
+ * Properties defining the symbology scheme used to visualize predominance for mesh features.
+ *
+ * @since 5.0
+ */
 export interface PredominanceSchemeForMesh {
-  /** The fill colors of the mesh symbols used for each category. */
+  /**
+   * The fill colors of the mesh symbols used for each category.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the fill symbol used to indicate
    *   features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the symbol (0 - 1). */
+  /**
+   * The opacity of the symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** Defines the symbology scheme used to visualize predominance based on the layer's geometry type. */
+/**
+ * Defines the symbology scheme used to visualize predominance based on the layer's geometry type.
+ *
+ * @since 5.0
+ */
 export type PredominanceScheme = PredominanceSchemeForPoint | PredominanceSchemeForPolyline | PredominanceSchemeForPolygon | PredominanceSchemeForMesh;
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-predominance.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface PredominanceSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The predominance scheme best suited for the given basemap and geometry type. */
+  /**
+   * The predominance scheme best suited for the given basemap and geometry type.
+   *
+   * @since 5.0
+   */
   primaryScheme: PredominanceScheme;
-  /** Additional predominance schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. */
+  /**
+   * Additional predominance schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: PredominanceScheme[];
 }
 
-/** Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for point features. */
+/**
+ * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for point features.
+ *
+ * @since 5.0
+ */
 export interface RelationshipSchemeForPoint {
-  /** Defines the colors to use in each bin of the relationship visualization. */
+  /**
+   * Defines the colors to use in each bin of the relationship visualization.
+   *
+   * @since 5.0
+   */
   colorsForClassBreaks: RelationshipColorsForClassBreak[];
-  /** The ID uniquely identifying the color scheme. */
+  /**
+   * The ID uniquely identifying the color scheme.
+   *
+   * @since 5.0
+   */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the point symbol used to indicate
    *   features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the point symbol (0 - 1). */
+  /**
+   * The opacity of the point symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the marker symbol. */
+  /**
+   * Properties for defining the outline of the marker symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** The size of the point symbol in points. */
+  /**
+   * The size of the point symbol in points.
+   *
+   * @since 5.0
+   */
   size: string | number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polyline features. */
+/**
+ * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polyline features.
+ *
+ * @since 5.0
+ */
 export interface RelationshipSchemeForPolyline {
-  /** Defines the colors to use in each bin of the relationship visualization. */
+  /**
+   * Defines the colors to use in each bin of the relationship visualization.
+   *
+   * @since 5.0
+   */
   colorsForClassBreaks: RelationshipColorsForClassBreak[];
-  /** The ID uniquely identifying the color scheme. */
+  /**
+   * The ID uniquely identifying the color scheme.
+   *
+   * @since 5.0
+   */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the line symbol used to indicate
    *   features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the line symbol (0 - 1). */
+  /**
+   * The opacity of the line symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
-  /** The width of the line symbol in points. */
+  /**
+   * The width of the line symbol in points.
+   *
+   * @since 5.0
+   */
   width: string | number;
 }
 
-/** Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polygon features. */
+/**
+ * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for polygon features.
+ *
+ * @since 5.0
+ */
 export interface RelationshipSchemeForPolygon {
-  /** Defines the colors to use in each bin of the relationship visualization. */
+  /**
+   * Defines the colors to use in each bin of the relationship visualization.
+   *
+   * @since 5.0
+   */
   colorsForClassBreaks: RelationshipColorsForClassBreak[];
-  /** The ID uniquely identifying the color scheme. */
+  /**
+   * The ID uniquely identifying the color scheme.
+   *
+   * @since 5.0
+   */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the fill symbol used to indicate
    *   features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the fill symbol (0 - 1). */
+  /**
+   * The opacity of the fill symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the fill symbol. */
+  /**
+   * Properties for defining the outline of the fill symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for mesh features. */
+/**
+ * Properties defining the symbology scheme used to visualize relationship renderers (bivariate color) for mesh features.
+ *
+ * @since 5.0
+ */
 export interface RelationshipSchemeForMesh {
-  /** Defines the colors to use in each bin of the relationship visualization. */
+  /**
+   * Defines the colors to use in each bin of the relationship visualization.
+   *
+   * @since 5.0
+   */
   colorsForClassBreaks: RelationshipColorsForClassBreak[];
-  /** The ID uniquely identifying the color scheme. */
+  /**
+   * The ID uniquely identifying the color scheme.
+   *
+   * @since 5.0
+   */
   id: string;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
   /**
    * The color of the fill symbol used to indicate
    *   features with no data.
+   *
+   * @since 5.0
    */
   noDataColor: Color;
-  /** The opacity of the fill symbol (0 - 1). */
+  /**
+   * The opacity of the fill symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** Defines the symbology scheme used to visualize relationship renderers (bivariate color) based on the layer's geometry type. */
+/**
+ * Defines the symbology scheme used to visualize relationship renderers (bivariate color) based on the layer's geometry type.
+ *
+ * @since 5.0
+ */
 export type RelationshipScheme = RelationshipSchemeForPoint | RelationshipSchemeForPolyline | RelationshipSchemeForPolygon | RelationshipSchemeForMesh;
 
+/** @since 5.0 */
 export interface RelationshipColorsForClassBreak {
-  /** The fill colors of the symbols used for each bin in the relationship visualization. */
+  /**
+   * The fill colors of the symbols used for each bin in the relationship visualization.
+   *
+   * @since 5.0
+   */
   colors: Color[][];
-  /** The number of breaks (rows/columns) for each variable in the relationship visualization. */
+  /**
+   * The number of breaks (rows/columns) for each variable in the relationship visualization.
+   *
+   * @since 5.0
+   */
   numClasses: number;
 }
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-relationship.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface RelationshipSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The relationship scheme best suited for the given basemap and geometry type. */
+  /**
+   * The relationship scheme best suited for the given basemap and geometry type.
+   *
+   * @since 5.0
+   */
   primaryScheme: RelationshipScheme;
-  /** Additional relationship schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. */
+  /**
+   * Additional relationship schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: RelationshipScheme[];
 }
 
-/** Properties defining the symbology scheme used to visualize predominance for polygon features. */
+/**
+ * Properties defining the symbology scheme used to visualize predominance for polygon features.
+ *
+ * @since 5.0
+ */
 export interface DotDensityScheme {
-  /** The dot color for each attribute. */
+  /**
+   * The dot color for each attribute.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** The opacity of the symbol (0 - 1). */
+  /**
+   * The opacity of the symbol (0 - 1).
+   *
+   * @since 5.0
+   */
   opacity: number;
-  /** Properties for defining the outline of the symbol. */
+  /**
+   * Properties for defining the outline of the symbol.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-dotDensity.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface DotDensitySchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The dot density scheme best suited for the given basemap and geometry type. */
+  /**
+   * The dot density scheme best suited for the given basemap and geometry type.
+   *
+   * @since 5.0
+   */
   primaryScheme: DotDensityScheme;
-  /** Additional dot density schemes that may be used to visualize data of the given geometry type overlaid on the given basemap. */
+  /**
+   * Additional dot density schemes that may be used to visualize data of the given geometry type overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: DotDensityScheme[];
 }
 
-/** Properties defining the colors and schemes used to visualize pie charts. */
+/**
+ * Properties defining the colors and schemes used to visualize pie charts.
+ *
+ * @since 5.0
+ */
 export interface PieChartScheme {
-  /** The color of the "others" category. */
+  /**
+   * The color of the "others" category.
+   *
+   * @since 5.0
+   */
   colorForOthersCategory: Color;
-  /** The colors used to visualize pie slices in the chart. */
+  /**
+   * The colors used to visualize pie slices in the chart.
+   *
+   * @since 5.0
+   */
   colors: Color[];
-  /** The unique name of the color scheme. */
+  /**
+   * The unique name of the color scheme.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** Properties for defining the outline of the pie chart. */
+  /**
+   * Properties for defining the outline of the pie chart.
+   *
+   * @since 5.0
+   */
   outline: SchemeOutline;
-  /** The default size of the pie charts in points or pixels. */
+  /**
+   * The default size of the pie charts in points or pixels.
+   *
+   * @since 5.0
+   */
   size: string | number;
-  /** The scheme defining the size visual variable used to vary chart size per feature. */
+  /**
+   * The scheme defining the size visual variable used to vary chart size per feature.
+   *
+   * @since 5.0
+   */
   sizeScheme?: SizeScheme | null;
-  /** Tags associated with the color scheme. */
+  /**
+   * Tags associated with the color scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-pieChart.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface PieChartSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The suggest default chart scheme based on the given basemap. */
+  /**
+   * The suggest default chart scheme based on the given basemap.
+   *
+   * @since 5.0
+   */
   primaryScheme: PieChartScheme;
-  /** Additional chart schemes that may be used to visualize data overlaid on the given basemap. */
+  /**
+   * Additional chart schemes that may be used to visualize data overlaid on the given basemap.
+   *
+   * @since 5.0
+   */
   secondarySchemes: PieChartScheme[];
 }
 
-/** Suggested property values for defining the scheme used to visualize flow lines. */
+/**
+ * Suggested property values for defining the scheme used to visualize flow lines.
+ *
+ * @since 5.0
+ */
 export interface FlowScheme {
-  /** The suggested color of the flow lines if a color visual variable is not desired. */
+  /**
+   * The suggested color of the flow lines if a color visual variable is not desired.
+   *
+   * @since 5.0
+   */
   color: Color;
   /**
    * The suggested colors to use if a
    *   [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) is set on the flow renderer.
+   *
+   * @since 5.0
    */
   colors: Color[];
-  /** The suggested [FlowRenderer#density](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#density) of the streamlines. */
+  /**
+   * The suggested [FlowRenderer#density](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#density) of the streamlines.
+   *
+   * @since 5.0
+   */
   density: number;
-  /** The suggested [FlowRenderer#flowSpeed](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#flowSpeed) of the streamlines. */
+  /**
+   * The suggested [FlowRenderer#flowSpeed](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#flowSpeed) of the streamlines.
+   *
+   * @since 5.0
+   */
   flowSpeed: number;
   /**
    * The unique id of the color scheme to use in the visualization. The id is
    * assigned based on the following template: `<themeName>/<basemapName>/<schemeName>`.
+   *
+   * @since 5.0
    */
   id: string;
   /**
@@ -772,31 +1765,49 @@ export interface FlowScheme {
    * > **Known Limitations**
    * >
    * > The layer effects are not supported in 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * @since 5.0
    */
   layerEffect: string;
   /**
    * The suggested opacity to apply to large magnitude values if an
    *   [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) is set on the flow renderer.
+   *
+   * @since 5.0
    */
   maxOpacity: number;
   /**
    * The suggested size to apply to large magnitude values if a
    *   [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) is set on the flow renderer.
+   *
+   * @since 5.0
    */
   maxSize: number;
   /**
    * The suggested opacity to apply to small magnitude values if an
    *   [OpacityVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) is set on the flow renderer.
+   *
+   * @since 5.0
    */
   minOpacity: number;
   /**
    * The suggested size to apply to small magnitude values if a
    *   [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) is set on the flow renderer.
+   *
+   * @since 5.0
    */
   minSize: number;
-  /** The unique name of the scheme. */
+  /**
+   * The unique name of the scheme.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** Tags associated with the scheme. */
+  /**
+   * Tags associated with the scheme.
+   *
+   * @since 5.0
+   */
   tags: string[];
   /**
    * Determines how flow lines will render.
@@ -811,6 +1822,8 @@ export interface FlowScheme {
    * > **Known Limitations**
    * >
    * > The `wave-front` flow theme is not supported in 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * @since 5.0
    */
   theme: "flow-line" | "wave-front";
   /**
@@ -821,39 +1834,88 @@ export interface FlowScheme {
    * > **Known Limitations**
    * >
    * > The `round` trail cap is not supported in 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+   *
+   * @since 5.0
    */
   trailCap: "butt" | "round";
-  /** The suggested [length](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailLength) of the streamlines. */
+  /**
+   * The suggested [length](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailLength) of the streamlines.
+   *
+   * @since 5.0
+   */
   trailLength: number;
-  /** The suggested [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailWidth) of the streamlines. */
+  /**
+   * The suggested [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html#trailWidth) of the streamlines.
+   *
+   * @since 5.0
+   */
   trailWidth: number;
 }
 
-/** The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemes) method. */
+/**
+ * The return object of the [getSchemes()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-symbology-flow.html#getSchemes) method.
+ *
+ * @since 5.0
+ */
 export interface FlowSchemes {
-  /** The ID of the basemap associated with the given schemes. */
+  /**
+   * The ID of the basemap associated with the given schemes.
+   *
+   * @since 5.0
+   */
   basemapId?: string | null;
-  /** Indicates whether the average basemap color is `light` or `dark`. */
+  /**
+   * Indicates whether the average basemap color is `light` or `dark`.
+   *
+   * @since 5.0
+   */
   basemapTheme?: BasemapTheme | null;
-  /** The flow scheme best suited for the given basemap. */
+  /**
+   * The flow scheme best suited for the given basemap.
+   *
+   * @since 5.0
+   */
   primaryScheme: FlowScheme;
-  /** Additional flow schemes that may be used to visualize streamlines overlaid on the given basemap or basemap theme. */
+  /**
+   * Additional flow schemes that may be used to visualize streamlines overlaid on the given basemap or basemap theme.
+   *
+   * @since 5.0
+   */
   secondarySchemes: FlowScheme[];
 }
 
+/** @since 5.0 */
 export type BasemapTheme = "light" | "dark";
 
-/** Defines a ramp of colors to use for visualizing data in a chart, [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html), or [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html). */
+/**
+ * Defines a ramp of colors to use for visualizing data in a chart, [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html), or [ColorVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html).
+ *
+ * @since 5.0
+ */
 export interface ColorRamp {
-  /** An array of five colors intended for displaying a continuous color ramp. */
+  /**
+   * An array of five colors intended for displaying a continuous color ramp.
+   *
+   * @since 5.0
+   */
   colors: Color[];
   /**
    * Contains an array of ramps ranging in size from 1 color to 10 colors. All ramps are part of the same color
    *   scheme, but provide a different number of colors depending on the requirements of the ramp needed for the visualization.
+   *
+   * @since 5.0
    */
   colorsForClassBreaks: ColorsForClassBreak[];
-  /** The unique name of the color ramp. */
+  /**
+   * The unique name of the color ramp.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** Tags associated with the color ramp. */
+  /**
+   * Tags associated with the color ramp.
+   *
+   * @since 5.0
+   */
   tags: string[];
 }